Vulkan.Extensions.VK_KHR_global_priority

Name

VK_KHR_global_priority - device extension

VK_KHR_global_priority

Name String

VK_KHR_global_priority

Extension Type

Device extension

Registered Extension Number

189

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Contact

• Tobias Hector @tobski%0A*Here describe the issue or question you have about the VK_KHR_global_priority extension*

Other Extension Metadata

Last Modified Date

2021-10-22

Contributors

• Tobias Hector, AMD
• Contributors to VK_EXT_global_priority
• Contributors to VK_EXT_global_priority_query

Description

In Vulkan, users can specify device-scope queue priorities. In some cases it may be useful to extend this concept to a system-wide scope. This device extension allows applications to query the global queue priorities supported by a queue family, and then set a priority when creating queues. The default queue priority is QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT.

Implementations can report which global priority levels are treated differently by the implementation. It is intended primarily for use in system integration along with certain platform-specific priority enforcement rules.

The driver implementation will attempt to skew hardware resource allocation in favour of the higher-priority task. Therefore, higher-priority work may retain similar latency and throughput characteristics even if the system is congested with lower priority work.

The global priority level of a queue shall take precedence over the per-process queue priority (DeviceQueueCreateInfo::pQueuePriorities).

Abuse of this feature may result in starving the rest of the system from hardware resources. Therefore, the driver implementation may deny requests to acquire a priority above the default priority (QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT) if the caller does not have sufficient privileges. In this scenario ERROR_NOT_PERMITTED_EXT is returned.

The driver implementation may fail the queue allocation request if resources required to complete the operation have been exhausted (either by the same process or a different process). In this scenario ERROR_INITIALIZATION_FAILED is returned.

New Structures

• Extending DeviceQueueCreateInfo:

  • DeviceQueueGlobalPriorityCreateInfoKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceGlobalPriorityQueryFeaturesKHR

• Extending QueueFamilyProperties2:

  • QueueFamilyGlobalPriorityPropertiesKHR

New Enums

• QueueGlobalPriorityKHR

New Enum Constants

• KHR_GLOBAL_PRIORITY_EXTENSION_NAME

• KHR_GLOBAL_PRIORITY_SPEC_VERSION
• MAX_GLOBAL_PRIORITY_SIZE_KHR

• Extending Result:

  • ERROR_NOT_PERMITTED_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_QUEUE_GLOBAL_PRIORITY_CREATE_INFO_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_GLOBAL_PRIORITY_QUERY_FEATURES_KHR
  • STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_KHR

Issues

1) Can we additionally query whether a caller is permitted to acquire a specific global queue priority in this extension?

RESOLVED: No. Whether a caller has enough privilege goes with the OS, and the Vulkan driver cannot really guarantee that the privilege will not change in between this query and the actual queue creation call.

2) If more than 1 queue using global priority is requested, is there a good way to know which queue is failing the device creation?

RESOLVED: No. There is not a good way at this moment, and it is also not quite actionable for the applications to know that because the information may not be accurate. Queue creation can fail because of runtime constraints like insufficient privilege or lack of resource, and the failure is not necessarily tied to that particular queue configuration requested.

Version History

• Revision 1, 2021-10-22 (Tobias Hector)

  • Initial draft

See Also

MAX_GLOBAL_PRIORITY_SIZE_KHR, DeviceQueueGlobalPriorityCreateInfoKHR, PhysicalDeviceGlobalPriorityQueryFeaturesKHR, QueueFamilyGlobalPriorityPropertiesKHR, QueueGlobalPriorityKHR

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.

Documentation

pattern QUEUE_GLOBAL_PRIORITY_LOW_EXT :: QueueGlobalPriorityKHR

pattern QUEUE_GLOBAL_PRIORITY_MEDIUM_EXT :: QueueGlobalPriorityKHR

pattern QUEUE_GLOBAL_PRIORITY_HIGH_EXT :: QueueGlobalPriorityKHR

pattern QUEUE_GLOBAL_PRIORITY_REALTIME_EXT :: QueueGlobalPriorityKHR

data DeviceQueueGlobalPriorityCreateInfoKHR

VkDeviceQueueGlobalPriorityCreateInfoKHR - Specify a system wide priority

Description

Queues created without specifying DeviceQueueGlobalPriorityCreateInfoKHR will default to QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR.

Valid Usage (Implicit)

See Also

VK_EXT_global_priority, VK_KHR_global_priority, QueueGlobalPriorityKHR, StructureType

Constructors

DeviceQueueGlobalPriorityCreateInfoKHR

Fields

• globalPriority :: QueueGlobalPriorityKHR

  globalPriority is the system-wide priority associated to these queues as specified by QueueGlobalPriorityEXT

  globalPriority must be a valid QueueGlobalPriorityKHR value

Instances

Storable DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: DeviceQueueGlobalPriorityCreateInfoKHR -> Int

alignment :: DeviceQueueGlobalPriorityCreateInfoKHR -> Int

peekElemOff :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> Int -> IO DeviceQueueGlobalPriorityCreateInfoKHR

pokeElemOff :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> Int -> DeviceQueueGlobalPriorityCreateInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO DeviceQueueGlobalPriorityCreateInfoKHR

pokeByteOff :: Ptr b -> Int -> DeviceQueueGlobalPriorityCreateInfoKHR -> IO ()

peek :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO DeviceQueueGlobalPriorityCreateInfoKHR

poke :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> IO ()

Show DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> DeviceQueueGlobalPriorityCreateInfoKHR -> ShowS

show :: DeviceQueueGlobalPriorityCreateInfoKHR -> String

showList :: [DeviceQueueGlobalPriorityCreateInfoKHR] -> ShowS

Eq DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

(==) :: DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> Bool

(/=) :: DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> Bool

FromCStruct DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

peekCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO DeviceQueueGlobalPriorityCreateInfoKHR

ToCStruct DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

withCStruct :: DeviceQueueGlobalPriorityCreateInfoKHR -> (Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> DeviceQueueGlobalPriorityCreateInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr DeviceQueueGlobalPriorityCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceQueueGlobalPriorityCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: DeviceQueueGlobalPriorityCreateInfoKHR

data PhysicalDeviceGlobalPriorityQueryFeaturesKHR

VkPhysicalDeviceGlobalPriorityQueryFeaturesKHR - Structure describing whether global priority query can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceGlobalPriorityQueryFeaturesKHR 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. PhysicalDeviceGlobalPriorityQueryFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_global_priority, Bool32, StructureType

Constructors

PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Fields

• globalPriorityQuery :: Bool

  globalPriorityQuery indicates whether the implementation supports the ability to query global queue priorities.

Instances

Storable PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Int

alignment :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Int -> IO PhysicalDeviceGlobalPriorityQueryFeaturesKHR

pokeElemOff :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Int -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceGlobalPriorityQueryFeaturesKHR

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO ()

peek :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO PhysicalDeviceGlobalPriorityQueryFeaturesKHR

poke :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO ()

Show PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> ShowS

show :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> String

showList :: [PhysicalDeviceGlobalPriorityQueryFeaturesKHR] -> ShowS

Eq PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

(==) :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Bool

(/=) :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> Bool

FromCStruct PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

peekCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO PhysicalDeviceGlobalPriorityQueryFeaturesKHR

ToCStruct PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

withCStruct :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> (Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceGlobalPriorityQueryFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceGlobalPriorityQueryFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: PhysicalDeviceGlobalPriorityQueryFeaturesKHR

data QueueFamilyGlobalPriorityPropertiesKHR

VkQueueFamilyGlobalPriorityPropertiesKHR - Return structure for queue family global priority information query

Description

If the QueueFamilyGlobalPriorityPropertiesKHR structure is included in the pNext chain of the QueueFamilyProperties2 structure passed to getPhysicalDeviceQueueFamilyProperties2, it is filled in with the list of supported global queue priorities for the indicated family.

The valid elements of priorities must not contain any duplicate values.

The valid elements of priorities must be a continuous sequence of QueueGlobalPriorityKHR enums in the ascending order.

Note

For example, returning priorityCount as 3 with supported priorities as QUEUE_GLOBAL_PRIORITY_LOW_KHR, QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR and QUEUE_GLOBAL_PRIORITY_REALTIME_KHR is not allowed.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUEUE_FAMILY_GLOBAL_PRIORITY_PROPERTIES_KHR

• Any given element of priorities must be a valid QueueGlobalPriorityKHR value

See Also

VK_KHR_global_priority, QueueGlobalPriorityKHR, StructureType

Constructors

QueueFamilyGlobalPriorityPropertiesKHR

Fields

• priorityCount :: Word32

  priorityCount is the number of supported global queue priorities in this queue family, and it must be greater than 0.

• priorities :: Vector QueueGlobalPriorityKHR

  priorities is an array of MAX_GLOBAL_PRIORITY_SIZE_EXT QueueGlobalPriorityEXT enums representing all supported global queue priorities in this queue family. The first priorityCount elements of the array will be valid.

Instances

Storable QueueFamilyGlobalPriorityPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: QueueFamilyGlobalPriorityPropertiesKHR -> Int

alignment :: QueueFamilyGlobalPriorityPropertiesKHR -> Int

peekElemOff :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> Int -> IO QueueFamilyGlobalPriorityPropertiesKHR

pokeElemOff :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> Int -> QueueFamilyGlobalPriorityPropertiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueueFamilyGlobalPriorityPropertiesKHR

pokeByteOff :: Ptr b -> Int -> QueueFamilyGlobalPriorityPropertiesKHR -> IO ()

peek :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> IO QueueFamilyGlobalPriorityPropertiesKHR

poke :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> QueueFamilyGlobalPriorityPropertiesKHR -> IO ()

Show QueueFamilyGlobalPriorityPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> QueueFamilyGlobalPriorityPropertiesKHR -> ShowS

show :: QueueFamilyGlobalPriorityPropertiesKHR -> String

showList :: [QueueFamilyGlobalPriorityPropertiesKHR] -> ShowS

FromCStruct QueueFamilyGlobalPriorityPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

peekCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> IO QueueFamilyGlobalPriorityPropertiesKHR

ToCStruct QueueFamilyGlobalPriorityPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

withCStruct :: QueueFamilyGlobalPriorityPropertiesKHR -> (Ptr QueueFamilyGlobalPriorityPropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> QueueFamilyGlobalPriorityPropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr QueueFamilyGlobalPriorityPropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr QueueFamilyGlobalPriorityPropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero QueueFamilyGlobalPriorityPropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: QueueFamilyGlobalPriorityPropertiesKHR

newtype QueueGlobalPriorityKHR

VkQueueGlobalPriorityKHR - Values specifying a system-wide queue priority

Description

Priority values are sorted in ascending order. A comparison operation on the enum values can be used to determine the priority order.

See Also

VK_EXT_global_priority, VK_KHR_global_priority, DeviceQueueGlobalPriorityCreateInfoKHR, QueueFamilyGlobalPriorityPropertiesKHR

Constructors

QueueGlobalPriorityKHR Int32

Bundled Patterns

pattern QUEUE_GLOBAL_PRIORITY_LOW_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_LOW_KHR is below the system default. Useful for non-interactive tasks.

pattern QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_MEDIUM_KHR is the system default priority.

pattern QUEUE_GLOBAL_PRIORITY_HIGH_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_HIGH_KHR is above the system default.

pattern QUEUE_GLOBAL_PRIORITY_REALTIME_KHR :: QueueGlobalPriorityKHR

QUEUE_GLOBAL_PRIORITY_REALTIME_KHR is the highest priority. Useful for critical tasks.

Instances

Storable QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

sizeOf :: QueueGlobalPriorityKHR -> Int

alignment :: QueueGlobalPriorityKHR -> Int

peekElemOff :: Ptr QueueGlobalPriorityKHR -> Int -> IO QueueGlobalPriorityKHR

pokeElemOff :: Ptr QueueGlobalPriorityKHR -> Int -> QueueGlobalPriorityKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO QueueGlobalPriorityKHR

pokeByteOff :: Ptr b -> Int -> QueueGlobalPriorityKHR -> IO ()

peek :: Ptr QueueGlobalPriorityKHR -> IO QueueGlobalPriorityKHR

poke :: Ptr QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> IO ()

Read QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

readsPrec :: Int -> ReadS QueueGlobalPriorityKHR

readList :: ReadS [QueueGlobalPriorityKHR]

readPrec :: ReadPrec QueueGlobalPriorityKHR

readListPrec :: ReadPrec [QueueGlobalPriorityKHR]

Show QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

showsPrec :: Int -> QueueGlobalPriorityKHR -> ShowS

show :: QueueGlobalPriorityKHR -> String

showList :: [QueueGlobalPriorityKHR] -> ShowS

Eq QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

(==) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

(/=) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

Ord QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

compare :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Ordering

(<) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

(<=) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

(>) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

(>=) :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> Bool

max :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR

min :: QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR -> QueueGlobalPriorityKHR

Zero QueueGlobalPriorityKHR

Defined in Vulkan.Extensions.VK_KHR_global_priority

Methods

zero :: QueueGlobalPriorityKHR

type KHR_GLOBAL_PRIORITY_SPEC_VERSION = 1

pattern KHR_GLOBAL_PRIORITY_SPEC_VERSION :: forall a. Integral a => a

type KHR_GLOBAL_PRIORITY_EXTENSION_NAME = "VK_KHR_global_priority"

pattern KHR_GLOBAL_PRIORITY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type MAX_GLOBAL_PRIORITY_SIZE_KHR = 16

pattern MAX_GLOBAL_PRIORITY_SIZE_KHR :: forall a. Integral a => a

VK_MAX_GLOBAL_PRIORITY_SIZE_KHR - Length of an array of global queue priorities

See Also

VK_KHR_global_priority