Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_NV_cooperative_matrix

Name

VK_NV_cooperative_matrix - device extension

VK_NV_cooperative_matrix

Name String: VK_NV_cooperative_matrix

Extension Type

Device extension

Registered Extension Number

250

Revision

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

Vulkan Version 1.1

SPIR-V Dependencies

SPV_NV_cooperative_matrix

Contact

Jeff Bolz @jeffbolznv%0A*Here describe the issue or question you have about the VK_NV_cooperative_matrix extension*

Other Extension Metadata

Last Modified Date: 2019-02-05

Interactions and External Dependencies

This extension provides API support for GL_NV_cooperative_matrix

Contributors

Jeff Bolz, NVIDIA
Markus Tavenrath, NVIDIA
Daniel Koch, NVIDIA

Description

This extension adds support for using cooperative matrix types in SPIR-V. Cooperative matrix types are medium-sized matrices that are primarily supported in compute shaders, where the storage for the matrix is spread across all invocations in some scope (usually a subgroup) and those invocations cooperate to efficiently perform matrix multiplies.

Cooperative matrix types are defined by the SPV_NV_cooperative_matrix SPIR-V extension and can be used with the GL_NV_cooperative_matrix GLSL extension.

This extension includes support for enumerating the matrix types and dimensions that are supported by the implementation.

Issues

What matrix properties will be supported in practice?

RESOLVED: In NVIDIA’s initial implementation, we will support:

AType = BType = fp16 CType = DType = fp16 MxNxK = 16x8x16 scope = Subgroup
AType = BType = fp16 CType = DType = fp16 MxNxK = 16x8x8 scope = Subgroup
AType = BType = fp16 CType = DType = fp32 MxNxK = 16x8x16 scope = Subgroup
AType = BType = fp16 CType = DType = fp32 MxNxK = 16x8x8 scope = Subgroup

Version History

Revision 1, 2019-02-05 (Jeff Bolz)
- Internal revisions

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

9 types
1 value

Packagevulkan-3.27
Exports47
LanguageGHC2021
LicenceBSD-3-Clause
SourceVK_NV_cooperative_matrix.hs

valuegetPhysicalDeviceCooperativeMatrixPropertiesNV

:: MonadIO io
=> PhysicalDevice
physicalDevice is the physical device.
-> io (Result, "properties" ::: Vector CooperativeMatrixPropertiesNV)

vkGetPhysicalDeviceCooperativeMatrixPropertiesNV - Returns properties describing what cooperative matrix types are supported

Description

If pProperties is NULL, then the number of cooperative matrix properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the application to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of cooperative matrix properties available, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available cooperative matrix properties were returned.

Valid Usage (Implicit)

physicalDevice must be a valid PhysicalDevice handle

pPropertyCount must be a valid pointer to a uint32_t value
If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount CooperativeMatrixPropertiesNV structures

Return Codes

Success

Failure

Members

This structure describes the following features:

Description

If the PhysicalDeviceCooperativeMatrixFeaturesNV structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceCooperativeMatrixFeaturesNV, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

Constructors

PhysicalDeviceCooperativeMatrixFeaturesNV
- cooperativeMatrix :: Bool
  cooperativeMatrix indicates that the implementation supports the CooperativeMatrixNV SPIR-V capability.
- cooperativeMatrixRobustBufferAccess :: Bool
  cooperativeMatrixRobustBufferAccess indicates that the implementation supports implementation supports robust buffer access for SPIR-V OpCooperativeMatrixLoadNV and OpCooperativeMatrixStoreNV instructions.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Show PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Storable PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
FromCStruct PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
ToCStruct PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Zero PhysicalDeviceCooperativeMatrixFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix

datadata PhysicalDeviceCooperativeMatrixPropertiesNV

VkPhysicalDeviceCooperativeMatrixPropertiesNV - Structure describing cooperative matrix properties supported by an implementation

Description

If the PhysicalDeviceCooperativeMatrixPropertiesNV structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Structure Chaining

Extends the structure

PhysicalDeviceProperties2

Constructors

PhysicalDeviceCooperativeMatrixPropertiesNV
- cooperativeMatrixSupportedStages :: ShaderStageFlags
  cooperativeMatrixSupportedStages is a bitfield of ShaderStageFlagBits describing the shader stages that cooperative matrix instructions are supported in. cooperativeMatrixSupportedStages will have the SHADER_STAGE_COMPUTE_BIT bit set if any of the physical device’s queues support QUEUE_COMPUTE_BIT.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Show PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Storable PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
FromCStruct PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
ToCStruct PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Zero PhysicalDeviceCooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix

datadata CooperativeMatrixPropertiesNV

VkCooperativeMatrixPropertiesNV - Structure specifying cooperative matrix properties

Description

If some types are preferred over other types (e.g. for performance), they should appear earlier in the list enumerated by getPhysicalDeviceCooperativeMatrixPropertiesNV.

At least one entry in the list must have power of two values for all of MSize, KSize, and NSize.

Valid Usage (Implicit)

Constructors

CooperativeMatrixPropertiesNV
- mSize :: Word32
  MSize is the number of rows in matrices A, C, and D.
- nSize :: Word32
  NSize is the number of columns in matrices B, C, D.
- kSize :: Word32
  KSize is the number of columns in matrix A and rows in matrix B.
- aType :: ComponentTypeNV
  AType is the component type of matrix A, of type ComponentTypeNV.
- bType :: ComponentTypeNV
  BType is the component type of matrix B, of type ComponentTypeNV.
- cType :: ComponentTypeNV
  CType is the component type of matrix C, of type ComponentTypeNV.
- dType :: ComponentTypeNV
  DType is the component type of matrix D, of type ComponentTypeNV.
- scope :: ScopeNV
  scope is the scope of all the matrix types, of type ScopeNV.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Show CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Storable CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
FromCStruct CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
ToCStruct CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix
Zero CooperativeMatrixPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_matrix

typetype ScopeNV = ScopeKHR

typetype ComponentTypeNV = ComponentTypeKHR

typetype NV_COOPERATIVE_MATRIX_SPEC_VERSION = 1

patternpattern NV_COOPERATIVE_MATRIX_SPEC_VERSION :: Integral a => a

typetype NV_COOPERATIVE_MATRIX_EXTENSION_NAME = "VK_NV_cooperative_matrix"

patternpattern NV_COOPERATIVE_MATRIX_EXTENSION_NAME :: (Eq a, IsString a) => a

newtypenewtype ScopeKHR

VkScopeKHR - Specify SPIR-V scope

Description

SCOPE_DEVICE_KHR corresponds to SPIR-V Device scope.

SCOPE_WORKGROUP_KHR corresponds to SPIR-V Workgroup scope.
SCOPE_SUBGROUP_KHR corresponds to SPIR-V Subgroup scope.
SCOPE_QUEUE_FAMILY_KHR corresponds to SPIR-V QueueFamily scope.

All enum values match the corresponding SPIR-V value.

Constructors

ScopeKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix
Ord ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix
Read ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix
Show ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix
Storable ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix
Zero ScopeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_cooperative_matrix

patternpattern SCOPE_DEVICE_KHR :: ScopeKHR

patternpattern SCOPE_QUEUE_FAMILY_KHR :: ScopeKHR

patternpattern SCOPE_SUBGROUP_KHR :: ScopeKHR

patternpattern SCOPE_WORKGROUP_KHR :: ScopeKHR

newtypenewtype ComponentTypeKHR

VkComponentTypeKHR - Specify SPIR-V cooperative matrix component type

Description

COMPONENT_TYPE_FLOAT16_KHR corresponds to SPIR-V OpTypeFloat 16.

COMPONENT_TYPE_FLOAT32_KHR corresponds to SPIR-V OpTypeFloat 32.
COMPONENT_TYPE_FLOAT64_KHR corresponds to SPIR-V OpTypeFloat 64.
COMPONENT_TYPE_SINT8_KHR corresponds to SPIR-V OpTypeInt 8 0/1.
COMPONENT_TYPE_SINT16_KHR corresponds to SPIR-V OpTypeInt 16 0/1.
COMPONENT_TYPE_SINT32_KHR corresponds to SPIR-V OpTypeInt 32 0/1.
COMPONENT_TYPE_SINT64_KHR corresponds to SPIR-V OpTypeInt 64 0/1.
COMPONENT_TYPE_UINT8_KHR corresponds to SPIR-V OpTypeInt 8 0/1.
COMPONENT_TYPE_UINT16_KHR corresponds to SPIR-V OpTypeInt 16 0/1.
COMPONENT_TYPE_UINT32_KHR corresponds to SPIR-V OpTypeInt 32 0/1.
COMPONENT_TYPE_UINT64_KHR corresponds to SPIR-V OpTypeInt 64 0/1.
COMPONENT_TYPE_BFLOAT16_KHR corresponds to SPIR-V OpTypeFloat 16 BFloat16KHR.
COMPONENT_TYPE_SINT8_PACKED_NV corresponds to four 8-bit signed integers packed in a 32-bit unsigned integer.
COMPONENT_TYPE_UINT8_PACKED_NV corresponds to four 8-bit unsigned integers packed in a 32-bit unsigned integer.
COMPONENT_TYPE_FLOAT_E4M3_NV corresponds to a floating-point type with a sign bit in the most significant bit, followed by four exponent bits, followed by three mantissa bits.
COMPONENT_TYPE_FLOAT_E5M2_NV corresponds to a floating-point type with a sign bit in the most significant bit, followed by five exponent bits, followed by two mantissa bits.
COMPONENT_TYPE_FLOAT8_E4M3_EXT corresponds to SPIR-V OpTypeFloat 8 Float8E4M3EXT.
COMPONENT_TYPE_FLOAT8_E5M2_EXT corresponds to SPIR-V OpTypeFloat 8 Float8E5M2EXT.

Constructors

ComponentTypeKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector
Ord ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector
Read ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector
Show ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector
Storable ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector
Zero ComponentTypeKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_cooperative_vector

patternpattern COMPONENT_TYPE_BFLOAT16_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_FLOAT16_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_FLOAT32_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_FLOAT64_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_FLOAT8_E4M3_EXT :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_FLOAT8_E5M2_EXT :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_SINT16_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_SINT32_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_SINT64_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_SINT8_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_SINT8_PACKED_NV :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_UINT16_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_UINT32_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_UINT64_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_UINT8_KHR :: ComponentTypeKHR

patternpattern COMPONENT_TYPE_UINT8_PACKED_NV :: ComponentTypeKHR

Vulkan.Extensions.VK_NV_cooperative_matrix

Name

VK_NV_cooperative_matrix

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

New SPIR-V Capabilities

Issues

Version History

See Also

Document Notes

Description

Valid Usage (Implicit)

Return Codes

See Also

Members

Description

Structure Chaining

See Also

Constructors

Description

Structure Chaining

See Also

Constructors

Description

Valid Usage (Implicit)

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors