Vulkan.Extensions.VK_EXT_validation_cache

vkCreateValidationCacheEXT - Creates a new validation cache

Description

Applications can track and manage the total host memory size of a validation cache object using the pAllocator. Applications can limit the amount of data retrieved from a validation cache object in getValidationCacheDataEXT. Implementations should not internally limit the total number of entries added to a validation cache object or the total host memory consumed.

Once created, a validation cache can be passed to the createShaderModule command by adding this object to the ShaderModuleCreateInfo structure’s pNext chain. If a ShaderModuleValidationCacheCreateInfoEXT object is included in the ShaderModuleCreateInfo::pNext chain, and its validationCache field is not NULL_HANDLE, the implementation will query it for possible reuse opportunities and update it with new content. The use of the validation cache object in these commands is internally synchronized, and the same validation cache object can be used in multiple threads simultaneously.

Implementations should make every effort to limit any critical sections to the actual accesses to the cache, which is expected to be significantly shorter than the duration of the createShaderModule command.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid ValidationCacheCreateInfoEXT structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pValidationCache must be a valid pointer to a ValidationCacheEXT handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_validation_cache, AllocationCallbacks, Device, ValidationCacheCreateInfoEXT, ValidationCacheEXT

A convenience wrapper to make a compatible pair of calls to createValidationCacheEXT and destroyValidationCacheEXT

To ensure that destroyValidationCacheEXT is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyValidationCacheEXT - Destroy a validation cache object

Valid Usage

• If AllocationCallbacks were provided when validationCache was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when validationCache was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If validationCache is not NULL_HANDLE, validationCache must be a valid ValidationCacheEXT handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• If validationCache is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to validationCache must be externally synchronized

See Also

VK_EXT_validation_cache, AllocationCallbacks, Device, ValidationCacheEXT

vkGetValidationCacheDataEXT - Get the data store from a validation cache

Description

If pData is NULL, then the maximum size of the data that can be retrieved from the validation cache, in bytes, is returned in pDataSize. Otherwise, pDataSize must point to a variable set by the application to the size of the buffer, in bytes, pointed to by pData, and on return the variable is overwritten with the amount of data actually written to pData. If pDataSize is less than the maximum size that can be retrieved by the validation cache, at most pDataSize bytes will be written to pData, and getValidationCacheDataEXT will return INCOMPLETE instead of SUCCESS, to indicate that not all of the validation cache was returned.

Any data written to pData is valid and can be provided as the pInitialData member of the ValidationCacheCreateInfoEXT structure passed to createValidationCacheEXT.

Two calls to getValidationCacheDataEXT with the same parameters must retrieve the same data unless a command that modifies the contents of the cache is called between them.

Applications can store the data retrieved from the validation cache, and use these data, possibly in a future run of the application, to populate new validation cache objects. The results of validation, however, may depend on the vendor ID, device ID, driver version, and other details of the device. To enable applications to detect when previously retrieved data is incompatible with the device, the initial bytes written to pData must be a header consisting of the following members:

Layout for Validation Cache Header Version VALIDATION_CACHE_HEADER_VERSION_ONE_EXT

The first four bytes encode the length of the entire validation cache header, in bytes. This value includes all fields in the header including the validation cache version field and the size of the length field.

The next four bytes encode the validation cache version, as described for ValidationCacheHeaderVersionEXT. A consumer of the validation cache should use the cache version to interpret the remainder of the cache header.

If pDataSize is less than what is necessary to store this header, nothing will be written to pData and zero will be written to pDataSize.

This query does not behave consistently with the behavior described in Opaque Binary Data Results, for historical reasons.

If the amount of data available is larger than the passed pDataSize, the query returns up to the size of the passed buffer, and signals overflow with a INCOMPLETE success status instead of returning a ERROR_NOT_ENOUGH_SPACE_KHR error status.

Valid Usage (Implicit)

• device must be a valid Device handle

• validationCache must be a valid ValidationCacheEXT handle

• pDataSize must be a valid pointer to a size_t value

• If the value referenced by pDataSize is not 0, and pData is not NULL, pData must be a valid pointer to an array of pDataSize bytes

• validationCache must have been created, allocated, or retrieved from device

Return Codes

Success

• INCOMPLETE

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_validation_cache, Device, ValidationCacheEXT

vkMergeValidationCachesEXT - Combine the data stores of validation caches

Description

The details of the merge operation are implementation-dependent, but implementations should merge the contents of the specified validation caches and prune duplicate entries.

Valid Usage

• dstCache must not appear in the list of source caches

Valid Usage (Implicit)

• device must be a valid Device handle

• dstCache must be a valid ValidationCacheEXT handle

• pSrcCaches must be a valid pointer to an array of srcCacheCount valid ValidationCacheEXT handles

• srcCacheCount must be greater than 0

• dstCache must have been created, allocated, or retrieved from device

• Each element of pSrcCaches must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to dstCache must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_EXT_validation_cache, Device, ValidationCacheEXT

VkValidationCacheCreateInfoEXT - Structure specifying parameters of a newly created validation cache

Valid Usage

• If initialDataSize is not 0, it must be equal to the size of pInitialData, as returned by getValidationCacheDataEXT when pInitialData was originally retrieved

• If initialDataSize is not 0, pInitialData must have been retrieved from a previous call to getValidationCacheDataEXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT

• pNext must be NULL

• flags must be 0

• If initialDataSize is not 0, pInitialData must be a valid pointer to an array of initialDataSize bytes

See Also

VK_EXT_validation_cache, StructureType, ValidationCacheCreateFlagsEXT, createValidationCacheEXT

VkShaderModuleValidationCacheCreateInfoEXT - Specify validation cache to use during shader module creation

Structure Chaining

Extends the structures

• PipelineShaderStageCreateInfo

• ShaderModuleCreateInfo

See Also

VK_EXT_validation_cache, StructureType, ValidationCacheEXT

VkValidationCacheCreateFlagsEXT - Reserved for future use

Description

ValidationCacheCreateFlagsEXT is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_EXT_validation_cache, Flags, ValidationCacheCreateInfoEXT

VkValidationCacheHeaderVersionEXT - Encode validation cache version

Description

• VALIDATION_CACHE_HEADER_VERSION_ONE_EXT specifies version one of the validation cache.

See Also

VK_EXT_validation_cache, createValidationCacheEXT, getValidationCacheDataEXT

VkValidationCacheEXT - Opaque handle to a validation cache object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_EXT_validation_cache, ShaderModuleValidationCacheCreateInfoEXT, createValidationCacheEXT, destroyValidationCacheEXT, getValidationCacheDataEXT, mergeValidationCachesEXT