VkTensorMemoryBarrierARM(3)

C Specification

The VkTensorMemoryBarrierARM structure is defined as:

// Provided by VK_ARM_tensors
typedef struct VkTensorMemoryBarrierARM {
    VkStructureType          sType;
    const void*              pNext;
    VkPipelineStageFlags2    srcStageMask;
    VkAccessFlags2           srcAccessMask;
    VkPipelineStageFlags2    dstStageMask;
    VkAccessFlags2           dstAccessMask;
    uint32_t                 srcQueueFamilyIndex;
    uint32_t                 dstQueueFamilyIndex;
    VkTensorARM              tensor;
} VkTensorMemoryBarrierARM;

Members

sType is a VkStructureType value identifying this structure.
pNext is NULL or a pointer to a structure extending this structure.
srcStageMask is a VkPipelineStageFlags2 mask of pipeline stages to be included in the first synchronization scope.
srcAccessMask is a VkAccessFlags2 mask of access flags to be included in the first access scope.
dstStageMask is a VkPipelineStageFlags2 mask of pipeline stages to be included in the second synchronization scope.
dstAccessMask is a VkAccessFlags2 mask of access flags to be included in the second access scope.
srcQueueFamilyIndex is the source queue family for a queue family ownership transfer.
dstQueueFamilyIndex is the destination queue family for a queue family ownership transfer.
tensor is a handle to the tensor whose backing memory is affected by the barrier.

Description

The first synchronization scope and access scope described by this structure include only operations and memory accesses specified by srcStageMask and srcAccessMask.

The second synchronization scope and access scope described by this structure include only operations and memory accesses specified by dstStageMask and dstAccessMask.

Both access scopes are limited to only memory accesses to tensor.

If tensor was created with VK_SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, this memory barrier defines a queue family transfer operation. When executed on a queue in the family identified by srcQueueFamilyIndex, this barrier defines a queue family release operation for the specified tensor, and the second synchronization and access scopes do not synchronize operations on that queue. When executed on a queue in the family identified by dstQueueFamilyIndex, this barrier defines a queue family acquire operation for the specified tensor, and the first synchronization and access scopes do not synchronize operations on that queue.

A queue family transfer operation is also defined if the values are not equal, and either is one of the special queue family values reserved for external memory ownership transfers, as described in https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#synchronization-queue-transfers. A queue family release operation is defined when dstQueueFamilyIndex is one of those values, and a queue family acquire operation is defined when srcQueueFamilyIndex is one of those values.

Valid Usage

VUID-VkTensorMemoryBarrierARM-tensor-09755
If tensor was created with a sharing mode of VK_SHARING_MODE_CONCURRENT, srcQueueFamilyIndex and dstQueueFamilyIndex must both be VK_QUEUE_FAMILY_IGNORED
VUID-VkTensorMemoryBarrierARM-tensor-09756
If tensor was created with a sharing mode of VK_SHARING_MODE_EXCLUSIVE, srcQueueFamilyIndex and dstQueueFamilyIndex must both be either VK_QUEUE_FAMILY_IGNORED, or a valid queue family (see https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#devsandqueues-queueprops)
VUID-VkTensorMemoryBarrierARM-tensor-09757
If tensor was created with a sharing mode of VK_SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not VK_QUEUE_FAMILY_IGNORED, at least one of them must be the same as the family of the queue that will execute this barrier
VUID-VkTensorMemoryBarrierARM-tensor-09758
If tensor is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

Valid Usage (Implicit)

VUID-VkTensorMemoryBarrierARM-sType-sType
sType must be VK_STRUCTURE_TYPE_TENSOR_MEMORY_BARRIER_ARM
VUID-VkTensorMemoryBarrierARM-srcStageMask-parameter
srcStageMask must be a valid combination of VkPipelineStageFlagBits2 values
VUID-VkTensorMemoryBarrierARM-srcAccessMask-parameter
srcAccessMask must be a valid combination of VkAccessFlagBits2 values
VUID-VkTensorMemoryBarrierARM-dstStageMask-parameter
dstStageMask must be a valid combination of VkPipelineStageFlagBits2 values
VUID-VkTensorMemoryBarrierARM-dstAccessMask-parameter
dstAccessMask must be a valid combination of VkAccessFlagBits2 values
VUID-VkTensorMemoryBarrierARM-tensor-parameter
tensor must be a valid VkTensorARM handle

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

SPDX-License-Identifier: CC-BY-4.0

VkTensorMemoryBarrierARM(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright