Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Name

VK_NV_device_diagnostic_checkpoints - device extension

VK_NV_device_diagnostic_checkpoints

Name String

VK_NV_device_diagnostic_checkpoints

Extension Type

Device extension

Registered Extension Number

207

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2 to be enabled for any device-level functionality

Contact

• Nuno Subtil @nsubtil%0A*Here describe the issue or question you have about the VK_NV_device_diagnostic_checkpoints extension*

Other Extension Metadata

Last Modified Date

2018-07-16

Contributors

• Oleg Kuznetsov, NVIDIA
• Alex Dunn, NVIDIA
• Jeff Bolz, NVIDIA
• Eric Werness, NVIDIA
• Daniel Koch, NVIDIA

Description

This extension allows applications to insert markers in the command stream and associate them with custom data.

If a device lost error occurs, the application may then query the implementation for the last markers to cross specific implementation-defined pipeline stages, in order to narrow down which commands were executing at the time and might have caused the failure.

New Commands

• cmdSetCheckpointNV

• getQueueCheckpointDataNV

New Structures

• CheckpointDataNV

• Extending QueueFamilyProperties2:

  • QueueFamilyCheckpointPropertiesNV

New Enum Constants

• NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME

• NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_CHECKPOINT_DATA_NV
  • STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV

Version History

• Revision 1, 2018-07-16 (Nuno Subtil)

  • Internal revisions

• Revision 2, 2018-07-16 (Nuno Subtil)

  • ???

See Also

CheckpointDataNV, QueueFamilyCheckpointPropertiesNV, cmdSetCheckpointNV, getQueueCheckpointDataNV

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

cmdSetCheckpointNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer that will receive the marker

-> ("checkpointMarker" ::: Ptr ())

pCheckpointMarker is an opaque application-provided value that will be associated with the checkpoint.

-> io ()

vkCmdSetCheckpointNV - Insert diagnostic checkpoint in command stream

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, compute, or transfer operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Both	Outside	Graphics Compute Transfer	Action

See Also

VK_NV_device_diagnostic_checkpoints, CommandBuffer

getQueueCheckpointDataNV

Arguments

:: forall io. MonadIO io

=> Queue

queue is the Queue object the caller would like to retrieve checkpoint data for

-> io ("checkpointData" ::: Vector CheckpointDataNV)

vkGetQueueCheckpointDataNV - Retrieve diagnostic checkpoint data

Description

If pCheckpointData is NULL, then the number of checkpoint markers available is returned in pCheckpointDataCount.

Otherwise, pCheckpointDataCount must point to a variable set by the user to the number of elements in the pCheckpointData array, and on return the variable is overwritten with the number of structures actually written to pCheckpointData.

If pCheckpointDataCount is less than the number of checkpoint markers available, at most pCheckpointDataCount structures will be written.

Valid Usage

• The device that queue belongs to must be in the lost state

Valid Usage (Implicit)

• queue must be a valid Queue handle

• pCheckpointDataCount must be a valid pointer to a uint32_t value
• If the value referenced by pCheckpointDataCount is not 0, and pCheckpointData is not NULL, pCheckpointData must be a valid pointer to an array of pCheckpointDataCount CheckpointDataNV structures

See Also

VK_NV_device_diagnostic_checkpoints, CheckpointDataNV, Queue

data QueueFamilyCheckpointPropertiesNV

VkQueueFamilyCheckpointPropertiesNV - Return structure for queue family checkpoint information query

Description

Additional queue family information can be queried by setting QueueFamilyProperties2::pNext to point to a QueueFamilyCheckpointPropertiesNV structure.

Valid Usage (Implicit)

See Also

VK_NV_device_diagnostic_checkpoints, PipelineStageFlags, StructureType

Constructors

QueueFamilyCheckpointPropertiesNV

Fields

• checkpointExecutionStageMask :: PipelineStageFlags

  checkpointExecutionStageMask is a mask indicating which pipeline stages the implementation can execute checkpoint markers in.

Instances

Eq QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

(==) :: QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> Bool

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

Show QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

showsPrec :: Int -> QueueFamilyCheckpointPropertiesNV -> ShowS

show :: QueueFamilyCheckpointPropertiesNV -> String

showList :: [QueueFamilyCheckpointPropertiesNV] -> ShowS

Storable QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

sizeOf :: QueueFamilyCheckpointPropertiesNV -> Int

alignment :: QueueFamilyCheckpointPropertiesNV -> Int

peekElemOff :: Ptr QueueFamilyCheckpointPropertiesNV -> Int -> IO QueueFamilyCheckpointPropertiesNV

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

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

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

peek :: Ptr QueueFamilyCheckpointPropertiesNV -> IO QueueFamilyCheckpointPropertiesNV

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

FromCStruct QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

peekCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> IO QueueFamilyCheckpointPropertiesNV

ToCStruct QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

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

pokeCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> QueueFamilyCheckpointPropertiesNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr QueueFamilyCheckpointPropertiesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero QueueFamilyCheckpointPropertiesNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

zero :: QueueFamilyCheckpointPropertiesNV

data CheckpointDataNV

VkCheckpointDataNV - Return structure for command buffer checkpoint data

Description

The stages at which a checkpoint marker can be executed are implementation-defined and can be queried by calling getPhysicalDeviceQueueFamilyProperties2.

Valid Usage (Implicit)

See Also

VK_NV_device_diagnostic_checkpoints, PipelineStageFlagBits, StructureType, getQueueCheckpointDataNV

Constructors

CheckpointDataNV

Fields

• stage :: PipelineStageFlagBits

  stage is a PipelineStageFlagBits value specifying which pipeline stage the checkpoint marker data refers to.

• checkpointMarker :: Ptr ()

  pCheckpointMarker contains the value of the last checkpoint marker executed in the stage that stage refers to.

Instances

Show CheckpointDataNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

showsPrec :: Int -> CheckpointDataNV -> ShowS

show :: CheckpointDataNV -> String

showList :: [CheckpointDataNV] -> ShowS

Storable CheckpointDataNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

sizeOf :: CheckpointDataNV -> Int

alignment :: CheckpointDataNV -> Int

peekElemOff :: Ptr CheckpointDataNV -> Int -> IO CheckpointDataNV

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

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

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

peek :: Ptr CheckpointDataNV -> IO CheckpointDataNV

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

FromCStruct CheckpointDataNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

peekCStruct :: Ptr CheckpointDataNV -> IO CheckpointDataNV

ToCStruct CheckpointDataNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

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

pokeCStruct :: Ptr CheckpointDataNV -> CheckpointDataNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CheckpointDataNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CheckpointDataNV

Defined in Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints

Methods

zero :: CheckpointDataNV

type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2

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

type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints"

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