Namespaces
	detail

Classes
class	ArrayType

struct	BlockMergeInfo
	A struct for containing a header block's merge and continue targets. More...

class	CompositeType

class	CooperativeMatrixNVType

struct	DebugLine
	A struct for containing OpLine instruction information. More...

struct	DeferredStructTypeInfo
	A "deferred struct type" is a struct type with one or more member types not known when the Deserializer first encounters the struct. More...

class	Deserializer
	A SPIR-V module serializer. More...

class	ElementwiseOpPattern
	Converts elementwise unary, binary and ternary standard operations to SPIR-V operations. More...

class	ImageType

class	InterfaceVarABIAttr
	An attribute that specifies the information regarding the interface variable: descriptor set, binding, storage class. More...

class	JointMatrixINTELType

class	MatrixType

class	MemorySpaceToStorageClassConverter
	Type converter for converting numeric MemRef memory spaces into SPIR-V symbolic ones. More...

class	PointerType

class	RuntimeArrayType

class	SampledImageType

class	ScalarType

struct	SerializationOptions

class	Serializer
	A SPIR-V module serializer. More...

struct	SpecConstOperationMaterializationInfo
	A struct that collects the info needed to materialize/emit a SpecConstantOperation op. More...

class	SPIRVType

class	StructType
	SPIR-V struct type. More...

class	TargetEnv
	A wrapper class around a spirv::TargetEnvAttr to provide query methods for allowed version/capabilities/extensions. More...

class	TargetEnvAttr
	An attribute that specifies the target version, allowed extensions and capabilities, and resource limits. More...

class	VerCapExtAttr
	An attribute that specifies the SPIR-V (version, capabilities, extensions) triple. More...

Typedefs
using	MemorySpaceToStorageClassMap = std::function< Optional< spirv::StorageClass >(unsigned)>
	Mapping from numeric MemRef memory spaces into SPIR-V symbolic ones. More...

using	SymbolRenameListener = function_ref< void(spirv::ModuleOp originalModule, StringRef oldSymbol, StringRef newSymbol)>
	The listener function to receive symbol renaming events. More...

using	BlockMergeInfoMap = DenseMap< Block *, BlockMergeInfo >
	Map from a selection/loop's header block to its merge (and continue) target. More...

Functions
Optional< spirv::StorageClass >	mapMemorySpaceToVulkanStorageClass (unsigned)
	Maps MemRef memory spaces to storage classes for Vulkan-flavored SPIR-V using the default rule. More...

Optional< unsigned >	mapVulkanStorageClassToMemorySpace (spirv::StorageClass)
	Maps storage classes for Vulkan-flavored SPIR-V to MemRef memory spaces using the default rule. More...

Optional< spirv::StorageClass >	mapMemorySpaceToOpenCLStorageClass (unsigned)
	Maps MemRef memory spaces to storage classes for OpenCL-flavored SPIR-V using the default rule. More...

Optional< unsigned >	mapOpenCLStorageClassToMemorySpace (spirv::StorageClass)
	Maps storage classes for OpenCL-flavored SPIR-V to MemRef memory spaces using the default rule. More...

std::unique_ptr< ConversionTarget >	getMemorySpaceToStorageClassTarget (MLIRContext &)
	Creates the target that populates legality of ops with MemRef types. More...

void	populateMemorySpaceToStorageClassPatterns (MemorySpaceToStorageClassConverter &typeConverter, RewritePatternSet &patterns)
	Appends to a pattern list additional patterns for converting numeric MemRef memory spaces into SPIR-V symbolic ones. More...

ArrayRef< Extension >	getImpliedExtensions (Version version)
	Returns the implied extensions for the given version. More...

ArrayRef< Capability >	getDirectImpliedCapabilities (Capability cap)
	Returns the directly implied capabilities for the given capability. More...

SmallVector< Capability, 0 >	getRecursiveImpliedCapabilities (Capability cap)
	Returns the recursively implied capabilities for the given capability. More...

void	populateSPIRVGLCanonicalizationPatterns (RewritePatternSet &results)
	Populates patterns to run canoncalization that involves GL ops. More...

llvm::hash_code	hash_value (const StructType::MemberDecorationInfo &memberDecorationInfo)

StringRef	getInterfaceVarABIAttrName ()
	Returns the attribute name for specifying argument ABI information. More...

InterfaceVarABIAttr	getInterfaceVarABIAttr (unsigned descriptorSet, unsigned binding, Optional< StorageClass > storageClass, MLIRContext *context)
	Gets the InterfaceVarABIAttr given its fields. More...

bool	needsInterfaceVarABIAttrs (TargetEnvAttr targetAttr)
	Returns whether the given SPIR-V target (described by TargetEnvAttr) needs ABI attributes for interface variables (spirv.interface_var_abi). More...

StringRef	getEntryPointABIAttrName ()
	Returns the attribute name for specifying entry point information. More...

EntryPointABIAttr	getEntryPointABIAttr (ArrayRef< int32_t > localSize, MLIRContext *context)
	Gets the EntryPointABIAttr given its fields. More...

EntryPointABIAttr	lookupEntryPointABI (Operation *op)
	Queries the entry point ABI on the nearest function-like op containing the given `op`. More...

DenseIntElementsAttr	lookupLocalWorkGroupSize (Operation *op)
	Queries the local workgroup size from entry point ABI on the nearest function-like op containing the given `op`. More...

ResourceLimitsAttr	getDefaultResourceLimits (MLIRContext *context)
	Returns a default resource limits attribute that uses numbers from "Table 46. Required Limits" of the Vulkan spec. More...

StringRef	getTargetEnvAttrName ()
	Returns the attribute name for specifying SPIR-V target environment. More...

TargetEnvAttr	getDefaultTargetEnv (MLIRContext *context)
	Returns the default target environment: SPIR-V 1.0 with Shader capability and no extra extensions. More...

TargetEnvAttr	lookupTargetEnv (Operation *op)
	Queries the target environment recursively from enclosing symbol table ops containing the given `op`. More...

TargetEnvAttr	lookupTargetEnvOrDefault (Operation *op)
	Queries the target environment recursively from enclosing symbol table ops containing the given `op` or returns the default target environment as returned by getDefaultTargetEnv() if not provided. More...

AddressingModel	getAddressingModel (TargetEnvAttr targetAttr)
	Returns addressing model selected based on target environment. More...

FailureOr< ExecutionModel >	getExecutionModel (TargetEnvAttr targetAttr)
	Returns execution model selected based on target environment. More...

FailureOr< MemoryModel >	getMemoryModel (TargetEnvAttr targetAttr)
	Returns memory model selected based on target environment. More...

OwningOpRef< spirv::ModuleOp >	combine (ArrayRef< spirv::ModuleOp > inputModules, OpBuilder &combinedModuleBuilder, SymbolRenameListener symRenameListener)
	Combines a list of SPIR-V `inputModules` into one. More...

std::unique_ptr< OperationPass<> >	createCanonicalizeGLPass ()
	Creates a pass to run canoncalization patterns that involve GL ops. More...

std::unique_ptr< OperationPass< mlir::ModuleOp > >	createDecorateSPIRVCompositeTypeLayoutPass ()
	Creates a module pass that converts composite types used by objects in the StorageBuffer, PhysicalStorageBuffer, Uniform, and PushConstant storage classes with layout information. More...

std::unique_ptr< OperationPass< spirv::ModuleOp > >	createUpdateVersionCapabilityExtensionPass ()
	Creates an operation pass that deduces and attaches the minimal version/ capabilities/extensions requirements for spirv.module ops. More...

std::unique_ptr< OperationPass< spirv::ModuleOp > >	createLowerABIAttributesPass ()
	Creates an operation pass that lowers the ABI attributes specified during SPIR-V Lowering. More...

std::unique_ptr< OperationPass< spirv::ModuleOp > >	createRewriteInsertsPass ()
	Creates an operation pass that rewrites sequential chains of spirv.CompositeInsert into spirv.CompositeConstruct. More...

std::unique_ptr< OperationPass< spirv::ModuleOp > >	createUnifyAliasedResourcePass ()
	Creates an operation pass that unifies access of multiple aliased resources into access of one single resource. More...

Value	getBuiltinVariableValue (Operation *op, BuiltIn builtin, Type integerType, OpBuilder &builder)
	Returns the value for the given `builtin` variable. More...

Value	getPushConstantValue (Operation *op, unsigned elementCount, unsigned offset, Type integerType, OpBuilder &builder)
	Gets the value at the given `offset` of the push constant storage with a total of `elementCount` `integerType` integers. More...

Value	linearizeIndex (ValueRange indices, ArrayRef< int64_t > strides, int64_t offset, Type integerType, Location loc, OpBuilder &builder)
	Generates IR to perform index linearization with the given `indices` and their corresponding `strides`, adding an initial `offset`. More...

Value	getElementPtr (SPIRVTypeConverter &typeConverter, MemRefType baseType, Value basePtr, ValueRange indices, Location loc, OpBuilder &builder)
	Performs the index computation to get to the element at `indices` of the memory pointed to by `basePtr`, using the layout map of `baseType`. More...

Value	getOpenCLElementPtr (SPIRVTypeConverter &typeConverter, MemRefType baseType, Value basePtr, ValueRange indices, Location loc, OpBuilder &builder)

Value	getVulkanElementPtr (SPIRVTypeConverter &typeConverter, MemRefType baseType, Value basePtr, ValueRange indices, Location loc, OpBuilder &builder)

OwningOpRef< spirv::ModuleOp >	deserialize (ArrayRef< uint32_t > binary, MLIRContext *context)
	Deserializes the given SPIR-V `binary` module and creates a MLIR ModuleOp in the given `context`. More...

LogicalResult	serialize (ModuleOp module, SmallVectorImpl< uint32_t > &binary, const SerializationOptions &options={})
	Serializes the given SPIR-V `module` and writes to `binary`. More...

void	appendModuleHeader (SmallVectorImpl< uint32_t > &header, spirv::Version version, uint32_t idBound)
	Appends a SPRI-V module header to `header` with the given `version` and `idBound`. More...

uint32_t	getPrefixedOpcode (uint32_t wordCount, spirv::Opcode opcode)
	Returns the word-count-prefixed opcode for an SPIR-V instruction. More...

void	encodeStringLiteralInto (SmallVectorImpl< uint32_t > &binary, StringRef literal)
	Encodes an SPIR-V `literal` string into the given `binary` vector. More...

StringRef	decodeStringLiteral (ArrayRef< uint32_t > words, unsigned &wordIndex)
	Decodes a string literal in `words` starting at `wordIndex`. More...

template<>
LogicalResult	Deserializer::processOp< spirv::EntryPointOp > (ArrayRef< uint32_t > words)

template<>
LogicalResult	Deserializer::processOp< spirv::ExecutionModeOp > (ArrayRef< uint32_t > words)

template<>
LogicalResult	Deserializer::processOp< spirv::FunctionCallOp > (ArrayRef< uint32_t > operands)

template<>
LogicalResult	Deserializer::processOp< spirv::CopyMemoryOp > (ArrayRef< uint32_t > words)

template<>
LogicalResult	Deserializer::processOp< spirv::GenericCastToPtrExplicitOp > (ArrayRef< uint32_t > words)

template<>
LogicalResult	Serializer::processOp< spirv::EntryPointOp > (spirv::EntryPointOp op)

template<>
LogicalResult	Serializer::processOp< spirv::ExecutionModeOp > (spirv::ExecutionModeOp op)

template<>
LogicalResult	Serializer::processOp< spirv::FunctionCallOp > (spirv::FunctionCallOp op)

template<>
LogicalResult	Serializer::processOp< spirv::CopyMemoryOp > (spirv::CopyMemoryOp op)

template<>
LogicalResult	Serializer::processOp< spirv::GenericCastToPtrExplicitOp > (spirv::GenericCastToPtrExplicitOp op)

void	encodeInstructionInto (SmallVectorImpl< uint32_t > &binary, spirv::Opcode op, ArrayRef< uint32_t > operands)
	Encodes an SPIR-V instruction with the given `opcode` and `operands` into the given `binary` vector. More...

template<>
LogicalResult	Serializer::processTypeDecoration< spirv::ArrayType > (Location loc, spirv::ArrayType type, uint32_t resultID)

template<>
LogicalResult	Serializer::processTypeDecoration< spirv::RuntimeArrayType > (Location loc, spirv::RuntimeArrayType type, uint32_t resultID)

Variables
constexpr unsigned	kHeaderWordCount = 5
	SPIR-V binary header word count. More...

constexpr uint32_t	kMagicNumber = 0x07230203
	SPIR-V magic number. More...

constexpr uint32_t	kGeneratorNumber = 22
	The serializer tool ID registered to the Khronos Group. More...

Typedef Documentation

◆ BlockMergeInfoMap

using mlir::spirv::BlockMergeInfoMap = typedef DenseMap<Block *, BlockMergeInfo>

Map from a selection/loop's header block to its merge (and continue) target.

Definition at line 59 of file Deserializer.h.

◆ MemorySpaceToStorageClassMap

using mlir::spirv::MemorySpaceToStorageClassMap = typedef std::function<Optional<spirv::StorageClass>(unsigned)>

Mapping from numeric MemRef memory spaces into SPIR-V symbolic ones.

Definition at line 26 of file MemRefToSPIRV.h.

◆ SymbolRenameListener

using mlir::spirv::SymbolRenameListener = typedef function_ref<void( spirv::ModuleOp originalModule, StringRef oldSymbol, StringRef newSymbol)>

The listener function to receive symbol renaming events.

originalModule is the input spirv::ModuleOp that contains the renamed symbol. oldSymbol and newSymbol are the original and renamed symbol. Note that it's the responsibility of the caller to properly retain the storage underlying the passed StringRefs if the listener callback outlives this function call.

Definition at line 33 of file ModuleCombiner.h.

Function Documentation

◆ appendModuleHeader()

void mlir::spirv::appendModuleHeader	(	SmallVectorImpl< uint32_t > &	header,
		spirv::Version	version,
		uint32_t	idBound
	)

Appends a SPRI-V module header to header with the given version and idBound.

Definition at line 18 of file SPIRVBinaryUtils.cpp.

References kGeneratorNumber, kMagicNumber, and MIN_VERSION_CASE.

Referenced by mlir::spirv::Serializer::collect().

◆ combine()

OwningOpRef< spirv::ModuleOp > mlir::spirv::combine	(	ArrayRef< spirv::ModuleOp >	inputModules,
		OpBuilder &	combinedModuleBuilder,
		SymbolRenameListener	symRenameListener
	)

Combines a list of SPIR-V inputModules into one.

Returns the combined module on success; returns a null module otherwise.

Parameters

inputModules	the list of modules to combine. They won't be modified.
combinedMdouleBuilder	an OpBuilder for building the combined module.
symbRenameListener	a listener that gets called everytime a symbol in one of the input modules is renamed.

To combine multiple SPIR-V modules, we move all the module-level ops from all the input modules into one big combined module. To that end, the combination process proceeds in 2 phases:

resolve conflicts between pairs of ops from different modules,
deduplicate equivalent ops/sub-ops in the merged module.

For the conflict resolution phase, the following rules are employed to resolve such conflicts:

If 2 spirv.func's have the same symbol name, then rename one of the functions.
If an spirv.func and another op have the same symbol name, then rename the other symbol.
If none of the 2 conflicting ops are spirv.func, then rename either.

For deduplication, the following 3 cases are taken into consideration:

If 2 spirv.GlobalVariable's have either the same descriptor set + binding or the same build_in attribute value, then replace one of them using the other.
If 2 spirv.SpecConstant's have the same spec_id attribute value, then replace one of them using the other.
Deduplicating functions are not supported right now.

In all cases, the references to the updated symbol (whether renamed or deduplicated) are also updated to reflect the change.

Definition at line 90 of file ModuleCombiner.cpp.

References computeHash(), mlir::OpBuilder::create(), mlir::failed(), mlir::OpBuilder::insert(), mlir::SymbolTable::replaceAllSymbolUses(), mlir::OpBuilder::setInsertionPointToStart(), and updateSymbolAndAllUses().

Referenced by combineOneSpec().

◆ createCanonicalizeGLPass()

std::unique_ptr< OperationPass<> > mlir::spirv::createCanonicalizeGLPass ( )

Creates a pass to run canoncalization patterns that involve GL ops.

These patterns cannot be run in default canonicalization because GL ops aren't always available. So they should be involed specifically when needed.

Definition at line 39 of file CanonicalizeGLPass.cpp.

◆ createDecorateSPIRVCompositeTypeLayoutPass()

std::unique_ptr< OperationPass< ModuleOp > > mlir::spirv::createDecorateSPIRVCompositeTypeLayoutPass ( )

Creates a module pass that converts composite types used by objects in the StorageBuffer, PhysicalStorageBuffer, Uniform, and PushConstant storage classes with layout information.

Right now this pass only supports Vulkan layout rules.

Definition at line 151 of file DecorateCompositeTypeLayoutPass.cpp.

◆ createLowerABIAttributesPass()

std::unique_ptr< OperationPass< spirv::ModuleOp > > mlir::spirv::createLowerABIAttributesPass ( )

Creates an operation pass that lowers the ABI attributes specified during SPIR-V Lowering.

Specifically,

Creates the global variables for arguments of entry point function using the specification in the spirv.interface_var_abi attribute for each argument.
Inserts the EntryPointOp and the ExecutionModeOp for entry point functions using the specification in the spirv.entry_point_abi attribute.

Definition at line 300 of file LowerABIAttributesPass.cpp.

◆ createRewriteInsertsPass()

std::unique_ptr< mlir::OperationPass< spirv::ModuleOp > > mlir::spirv::createRewriteInsertsPass ( )

Creates an operation pass that rewrites sequential chains of spirv.CompositeInsert into spirv.CompositeConstruct.

Definition at line 122 of file RewriteInsertsPass.cpp.

◆ createUnifyAliasedResourcePass()

std::unique_ptr< mlir::OperationPass< spirv::ModuleOp > > mlir::spirv::createUnifyAliasedResourcePass ( )

Creates an operation pass that unifies access of multiple aliased resources into access of one single resource.

Definition at line 573 of file UnifyAliasedResourcePass.cpp.

◆ createUpdateVersionCapabilityExtensionPass()

std::unique_ptr< OperationPass< spirv::ModuleOp > > mlir::spirv::createUpdateVersionCapabilityExtensionPass ( )

Creates an operation pass that deduces and attaches the minimal version/ capabilities/extensions requirements for spirv.module ops.

For each spirv.module op, this pass requires a spirv.target_env attribute on it or an enclosing module-like op to drive the deduction. The reason is that an op can be enabled by multiple extensions/capabilities. So we need to know which one to pick. spirv.target_env gives the hard limit as for what the target environment can support; this pass deduces what are actually needed for a specific spirv.module op.

Definition at line 189 of file UpdateVCEPass.cpp.

◆ decodeStringLiteral()

StringRef mlir::spirv::decodeStringLiteral	(	ArrayRef< uint32_t >	words,
		unsigned &	wordIndex
	)

inline

Decodes a string literal in words starting at wordIndex.

Update the latter to point to the position in words after the string literal.

Definition at line 47 of file SPIRVBinaryUtils.h.

Referenced by mlir::spirv::Deserializer::collect(), and Deserializer::processOp< spirv::EntryPointOp >().

◆ deserialize()

OwningOpRef< spirv::ModuleOp > mlir::spirv::deserialize	(	ArrayRef< uint32_t >	binary,
		MLIRContext *	context
	)

Deserializes the given SPIR-V binary module and creates a MLIR ModuleOp in the given context.

Returns the ModuleOp on success; otherwise, reports errors to the error handler registered with context and returns a null module.

Definition at line 15 of file Deserialization.cpp.

References mlir::spirv::Deserializer::collect(), mlir::spirv::Deserializer::deserialize(), and mlir::failed().

Referenced by deserializeModule(), and roundTripModule().

◆ Deserializer::processOp< spirv::CopyMemoryOp >()

template<>

LogicalResult mlir::spirv::Deserializer::processOp< spirv::CopyMemoryOp > ( ArrayRef< uint32_t > words )

Definition at line 456 of file DeserializeOps.cpp.

References mlir::emitError(), and mlir::success().

◆ Deserializer::processOp< spirv::EntryPointOp >()

template<>

LogicalResult mlir::spirv::Deserializer::processOp< spirv::EntryPointOp > ( ArrayRef< uint32_t > words )

Definition at line 332 of file DeserializeOps.cpp.

References decodeStringLiteral(), mlir::emitError(), and mlir::success().

◆ Deserializer::processOp< spirv::ExecutionModeOp >()

template<>

LogicalResult mlir::spirv::Deserializer::processOp< spirv::ExecutionModeOp > ( ArrayRef< uint32_t > words )

Definition at line 381 of file DeserializeOps.cpp.

References mlir::emitError(), and mlir::success().

◆ Deserializer::processOp< spirv::FunctionCallOp >()

template<>

LogicalResult mlir::spirv::Deserializer::processOp< spirv::FunctionCallOp > ( ArrayRef< uint32_t > operands )

Definition at line 414 of file DeserializeOps.cpp.

References mlir::emitError(), mlir::success(), and value.

◆ Deserializer::processOp< spirv::GenericCastToPtrExplicitOp >()

template<>

LogicalResult mlir::spirv::Deserializer::processOp< spirv::GenericCastToPtrExplicitOp > ( ArrayRef< uint32_t > words )

Definition at line 527 of file DeserializeOps.cpp.

References mlir::Operation::create(), mlir::emitError(), mlir::Operation::getResult(), and mlir::success().

◆ encodeInstructionInto()

void mlir::spirv::encodeInstructionInto	(	SmallVectorImpl< uint32_t > &	binary,
		spirv::Opcode	op,
		ArrayRef< uint32_t >	operands
	)

Encodes an SPIR-V instruction with the given opcode and operands into the given binary vector.

Definition at line 77 of file Serializer.cpp.

References getPrefixedOpcode().

Referenced by mlir::spirv::Serializer::printValueIDMap(), Serializer::processOp< spirv::CopyMemoryOp >(), Serializer::processOp< spirv::EntryPointOp >(), Serializer::processOp< spirv::ExecutionModeOp >(), Serializer::processOp< spirv::FunctionCallOp >(), Serializer::processOp< spirv::GenericCastToPtrExplicitOp >(), Serializer::processTypeDecoration< spirv::RuntimeArrayType >(), and visitInPrettyBlockOrder().

◆ encodeStringLiteralInto()

void mlir::spirv::encodeStringLiteralInto	(	SmallVectorImpl< uint32_t > &	binary,
		StringRef	literal
	)

Encodes an SPIR-V literal string into the given binary vector.

Definition at line 66 of file SPIRVBinaryUtils.cpp.

Referenced by mlir::spirv::Serializer::printValueIDMap(), and Serializer::processOp< spirv::EntryPointOp >().

◆ getAddressingModel()

spirv::AddressingModel mlir::spirv::getAddressingModel ( spirv::TargetEnvAttr targetAttr )

Returns addressing model selected based on target environment.

Definition at line 203 of file TargetAndABI.cpp.

References mlir::spirv::TargetEnvAttr::getCapabilities().

Referenced by getDefaultABIAttrs(), hasOneBranchOpTo(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ getBuiltinVariableValue()

Value mlir::spirv::getBuiltinVariableValue	(	Operation *	op,
		BuiltIn	builtin,
		Type	integerType,
		OpBuilder &	builder
	)

Returns the value for the given builtin variable.

This function gets or inserts the global variable associated for the builtin within the nearest symbol table enclosing op. Returns null Value on error.

Referenced by getLocalInvocationDimSize(), and getOrInsertBuiltinVariable().

◆ getDefaultResourceLimits()

spirv::ResourceLimitsAttr mlir::spirv::getDefaultResourceLimits ( MLIRContext * context )

Returns a default resource limits attribute that uses numbers from "Table 46. Required Limits" of the Vulkan spec.

Definition at line 154 of file TargetAndABI.cpp.

References mlir::Builder::getI32ArrayAttr().

Referenced by getDefaultTargetEnv(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ getDefaultTargetEnv()

spirv::TargetEnvAttr mlir::spirv::getDefaultTargetEnv ( MLIRContext * context )

Returns the default target environment: SPIR-V 1.0 with Shader capability and no extra extensions.

Definition at line 169 of file TargetAndABI.cpp.

References mlir::spirv::VerCapExtAttr::get(), mlir::spirv::TargetEnvAttr::get(), getDefaultResourceLimits(), and mlir::spirv::TargetEnvAttr::kUnknownDeviceID.

Referenced by lookupTargetEnvOrDefault(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and verifyConstantType().

◆ getDirectImpliedCapabilities()

ArrayRef<Capability> mlir::spirv::getDirectImpliedCapabilities ( Capability cap )

Returns the directly implied capabilities for the given capability.

These capabilities are implicitly declared by the given capability.

◆ getElementPtr()

Value mlir::spirv::getElementPtr	(	SPIRVTypeConverter &	typeConverter,
		MemRefType	baseType,
		Value	basePtr,
		ValueRange	indices,
		Location	loc,
		OpBuilder &	builder
	)

Performs the index computation to get to the element at indices of the memory pointed to by basePtr, using the layout map of baseType.

Returns null if index computation cannot be performed.

Definition at line 792 of file SPIRVConversion.cpp.

References mlir::SPIRVTypeConverter::allows(), getOpenCLElementPtr(), and getVulkanElementPtr().

Referenced by castBoolToIntN(), and getLocalInvocationDimSize().

◆ getEntryPointABIAttr()

spirv::EntryPointABIAttr mlir::spirv::getEntryPointABIAttr	(	ArrayRef< int32_t >	localSize,
		MLIRContext *	context
	)

Gets the EntryPointABIAttr given its fields.

Definition at line 122 of file TargetAndABI.cpp.

Referenced by mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ getEntryPointABIAttrName()

StringRef mlir::spirv::getEntryPointABIAttrName ( )

Returns the attribute name for specifying entry point information.

Definition at line 119 of file TargetAndABI.cpp.

Referenced by lookupEntryPointABI(), lowerAsEntryFunction(), lowerEntryPointABIAttr(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and print().

◆ getExecutionModel()

FailureOr< spirv::ExecutionModel > mlir::spirv::getExecutionModel ( spirv::TargetEnvAttr targetAttr )

Returns execution model selected based on target environment.

Returns failure if it cannot be selected.

Definition at line 220 of file TargetAndABI.cpp.

References mlir::failure(), and mlir::spirv::TargetEnvAttr::getCapabilities().

Referenced by lowerEntryPointABIAttr(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and verifyConstantType().

◆ getImpliedExtensions()

ArrayRef<Extension> mlir::spirv::getImpliedExtensions ( Version version )

Returns the implied extensions for the given version.

These extensions are incorporated into the current version so they are implicitly declared when targeting the given version.

Referenced by mlir::spirv::TargetEnv::TargetEnv().

◆ getInterfaceVarABIAttr()

InterfaceVarABIAttr mlir::spirv::getInterfaceVarABIAttr	(	unsigned	descriptorSet,
		unsigned	binding,
		Optional< StorageClass >	storageClass,
		MLIRContext *	context
	)

Gets the InterfaceVarABIAttr given its fields.

Referenced by getDefaultABIAttrs(), getInterfaceVarABIAttrName(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ getInterfaceVarABIAttrName()

StringRef mlir::spirv::getInterfaceVarABIAttrName ( )

Returns the attribute name for specifying argument ABI information.

Definition at line 97 of file TargetAndABI.cpp.

References mlir::spirv::InterfaceVarABIAttr::get(), and getInterfaceVarABIAttr().

Referenced by getDefaultABIAttrs(), lowerAsEntryFunction(), lowerEntryPointABIAttr(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and verifyRegionAttribute().

◆ getMemoryModel()

FailureOr< spirv::MemoryModel > mlir::spirv::getMemoryModel ( spirv::TargetEnvAttr targetAttr )

Returns memory model selected based on target environment.

Returns failure if it cannot be selected.

Definition at line 231 of file TargetAndABI.cpp.

References mlir::failure(), mlir::spirv::TargetEnvAttr::getCapabilities(), and mlir::gpu::amd::OpenCL.

Referenced by getDefaultABIAttrs(), hasOneBranchOpTo(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ getMemorySpaceToStorageClassTarget()

std::unique_ptr< ConversionTarget > mlir::spirv::getMemorySpaceToStorageClassTarget ( MLIRContext & context )

Creates the target that populates legality of ops with MemRef types.

Definition at line 224 of file MapMemRefStorageClassPass.cpp.

References mlir::ConversionPatternRewriter::applySignatureConversion(), mlir::Region::begin(), mlir::OpBuilder::create(), mlir::Region::getArgumentTypes(), mlir::Operation::getAttrs(), mlir::Operation::getLoc(), mlir::Operation::getName(), mlir::Region::getNumArguments(), mlir::Operation::getRegions(), mlir::Operation::getResults(), mlir::Operation::getResultTypes(), mlir::OperationName::getStringRef(), mlir::Operation::getSuccessors(), mlir::ConversionPatternRewriter::inlineRegionBefore(), isLegalOp(), mlir::ConversionPatternRewriter::replaceOp(), and mlir::success().

Referenced by populateMemorySpaceToStorageClassPatterns().

◆ getOpenCLElementPtr()

Value mlir::spirv::getOpenCLElementPtr	(	SPIRVTypeConverter &	typeConverter,
		MemRefType	baseType,
		Value	basePtr,
		ValueRange	indices,
		Location	loc,
		OpBuilder &	builder
	)

Definition at line 762 of file SPIRVConversion.cpp.

References mlir::OpBuilder::create(), mlir::failed(), mlir::SPIRVTypeConverter::getIndexType(), mlir::getStridesAndOffset(), getZero(), and linearizeIndex().

Referenced by getElementPtr().

◆ getPrefixedOpcode()

uint32_t mlir::spirv::getPrefixedOpcode	(	uint32_t	wordCount,
		spirv::Opcode	opcode
	)

Returns the word-count-prefixed opcode for an SPIR-V instruction.

Definition at line 61 of file SPIRVBinaryUtils.cpp.

Referenced by encodeInstructionInto().

◆ getPushConstantValue()

Value mlir::spirv::getPushConstantValue	(	Operation *	op,
		unsigned	elementCount,
		unsigned	offset,
		Type	integerType,
		OpBuilder &	builder
	)

Gets the value at the given offset of the push constant storage with a total of elementCount integerType integers.

A global variable will be created in the nearest symbol table enclosing op for the push constant storage if not existing. Load ops will be created via the given builder to load values from the push constant. Returns null Value on error.

Definition at line 681 of file SPIRVConversion.cpp.

References mlir::Operation::emitError(), mlir::Region::front(), mlir::Operation::getLoc(), mlir::SymbolTable::getNearestSymbolTable(), getOrInsertPushConstantVariable(), mlir::Operation::getParentOp(), mlir::Operation::getRegion(), and getZero().

◆ getRecursiveImpliedCapabilities()

SmallVector<Capability, 0> mlir::spirv::getRecursiveImpliedCapabilities ( Capability cap )

Returns the recursively implied capabilities for the given capability.

These capabilities are implicitly declared by the given capability. Compared to the above function, this function collects implied capabilities recursively: if an implicitly declared capability implicitly declares a third one, the third one will also be returned.

Referenced by mlir::spirv::TargetEnv::TargetEnv().

◆ getTargetEnvAttrName()

StringRef mlir::spirv::getTargetEnvAttrName ( )

Returns the attribute name for specifying SPIR-V target environment.

Definition at line 167 of file TargetAndABI.cpp.

Referenced by lookupTargetEnv(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and print().

◆ getVulkanElementPtr()

Value mlir::spirv::getVulkanElementPtr	(	SPIRVTypeConverter &	typeConverter,
		MemRefType	baseType,
		Value	basePtr,
		ValueRange	indices,
		Location	loc,
		OpBuilder &	builder
	)

Definition at line 731 of file SPIRVConversion.cpp.

References mlir::OpBuilder::create(), mlir::failed(), mlir::SPIRVTypeConverter::getIndexType(), mlir::getStridesAndOffset(), getZero(), and linearizeIndex().

Referenced by getElementPtr().

◆ hash_value()

llvm::hash_code mlir::spirv::hash_value ( const StructType::MemberDecorationInfo & memberDecorationInfo )

Definition at line 1143 of file SPIRVTypes.cpp.

References mlir::spirv::StructType::MemberDecorationInfo::decoration, and mlir::spirv::StructType::MemberDecorationInfo::memberIndex.

◆ linearizeIndex()

Value mlir::spirv::linearizeIndex	(	ValueRange	indices,
		ArrayRef< int64_t >	strides,
		int64_t	offset,
		Type	integerType,
		Location	loc,
		OpBuilder &	builder
	)

Generates IR to perform index linearization with the given indices and their corresponding strides, adding an initial offset.

Definition at line 707 of file SPIRVConversion.cpp.

References mlir::OpBuilder::create(), and mlir::detail::enumerate().

Referenced by mlir::Sliceable< Derived, ElementTy >::getElement(), mlir::Sliceable< Derived, ElementTy >::getItem(), getOpenCLElementPtr(), and getVulkanElementPtr().

◆ lookupEntryPointABI()

spirv::EntryPointABIAttr mlir::spirv::lookupEntryPointABI ( Operation * op )

Queries the entry point ABI on the nearest function-like op containing the given op.

Returns null attribute if not found.

Definition at line 133 of file TargetAndABI.cpp.

References mlir::Operation::getAttrOfType(), getEntryPointABIAttrName(), and mlir::Operation::getParentOp().

Referenced by getDefaultABIAttrs(), lookupLocalWorkGroupSize(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ lookupLocalWorkGroupSize()

DenseIntElementsAttr mlir::spirv::lookupLocalWorkGroupSize ( Operation * op )

Queries the local workgroup size from entry point ABI on the nearest function-like op containing the given op.

Returns null attribute if not found.

Definition at line 146 of file TargetAndABI.cpp.

References lookupEntryPointABI().

Referenced by getLocalInvocationDimSize(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ lookupTargetEnv()

spirv::TargetEnvAttr mlir::spirv::lookupTargetEnv ( Operation * op )

Queries the target environment recursively from enclosing symbol table ops containing the given op.

Definition at line 179 of file TargetAndABI.cpp.

References mlir::Operation::getAttrOfType(), mlir::SymbolTable::getNearestSymbolTable(), mlir::Operation::getParentOp(), and getTargetEnvAttrName().

Referenced by checkAndUpdateCapabilityRequirements(), lookupTargetEnvOrDefault(), lowerEntryPointABIAttr(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), and populateMemorySpaceToStorageClassPatterns().

◆ lookupTargetEnvOrDefault()

spirv::TargetEnvAttr mlir::spirv::lookupTargetEnvOrDefault ( Operation * op )

Queries the target environment recursively from enclosing symbol table ops containing the given op or returns the default target environment as returned by getDefaultTargetEnv() if not provided.

Definition at line 195 of file TargetAndABI.cpp.

References mlir::Operation::getContext(), getDefaultTargetEnv(), and lookupTargetEnv().

Referenced by getDefaultABIAttrs(), mlir::spirv::TargetEnv::operator TargetEnvAttr(), mlir::arith::populateArithmeticToSPIRVPatterns(), and verifyConstantType().

◆ mapMemorySpaceToOpenCLStorageClass()

Optional< spirv::StorageClass > mlir::spirv::mapMemorySpaceToOpenCLStorageClass ( unsigned memorySpace )

Maps MemRef memory spaces to storage classes for OpenCL-flavored SPIR-V using the default rule.

Returns None if the memory space is unknown.

Definition at line 102 of file MapMemRefStorageClassPass.cpp.

References OPENCL_STORAGE_SPACE_MAP_LIST, and STORAGE_SPACE_MAP_FN.

Referenced by populateMemorySpaceToStorageClassPatterns().

◆ mapMemorySpaceToVulkanStorageClass()

Optional< spirv::StorageClass > mlir::spirv::mapMemorySpaceToVulkanStorageClass ( unsigned memorySpace )

Maps MemRef memory spaces to storage classes for Vulkan-flavored SPIR-V using the default rule.

Returns None if the memory space is unknown.

Definition at line 59 of file MapMemRefStorageClassPass.cpp.

References STORAGE_SPACE_MAP_FN, and VULKAN_STORAGE_SPACE_MAP_LIST.

Referenced by populateMemorySpaceToStorageClassPatterns().

◆ mapOpenCLStorageClassToMemorySpace()

Optional< unsigned > mlir::spirv::mapOpenCLStorageClassToMemorySpace ( spirv::StorageClass storageClass )

Maps storage classes for OpenCL-flavored SPIR-V to MemRef memory spaces using the default rule.

Returns None if the storage class is unsupported.

Definition at line 118 of file MapMemRefStorageClassPass.cpp.

References OPENCL_STORAGE_SPACE_MAP_LIST, and STORAGE_SPACE_MAP_FN.

◆ mapVulkanStorageClassToMemorySpace()

Optional< unsigned > mlir::spirv::mapVulkanStorageClassToMemorySpace ( spirv::StorageClass storageClass )

Maps storage classes for Vulkan-flavored SPIR-V to MemRef memory spaces using the default rule.

Returns None if the storage class is unsupported.

Definition at line 75 of file MapMemRefStorageClassPass.cpp.

References STORAGE_SPACE_MAP_FN, and VULKAN_STORAGE_SPACE_MAP_LIST.

◆ needsInterfaceVarABIAttrs()

bool mlir::spirv::needsInterfaceVarABIAttrs ( spirv::TargetEnvAttr targetAttr )

Returns whether the given SPIR-V target (described by TargetEnvAttr) needs ABI attributes for interface variables (spirv.interface_var_abi).

Definition at line 109 of file TargetAndABI.cpp.

References mlir::spirv::TargetEnvAttr::getCapabilities().

Referenced by getDefaultABIAttrs(), and mlir::spirv::TargetEnv::operator TargetEnvAttr().

◆ populateMemorySpaceToStorageClassPatterns()

void mlir::spirv::populateMemorySpaceToStorageClassPatterns	(	spirv::MemorySpaceToStorageClassConverter &	typeConverter,
		RewritePatternSet &	patterns
	)

Appends to a pattern list additional patterns for converting numeric MemRef memory spaces into SPIR-V symbolic ones.

Definition at line 281 of file MapMemRefStorageClassPass.cpp.

References mlir::RewritePatternSet::add(), mlir::spirv::TargetEnv::allows(), mlir::applyFullConversion(), mlir::failed(), mlir::failure(), mlir::RewritePatternSet::getContext(), getMemorySpaceToStorageClassTarget(), mlir::Pass::initializeOptions(), lookupTargetEnv(), mapMemorySpaceToOpenCLStorageClass(), mapMemorySpaceToVulkanStorageClass(), options, and mlir::success().

◆ populateSPIRVGLCanonicalizationPatterns()

void mlir::spirv::populateSPIRVGLCanonicalizationPatterns ( RewritePatternSet & results )

Populates patterns to run canoncalization that involves GL ops.

These patterns cannot be run in default canonicalization because GL ops aren't always available. So they should be involed specifically when needed.

Definition at line 25 of file SPIRVGLCanonicalization.cpp.

References mlir::RewritePatternSet::add(), and mlir::RewritePatternSet::getContext().

◆ serialize()

LogicalResult mlir::spirv::serialize	(	ModuleOp	module,
		SmallVectorImpl< uint32_t > &	binary,
		const SerializationOptions &	options = `{}`
	)

Serializes the given SPIR-V module and writes to binary.

On failure, reports errors to the error handler registered with the MLIR context for module.

Referenced by roundTripModule(), and serializeModule().

◆ Serializer::processOp< spirv::CopyMemoryOp >()

template<>

LogicalResult mlir::spirv::Serializer::processOp< spirv::CopyMemoryOp > ( spirv::CopyMemoryOp op )

Definition at line 629 of file SerializeOps.cpp.

References encodeInstructionInto(), mlir::failed(), mlir::failure(), and mlir::success().

◆ Serializer::processOp< spirv::EntryPointOp >()

template<>

LogicalResult mlir::spirv::Serializer::processOp< spirv::EntryPointOp > ( spirv::EntryPointOp op )

Definition at line 538 of file SerializeOps.cpp.

References encodeInstructionInto(), encodeStringLiteralInto(), mlir::FlatSymbolRefAttr::getValue(), and mlir::success().

◆ Serializer::processOp< spirv::ExecutionModeOp >()

template<>

LogicalResult mlir::spirv::Serializer::processOp< spirv::ExecutionModeOp > ( spirv::ExecutionModeOp op )

Definition at line 573 of file SerializeOps.cpp.

References encodeInstructionInto(), and mlir::success().

◆ Serializer::processOp< spirv::FunctionCallOp >()

template<>

LogicalResult mlir::spirv::Serializer::processOp< spirv::FunctionCallOp > ( spirv::FunctionCallOp op )

Definition at line 602 of file SerializeOps.cpp.

References encodeInstructionInto(), mlir::failed(), mlir::failure(), mlir::Type::isa(), mlir::success(), and value.

◆ Serializer::processOp< spirv::GenericCastToPtrExplicitOp >()

template<>

LogicalResult mlir::spirv::Serializer::processOp< spirv::GenericCastToPtrExplicitOp > ( spirv::GenericCastToPtrExplicitOp op )

Definition at line 673 of file SerializeOps.cpp.

References mlir::Type::cast(), encodeInstructionInto(), mlir::failed(), mlir::failure(), and mlir::success().

◆ Serializer::processTypeDecoration< spirv::ArrayType >()

template<>

LogicalResult mlir::spirv::Serializer::processTypeDecoration< spirv::ArrayType >	(	Location	loc,
		spirv::ArrayType	type,
		uint32_t	resultID
	)

Definition at line 269 of file Serializer.cpp.

References mlir::success().

◆ Serializer::processTypeDecoration< spirv::RuntimeArrayType >()

template<>

LogicalResult mlir::spirv::Serializer::processTypeDecoration< spirv::RuntimeArrayType >	(	Location	loc,
		spirv::RuntimeArrayType	type,
		uint32_t	resultID
	)

Variable Documentation

◆ kGeneratorNumber

constexpr uint32_t mlir::spirv::kGeneratorNumber = 22

The serializer tool ID registered to the Khronos Group.

Definition at line 31 of file SPIRVBinaryUtils.h.

Referenced by appendModuleHeader().

◆ kHeaderWordCount

constexpr unsigned mlir::spirv::kHeaderWordCount = 5

SPIR-V binary header word count.

Definition at line 25 of file SPIRVBinaryUtils.h.

Referenced by mlir::spirv::Serializer::collect(), and mlir::spirv::Deserializer::collect().

◆ kMagicNumber

constexpr uint32_t mlir::spirv::kMagicNumber = 0x07230203

SPIR-V magic number.

Definition at line 28 of file SPIRVBinaryUtils.h.

Referenced by appendModuleHeader(), and mlir::spirv::Deserializer::collect().

Namespaces

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ BlockMergeInfoMap

◆ MemorySpaceToStorageClassMap

◆ SymbolRenameListener

Function Documentation

◆ appendModuleHeader()

◆ combine()

◆ createCanonicalizeGLPass()

◆ createDecorateSPIRVCompositeTypeLayoutPass()

◆ createLowerABIAttributesPass()

◆ createRewriteInsertsPass()

◆ createUnifyAliasedResourcePass()

◆ createUpdateVersionCapabilityExtensionPass()

◆ decodeStringLiteral()

◆ deserialize()

◆ Deserializer::processOp< spirv::CopyMemoryOp >()

◆ Deserializer::processOp< spirv::EntryPointOp >()

◆ Deserializer::processOp< spirv::ExecutionModeOp >()

◆ Deserializer::processOp< spirv::FunctionCallOp >()

◆ Deserializer::processOp< spirv::GenericCastToPtrExplicitOp >()

◆ encodeInstructionInto()

◆ encodeStringLiteralInto()

◆ getAddressingModel()

◆ getBuiltinVariableValue()

◆ getDefaultResourceLimits()

◆ getDefaultTargetEnv()

◆ getDirectImpliedCapabilities()

◆ getElementPtr()

◆ getEntryPointABIAttr()

◆ getEntryPointABIAttrName()

◆ getExecutionModel()

◆ getImpliedExtensions()

◆ getInterfaceVarABIAttr()

◆ getInterfaceVarABIAttrName()

◆ getMemoryModel()

◆ getMemorySpaceToStorageClassTarget()

◆ getOpenCLElementPtr()

◆ getPrefixedOpcode()

◆ getPushConstantValue()

◆ getRecursiveImpliedCapabilities()

◆ getTargetEnvAttrName()

◆ getVulkanElementPtr()

◆ hash_value()

◆ linearizeIndex()

◆ lookupEntryPointABI()

◆ lookupLocalWorkGroupSize()

◆ lookupTargetEnv()

◆ lookupTargetEnvOrDefault()

◆ mapMemorySpaceToOpenCLStorageClass()

◆ mapMemorySpaceToVulkanStorageClass()

◆ mapOpenCLStorageClassToMemorySpace()

◆ mapVulkanStorageClassToMemorySpace()

◆ needsInterfaceVarABIAttrs()

◆ populateMemorySpaceToStorageClassPatterns()

◆ populateSPIRVGLCanonicalizationPatterns()

◆ serialize()

◆ Serializer::processOp< spirv::CopyMemoryOp >()

◆ Serializer::processOp< spirv::EntryPointOp >()

◆ Serializer::processOp< spirv::ExecutionModeOp >()

◆ Serializer::processOp< spirv::FunctionCallOp >()

◆ Serializer::processOp< spirv::GenericCastToPtrExplicitOp >()

◆ Serializer::processTypeDecoration< spirv::ArrayType >()

◆ Serializer::processTypeDecoration< spirv::RuntimeArrayType >()

Variable Documentation

◆ kGeneratorNumber

◆ kHeaderWordCount

◆ kMagicNumber