#include "mlir/Conversion/SPIRVToLLVM/SPIRVToLLVM.h"
#include "mlir/Conversion/LLVMCommon/Pattern.h"
#include "mlir/Conversion/LLVMCommon/TypeConverter.h"
#include "mlir/Conversion/SPIRVCommon/AttrToLLVMConverter.h"
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Dialect/SPIRV/IR/SPIRVDialect.h"
#include "mlir/Dialect/SPIRV/IR/SPIRVEnums.h"
#include "mlir/Dialect/SPIRV/IR/SPIRVOps.h"
#include "mlir/Dialect/SPIRV/Utils/LayoutUtils.h"
#include "mlir/IR/BuiltinOps.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/Transforms/DialectConversion.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/FormatVariadic.h"

Macros
#define	DEBUG_TYPE "spirv-to-llvm-pattern"

#define	DISPATCH(functionControl, llvmAttr)

Functions
static bool	isSignedIntegerOrVector (Type type)
	Returns true if the given type is a signed integer or vector type. More...

static bool	isUnsignedIntegerOrVector (Type type)
	Returns true if the given type is an unsigned integer or vector type. More...

static std::optional< uint64_t >	getIntegerOrVectorElementWidth (Type type)
	Returns the width of an integer or of the element type of an integer vector, if applicable. More...

static unsigned	getBitWidth (Type type)
	Returns the bit width of integer, float or vector of float or integer values. More...

static unsigned	getLLVMTypeBitWidth (Type type)
	Returns the bit width of LLVMType integer or vector. More...

static IntegerAttr	minusOneIntegerAttribute (Type type, Builder builder)
	Creates `IntegerAttribute` with all bits set for given type. More...

static Value	createConstantAllBitsSet (Location loc, Type srcType, Type dstType, PatternRewriter &rewriter)
	Creates `llvm.mlir.constant` with all bits set for the given type. More...

static Value	createFPConstant (Location loc, Type srcType, Type dstType, PatternRewriter &rewriter, double value)
	Creates `llvm.mlir.constant` with a floating-point scalar or vector value. More...

static Value	optionallyTruncateOrExtend (Location loc, Value value, Type llvmType, PatternRewriter &rewriter)
	Utility function for bitfield ops: More...

static Value	broadcast (Location loc, Value toBroadcast, unsigned numElements, const TypeConverter &typeConverter, ConversionPatternRewriter &rewriter)
	Broadcasts the value to vector with `numElements` number of elements. More...

static Value	optionallyBroadcast (Location loc, Value value, Type srcType, const TypeConverter &typeConverter, ConversionPatternRewriter &rewriter)
	Broadcasts the value. If `srcType` is a scalar, the value remains unchanged. More...

static Value	processCountOrOffset (Location loc, Value value, Type srcType, Type dstType, const TypeConverter &converter, ConversionPatternRewriter &rewriter)
	Utility function for bitfield ops: `BitFieldInsert`, `BitFieldSExtract` and `BitFieldUExtract`. More...

static Type	convertStructTypeWithOffset (spirv::StructType type, const TypeConverter &converter)
	Converts SPIR-V struct with a regular (according to `VulkanLayoutUtils`) offset to LLVM struct. More...

static Type	convertStructTypePacked (spirv::StructType type, const TypeConverter &converter)
	Converts SPIR-V struct with no offset to packed LLVM struct. More...

static Value	createI32ConstantOf (Location loc, PatternRewriter &rewriter, unsigned value)
	Creates LLVM dialect constant with the given value. More...

static LogicalResult	replaceWithLoadOrStore (Operation *op, ValueRange operands, ConversionPatternRewriter &rewriter, const TypeConverter &typeConverter, unsigned alignment, bool isVolatile, bool isNonTemporal)
	Utility for `spirv.Load` and `spirv.Store` conversion. More...

static std::optional< Type >	convertArrayType (spirv::ArrayType type, TypeConverter &converter)
	Converts SPIR-V array type to LLVM array. More...

static Type	convertPointerType (spirv::PointerType type, const TypeConverter &converter, spirv::ClientAPI clientAPI)
	Converts SPIR-V pointer type to LLVM pointer. More...

static std::optional< Type >	convertRuntimeArrayType (spirv::RuntimeArrayType type, TypeConverter &converter)
	Converts SPIR-V runtime array to LLVM array. More...

static Type	convertStructType (spirv::StructType type, const TypeConverter &converter)
	Converts SPIR-V struct to LLVM struct. More...

Variables
static constexpr StringRef	kBinding = "binding"
	Hook for descriptor set and binding number encoding. More...

static constexpr StringRef	kDescriptorSet = "descriptor_set"

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE "spirv-to-llvm-pattern"

Definition at line 29 of file SPIRVToLLVM.cpp.

◆ DISPATCH

#define DISPATCH	(	functionControl,
		llvmAttr
	)

Value:

  case functionControl:                                                        \
    newFuncOp->setAttr("passthrough", ArrayAttr::get(context, {llvmAttr}));    \
    break;

Function Documentation

◆ broadcast()

static Value broadcast	(	Location	loc,
		Value	toBroadcast,
		unsigned	numElements,
		const TypeConverter &	typeConverter,
		ConversionPatternRewriter &	rewriter
	)

static

Broadcasts the value to vector with numElements number of elements.

Definition at line 151 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertType(), mlir::OpBuilder::create(), mlir::get(), mlir::Builder::getI32IntegerAttr(), mlir::Builder::getIntegerType(), and mlir::Value::getType().

Referenced by mlir::linalg::hoistRedundantVectorBroadcasts(), optionallyBroadcast(), and supportsMMaMatrixType().

◆ convertArrayType()

static std::optional<Type> convertArrayType	(	spirv::ArrayType	type,
		TypeConverter &	converter
	)

static

Converts SPIR-V array type to LLVM array.

Natural stride (according to VulkanLayoutUtils) is also mapped to LLVM array. This has to be respected when converting ops that manipulate array types.

Definition at line 258 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertType(), mlir::get(), mlir::spirv::ArrayType::getArrayStride(), mlir::spirv::ArrayType::getElementType(), and mlir::spirv::ArrayType::getNumElements().

Referenced by mlir::populateSPIRVToLLVMTypeConversion().

◆ convertPointerType()

static Type convertPointerType	(	spirv::PointerType	type,
		const TypeConverter &	converter,
		spirv::ClientAPI	clientAPI
	)

static

Converts SPIR-V pointer type to LLVM pointer.

Pointer's storage class is not modelled at the moment.

Definition at line 273 of file SPIRVToLLVM.cpp.

References mlir::get(), mlir::spirv::PointerType::getStorageClass(), and mlir::storageClassToAddressSpace().

Referenced by mlir::populateSPIRVToLLVMTypeConversion().

◆ convertRuntimeArrayType()

static std::optional<Type> convertRuntimeArrayType	(	spirv::RuntimeArrayType	type,
		TypeConverter &	converter
	)

static

Converts SPIR-V runtime array to LLVM array.

Since LLVM allows indexing over the bounds, the runtime array is converted to a 0-sized LLVM array. There is no modelling of array stride at the moment.

Definition at line 284 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertType(), mlir::get(), mlir::spirv::RuntimeArrayType::getArrayStride(), and mlir::spirv::RuntimeArrayType::getElementType().

Referenced by mlir::populateSPIRVToLLVMTypeConversion().

◆ convertStructType()

static Type convertStructType	(	spirv::StructType	type,
		const TypeConverter &	converter
	)

static

Converts SPIR-V struct to LLVM struct.

There is no support of structs with member decorations. Also, only natural offset is supported.

Definition at line 294 of file SPIRVToLLVM.cpp.

References convertStructTypePacked(), convertStructTypeWithOffset(), mlir::spirv::StructType::getMemberDecorations(), and mlir::spirv::StructType::hasOffset().

Referenced by mlir::populateSPIRVToLLVMTypeConversion().

◆ convertStructTypePacked()

static Type convertStructTypePacked	(	spirv::StructType	type,
		const TypeConverter &	converter
	)

static

Converts SPIR-V struct with no offset to packed LLVM struct.

Definition at line 211 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertTypes(), and mlir::spirv::StructType::getElementTypes().

Referenced by convertStructType().

◆ convertStructTypeWithOffset()

static Type convertStructTypeWithOffset	(	spirv::StructType	type,
		const TypeConverter &	converter
	)

static

Converts SPIR-V struct with a regular (according to VulkanLayoutUtils) offset to LLVM struct.

Otherwise, the conversion is not supported.

Definition at line 198 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertTypes(), mlir::VulkanLayoutUtils::decorateType(), and mlir::spirv::StructType::getElementTypes().

Referenced by convertStructType().

◆ createConstantAllBitsSet()

static Value createConstantAllBitsSet	(	Location	loc,
		Type	srcType,
		Type	dstType,
		PatternRewriter &	rewriter
	)

static

Creates llvm.mlir.constant with all bits set for the given type.

Definition at line 97 of file SPIRVToLLVM.cpp.

References mlir::OpBuilder::create(), mlir::DenseElementsAttr::get(), and minusOneIntegerAttribute().

◆ createFPConstant()

static Value createFPConstant	(	Location	loc,
		Type	srcType,
		Type	dstType,
		PatternRewriter &	rewriter,
		double	value
	)

static

Creates llvm.mlir.constant with a floating-point scalar or vector value.

Definition at line 110 of file SPIRVToLLVM.cpp.

References mlir::OpBuilder::create(), mlir::DenseElementsAttr::get(), and mlir::Builder::getFloatAttr().

◆ createI32ConstantOf()

static Value createI32ConstantOf	(	Location	loc,
		PatternRewriter &	rewriter,
		unsigned	value
	)

static

Creates LLVM dialect constant with the given value.

Definition at line 221 of file SPIRVToLLVM.cpp.

References mlir::OpBuilder::create(), mlir::get(), mlir::Builder::getContext(), mlir::Builder::getI32Type(), and mlir::Builder::getIntegerAttr().

◆ getBitWidth()

static unsigned getBitWidth ( Type type )

static

Returns the bit width of integer, float or vector of float or integer values.

Definition at line 67 of file SPIRVToLLVM.cpp.

References mlir::Type::getIntOrFloatBitWidth(), and mlir::Type::isIntOrFloat().

Referenced by optionallyTruncateOrExtend().

◆ getIntegerOrVectorElementWidth()

static std::optional<uint64_t> getIntegerOrVectorElementWidth ( Type type )

static

Returns the width of an integer or of the element type of an integer vector, if applicable.

Definition at line 57 of file SPIRVToLLVM.cpp.

◆ getLLVMTypeBitWidth()

static unsigned getLLVMTypeBitWidth ( Type type )

static

Returns the bit width of LLVMType integer or vector.

Definition at line 80 of file SPIRVToLLVM.cpp.

Referenced by optionallyTruncateOrExtend().

◆ isSignedIntegerOrVector()

static bool isSignedIntegerOrVector ( Type type )

static

Returns true if the given type is a signed integer or vector type.

Definition at line 38 of file SPIRVToLLVM.cpp.

References mlir::Type::isSignedInteger().

◆ isUnsignedIntegerOrVector()

static bool isUnsignedIntegerOrVector ( Type type )

static

Returns true if the given type is an unsigned integer or vector type.

Definition at line 47 of file SPIRVToLLVM.cpp.

References mlir::Type::isUnsignedInteger().

◆ minusOneIntegerAttribute()

static IntegerAttr minusOneIntegerAttribute	(	Type	type,
		Builder	builder
	)

static

Creates IntegerAttribute with all bits set for given type.

Definition at line 87 of file SPIRVToLLVM.cpp.

References mlir::Builder::getIntegerAttr().

Referenced by createConstantAllBitsSet().

◆ optionallyBroadcast()

static Value optionallyBroadcast	(	Location	loc,
		Value	value,
		Type	srcType,
		const TypeConverter &	typeConverter,
		ConversionPatternRewriter &	rewriter
	)

static

Broadcasts the value. If srcType is a scalar, the value remains unchanged.

Definition at line 168 of file SPIRVToLLVM.cpp.

References broadcast().

Referenced by processCountOrOffset().

◆ optionallyTruncateOrExtend()

static Value optionallyTruncateOrExtend	(	Location	loc,
		Value	value,
		Type	llvmType,
		PatternRewriter &	rewriter
	)

static

Utility function for bitfield ops:

BitFieldInsert
BitFieldSExtract
BitFieldUExtract Truncates or extends the value. If the bitwidth of the value is the same as llvmType bitwidth, the value remains unchanged.

Definition at line 130 of file SPIRVToLLVM.cpp.

References mlir::OpBuilder::create(), getBitWidth(), getLLVMTypeBitWidth(), mlir::Value::getType(), and mlir::LLVM::isCompatibleType().

Referenced by processCountOrOffset().

◆ processCountOrOffset()

static Value processCountOrOffset	(	Location	loc,
		Value	value,
		Type	srcType,
		Type	dstType,
		const TypeConverter &	converter,
		ConversionPatternRewriter &	rewriter
	)

static

Utility function for bitfield ops: BitFieldInsert, BitFieldSExtract and BitFieldUExtract.

Broadcast Offset and Count to match the type of Base. If Base is of a vector type, construct a vector that has:

same number of elements as Base
each element has the type that is the same as the type of Offset or Count
each element has the same value as Offset or Count Then cast Offset and Count if their bit width is different from Base bit width.

Definition at line 188 of file SPIRVToLLVM.cpp.

References optionallyBroadcast(), and optionallyTruncateOrExtend().

◆ replaceWithLoadOrStore()

static LogicalResult replaceWithLoadOrStore	(	Operation *	op,
		ValueRange	operands,
		ConversionPatternRewriter &	rewriter,
		const TypeConverter &	typeConverter,
		unsigned	alignment,
		bool	isVolatile,
		bool	isNonTemporal
	)

static

Utility for spirv.Load and spirv.Store conversion.

Definition at line 229 of file SPIRVToLLVM.cpp.

References mlir::TypeConverter::convertType(), mlir::RewriterBase::notifyMatchFailure(), and mlir::RewriterBase::replaceOpWithNewOp().

Variable Documentation

◆ kBinding

constexpr StringRef kBinding = "binding"

staticconstexpr

Hook for descriptor set and binding number encoding.

Definition at line 1989 of file SPIRVToLLVM.cpp.

Referenced by mlir::encodeBindAttribute().

◆ kDescriptorSet

constexpr StringRef kDescriptorSet = "descriptor_set"

staticconstexpr

Definition at line 1990 of file SPIRVToLLVM.cpp.

Referenced by mlir::encodeBindAttribute().

Macros

Functions

Variables

Macro Definition Documentation

◆ DEBUG_TYPE

◆ DISPATCH

Function Documentation

◆ broadcast()

◆ convertArrayType()

◆ convertPointerType()

◆ convertRuntimeArrayType()

◆ convertStructType()

◆ convertStructTypePacked()

◆ convertStructTypeWithOffset()

◆ createConstantAllBitsSet()

◆ createFPConstant()

◆ createI32ConstantOf()

◆ getBitWidth()

◆ getIntegerOrVectorElementWidth()

◆ getLLVMTypeBitWidth()

◆ isSignedIntegerOrVector()

◆ isUnsignedIntegerOrVector()

◆ minusOneIntegerAttribute()

◆ optionallyBroadcast()

◆ optionallyTruncateOrExtend()

◆ processCountOrOffset()

◆ replaceWithLoadOrStore()

Variable Documentation

◆ kBinding

◆ kDescriptorSet