Package org.lwjgl.vulkan

Class NVCooperativeMatrix2

java.lang.Object

org.lwjgl.vulkan.NVCooperativeMatrix2

public class NVCooperativeMatrix2
extends Object

This extension adds several new features building on the cooperative matrix types added in VK_KHR_cooperative_matrix. The goal is to add and accelerate features beyond just simple GEMM kernels, including adding support for type/use conversions, reductions, per-element operations, and tensor addressing, and also to improve usability and out-of-the-box performance by adding support for more flexible matrix sizes, and workgroup scope matrices with compiler-managed staging through shared memory.

The new functionality is defined by the SPV_NV_tensor_addressing and SPV_NV_cooperative_matrix2 SPIR-V extensions and can be used with the GLSL_NV_cooperative_matrix2 GLSL extension.

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

Name String

VK_NV_cooperative_matrix2

Extension Type

Device extension

Registered Extension Number

594

Revision

1

Extension and Version Dependencies

VK_KHR_cooperative_matrix

SPIR-V Dependencies

• SPV_NV_cooperative_matrix2
• SPV_NV_tensor_addressing

Contact

• Jeff Bolz jeffbolznv

Extension Proposal

VK_NV_cooperative_matrix2

Other Extension Metadata

Last Modified Date

2024-08-01

Interactions and External Dependencies

• This extension provides API support for GLSL_NV_cooperative_matrix2

Contributors

• Jeff Bolz, NVIDIA
• Karthik Vaidyanathan, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_NV_COOPERATIVE_MATRIX_2_EXTENSION_NAME	The extension name.
static final int	VK_NV_COOPERATIVE_MATRIX_2_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkCooperativeMatrixFlexibleDimensionsPropertiesNV.Buffer pProperties)	Array version of: GetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, @Nullable VkCooperativeMatrixFlexibleDimensionsPropertiesNV.Buffer pProperties)	Returns properties describing what cooperative matrix types are supported.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_NV_COOPERATIVE_MATRIX_2_SPEC_VERSION

public static final int VK_NV_COOPERATIVE_MATRIX_2_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_NV_COOPERATIVE_MATRIX_2_EXTENSION_NAME

public static final String VK_NV_COOPERATIVE_MATRIX_2_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV
• STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV

public static final int VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV
• STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_FEATURES_NV
• STRUCTURE_TYPE_COOPERATIVE_MATRIX_FLEXIBLE_DIMENSIONS_PROPERTIES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_2_PROPERTIES_NV

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV

public static int nvkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pPropertyCount,
 long pProperties)

Unsafe version of: GetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV

Parameters:

pPropertyCount - a pointer to an integer related to the number of cooperative matrix properties available or queried.

vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV

public static int vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 IntBuffer pPropertyCount,
 @Nullable VkCooperativeMatrixFlexibleDimensionsPropertiesNV.Buffer pProperties)

Returns properties describing what cooperative matrix types are supported.

C Specification

To enumerate additional supported cooperative matrix types and operations, call:

 VkResult vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkCooperativeMatrixFlexibleDimensionsPropertiesNV* pProperties);

Description

If pProperties is NULL, then the number of flexible dimensions 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 flexible dimensions properties available, at most pPropertyCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available flexible dimensions properties were returned.

If the cooperativeMatrixFlexibleDimensions feature is not supported, the implementation must advertise zero properties.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice 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 VkCooperativeMatrixFlexibleDimensionsPropertiesNV structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkCooperativeMatrixFlexibleDimensionsPropertiesNV

Parameters:

physicalDevice - the physical device.

pPropertyCount - a pointer to an integer related to the number of cooperative matrix properties available or queried.

pProperties - either NULL or a pointer to an array of VkCooperativeMatrixFlexibleDimensionsPropertiesNV structures.

vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV

public static int vkGetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int[] pPropertyCount,
 @Nullable VkCooperativeMatrixFlexibleDimensionsPropertiesNV.Buffer pProperties)

Array version of: GetPhysicalDeviceCooperativeMatrixFlexibleDimensionsPropertiesNV