Vulkan.Extensions.VK_EXT_device_fault

vkGetDeviceFaultInfoEXT - Reports fault information for the specified device

Description

If pFaultInfo is NULL, then the counts of corresponding additional fault information structures available are returned in the addressInfoCount and vendorInfoCount members of pFaultCounts. Additionally, the size of any vendor-specific binary crash dump is returned in the vendorBinarySize member of pFaultCounts.

If pFaultInfo is not NULL, pFaultCounts must point to a DeviceFaultCountsEXT structure with each structure count or size member (addressInfoCount, vendorInfoCount, vendorBinarySize) set by the application to the number of elements in the corresponding output array member of pFaultInfo (pAddressInfos and pVendorInfos), or to the size of the output buffer in bytes (pVendorBinaryData). On return, each structure count member is overwritten with the number of structures actually written to the corresponding output array member of pFaultInfo. Similarly, vendorBinarySize is overwritten with the number of bytes actually written to the pVendorBinaryData member of pFaultInfo.

If the vendor-specific crash dumps feature is not enabled, then implementations must set pFaultCounts->vendorBinarySize to zero and must not modify pFaultInfo->pVendorBinaryData.

If any pFaultCounts structure count member is less than the number of corresponding fault properties available, at most structure count (addressInfoCount, vendorInfoCount) elements will be written to the associated pFaultInfo output array. Similarly, if vendorBinarySize is less than the size in bytes of the available crash dump data, at most vendorBinarySize elements will be written to pVendorBinaryData.

If pFaultInfo is NULL, then subsequent calls to getDeviceFaultInfoEXT for the same device must return identical values in the addressInfoCount, vendorInfoCount and vendorBinarySize members of pFaultCounts.

If pFaultInfo is not NULL, then subsequent calls to getDeviceFaultInfoEXT for the same device must return identical values in the output members of pFaultInfo (pAddressInfos, pVendorInfos, pVendorBinaryData), up to the limits described by the structure count and buffer size members of pFaultCounts (addressInfoCount, vendorInfoCount, vendorBinarySize). If the sizes of the output members of pFaultInfo increase for a subsequent call to getDeviceFaultInfoEXT, then supplementary information may be returned in the additional available space.

If any pFaultCounts structure count member is smaller than the number of corresponding fault properties available, or if pFaultCounts->vendorBinarySize is smaller than the size in bytes of the generated binary crash dump data, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

If pFaultCounts->vendorBinarySize is less than what is necessary to store the binary crash dump header, nothing will be written to pFaultInfo->pVendorBinaryData and zero will be written to pFaultCounts->vendorBinarySize.

Valid Usage

• device must be in the lost state

• If the value referenced by pFaultCounts->addressInfoCount is not 0, and pFaultInfo->pAddressInfos is not NULL, pFaultInfo->pAddressInfos must be a valid pointer to an array of pFaultCounts->addressInfoCount DeviceFaultAddressInfoEXT structures

• If the value referenced by pFaultCounts->vendorInfoCount is not 0, and pFaultInfo->pVendorInfos is not NULL, pFaultInfo->pVendorInfos must be a valid pointer to an array of pFaultCounts->vendorInfoCount DeviceFaultVendorInfoEXT structures

• If the value referenced by pFaultCounts->vendorBinarySize is not 0, and pFaultInfo->pVendorBinaryData is not NULL, pFaultInfo->pVendorBinaryData must be a valid pointer to an array of pFaultCounts->vendorBinarySize bytes

Valid Usage (Implicit)

• device must be a valid Device handle

• pFaultCounts must be a valid pointer to a DeviceFaultCountsEXT structure

• If pFaultInfo is not NULL, pFaultInfo must be a valid pointer to a DeviceFaultInfoEXT structure

Return Codes

Success

• INCOMPLETE

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_device_fault, Device, DeviceFaultCountsEXT, DeviceFaultInfoEXT

VkPhysicalDeviceFaultFeaturesEXT - Structure indicating support for device fault reporting

Members

This structure describes the following features:

Description

If the PhysicalDeviceFaultFeaturesEXT 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 PhysicalDeviceFaultFeaturesEXT, 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

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_EXT_device_fault, Bool32, StructureType

VkDeviceFaultCountsEXT - Structure specifying device fault information

Valid Usage (Implicit)

See Also

VK_EXT_device_fault, DeviceSize, StructureType, getDeviceFaultInfoEXT

VkDeviceFaultInfoEXT - Structure specifying device fault information

Description

An implementation should populate as many members of DeviceFaultInfoEXT as possible, given the information available at the time of the fault and the constraints of the implementation itself.

Due to hardware limitations, pAddressInfos describes ranges of GPU virtual address space, rather than precise addresses. The precise memory address accessed or the precise value of the instruction pointer must lie within the region described.

Each element of pAddressInfos describes either:

• A memory access which may have triggered a page fault and may have contributed to device loss

• The value of an active instruction pointer at the time a fault occurred. This value may be indicative of the active pipeline or shader at the time of device loss

Comparison of the GPU virtual addresses described by pAddressInfos to GPU virtual address ranges reported by the VK_EXT_device_address_binding_report extension may allow applications to correlate between these addresses and Vulkan objects. Applications should be aware that these addresses may also correspond to resources internal to an implementation, which will not be reported via the VK_EXT_device_address_binding_report extension.

Valid Usage (Implicit)

See Also

VK_EXT_device_fault, DeviceFaultAddressInfoKHR, DeviceFaultVendorInfoKHR, StructureType, getDeviceFaultInfoEXT

VkDeviceFaultAddressInfoKHR - Structure specifying GPU virtual address information

Description

The combination of reportedAddress and addressPrecision allow the possible range of addresses to be calculated, such that:

lower_address = (pInfo->reportedAddress & ~(pInfo->addressPrecision-1))
upper_address = (pInfo->reportedAddress |  (pInfo->addressPrecision-1))

It is valid for the reportedAddress to contain a more precise address than indicated by addressPrecision. In this case, the value of reportedAddress should be treated as an additional hint as to the value of the address that triggered the page fault, or to the value of an instruction pointer.

See Also

VK_EXT_device_fault, VK_KHR_device_fault, DeviceAddress, DeviceFaultAddressTypeKHR, DeviceFaultInfoEXT, DeviceFaultInfoKHR, DeviceSize

VkDeviceFaultVendorInfoKHR - Structure specifying vendor-specific fault information

See Also

VK_EXT_device_fault, VK_KHR_device_fault, DeviceFaultInfoEXT, DeviceFaultInfoKHR

VkDeviceFaultVendorBinaryHeaderVersionOneKHR - Structure describing the layout of the vendor binary crash dump header

Description

Unlike most structures declared by the Vulkan API, all fields of this structure are written with the least significant byte first, regardless of host byte-order.

The C language specification does not define the packing of structure members. This layout assumes tight structure member packing, with members laid out in the order listed in the structure, and the intended size of the structure is 56 bytes. If a compiler produces code that diverges from that pattern, applications must employ another method to set values at the correct offsets.

Valid Usage (Implicit)

See Also

VK_EXT_device_fault, VK_KHR_device_fault, DeviceFaultVendorBinaryHeaderVersionKHR

VkDeviceFaultAddressTypeKHR - Page fault access types

Description

• DEVICE_FAULT_ADDRESS_TYPE_NONE_KHR specifies that DeviceFaultAddressInfoKHR does not describe a page fault, or an instruction address.

• DEVICE_FAULT_ADDRESS_TYPE_READ_INVALID_KHR specifies that DeviceFaultAddressInfoKHR describes a page fault triggered by an invalid read operation.

• DEVICE_FAULT_ADDRESS_TYPE_WRITE_INVALID_KHR specifies that DeviceFaultAddressInfoKHR describes a page fault triggered by an invalid write operation.

• DEVICE_FAULT_ADDRESS_TYPE_EXECUTE_INVALID_KHR specifies that DeviceFaultAddressInfoKHR describes a page fault triggered by an attempt to execute non-executable memory.

• DEVICE_FAULT_ADDRESS_TYPE_INSTRUCTION_POINTER_UNKNOWN_KHR specifies an instruction pointer value at the time the fault occurred. This may or may not be related to a fault.

• DEVICE_FAULT_ADDRESS_TYPE_INSTRUCTION_POINTER_INVALID_KHR specifies an instruction pointer value associated with an invalid instruction fault.

• DEVICE_FAULT_ADDRESS_TYPE_INSTRUCTION_POINTER_FAULT_KHR specifies an instruction pointer value associated with a fault.

The instruction pointer values recorded may not identify the specific instruction(s) that triggered the fault. The relationship between the instruction pointer reported and triggering instruction will be vendor-specific.

See Also

VK_EXT_device_fault, VK_KHR_device_fault, DeviceFaultAddressInfoKHR

VkDeviceFaultVendorBinaryHeaderVersionKHR - Encode vendor binary crash dump version

Description

• DEVICE_FAULT_VENDOR_BINARY_HEADER_VERSION_ONE_KHR specifies version one of the binary crash dump header.

See Also

VK_EXT_device_fault, VK_KHR_device_fault, DeviceFaultVendorBinaryHeaderVersionOneKHR, getDeviceFaultInfoEXT