VK_LAYER_KHRONOS_validation

Vulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside a Vulkan driver - applications have full control and responsibility for correct operation. Any errors in Vulkan usage can result in unexpected behavior or even a crash. The VK_LAYER_KHRONOS_validation layer can be used to to assist developers in isolating incorrect usage, and in verifying that applications correctly use the API.

Configuring the Validation Layer

There are 4 ways to configure the settings: Vulkan Configurator, application defined, vk_layer_settings.txt, environment variables as described in the layers configuration documentation and described in the Configuring Vulkan Layers whitepaper.

Vulkan Configurator

We suggest people to use Vulkan Configurator.

The GUI comes with the SDK, and takes the VkLayer_khronos_validation.json file and does everything for you!

Application Defined

The application can now use the VK_EXT_layer_settings extension to do everything at vkCreateInstance time. (Don't worry, we implement the extension, so it will be supported 100% of the time!).

// Example how to turn on verbose mode for DebugPrintf
const VkBool32 verbose_value = true;
const VkLayerSettingEXT layer_setting = {"VK_LAYER_KHRONOS_validation", "printf_verbose", VK_LAYER_SETTING_TYPE_BOOL32_EXT, 1, &verbose_value};
VkLayerSettingsCreateInfoEXT layer_settings_create_info = {VK_STRUCTURE_TYPE_LAYER_SETTINGS_CREATE_INFO_EXT, nullptr, 1, &layer_setting};

VkInstanceCreateInfo instance_ci = GetYourCreateInfo();
instance_ci.pNext = &layer_settings_create_info;

vk_layer_settings.txt

There is info elsewhere to describe this file, but the short answer is to set the VK_LAYER_SETTINGS_PATH like the following:

# windows
set VK_LAYER_SETTINGS_PATH=C:\path\to\vk_layer_settings.txt

# linux
export VK_LAYER_SETTINGS_PATH=/path/to/vk_layer_settings.txt

and it will set things for you in that file. We have a default example file you can start with.

Environment Variables

This is done for us via the vkuCreateLayerSettingSet call in the Vulkan-Utility-Libraries.

As an example, in our VkLayer_khronos_validation.json file you will find something like "key": "message_id_filter",.

From here you just need to adjust it the naming and prefix depending on your platform:

# Windows
set VK_LAYER_MESSAGE_ID_FILTER=VUID-VkInstanceCreateInfo-pNext-pNext

# Linux
export VK_LAYER_MESSAGE_ID_FILTER=VUID-VkInstanceCreateInfo-pNext-pNext

# Android
adb setprop debug.vulkan.khronos_validation.message_id_filter=VUID-VkInstanceCreateInfo-pNext-pNext

Layer Settings

We suggest using Vulkan Configurator to discover the layer settings, but the following is generated per SDK version

The settings for this layer are specified in VkLayer_khronos_validation.json. The settings details are in khronos_validation_layer.html.

Layer Properties

• API Version: 1.4.321
• Implementation Version: 1
• Layer Manifest: VkLayer_khronos_validation.json
  • File Format: 1.2.0
  • Layer Binary: libVkLayer_khronos_validation.so
• Variables:
  • vk_layer_settings.txt namespace: khronos_validation
  • Environment Variable prefix: VK_KHRONOS_VALIDATION_
  • Android system property prefix: adb setprop debug.vulkan.khronos_validation.
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID
• Number of Layer Settings: 65
• Number of Layer Presets: 6

Layer Settings Overview

Layer Settings Details

Validation Areas

Control of the Validation layer validation.

Sub-settings: Fine Grained Locking, Core, Handle Wrapping, Object Lifetime, Stateless Parameter, Thread Safety, Synchronization, Debug Printf only preset, Debug Printf, GPU Assisted Validation, and Best Practices.

• Key: validation_control
• Type: GROUP
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

Fine Grained Locking

Enable fine grained locking for Core Validation, which should improve performance in multithreaded applications. This setting allows the optimization to be disabled for debugging.

Learn more about the Fine Grained Locking setting.

• Key: fine_grained_locking
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "fine_grained_locking", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.fine_grained_locking = true

export VK_KHRONOS_VALIDATION_FINE_GRAINED_LOCKING=true
export VK_VALIDATION_FINE_GRAINED_LOCKING=true
export VK_FINE_GRAINED_LOCKING=true
export VK_LAYER_FINE_GRAINED_LOCKING=true

adb setprop debug.vulkan.khronos_validation.fine_grained_locking true
adb setprop debug.vulkan.validation.fine_grained_locking true
adb setprop debug.vulkan.fine_grained_locking true
adb setprop debug.vvl.fine_grained_locking true

Core

The main, heavy-duty validation checks. This may be valuable early in the development cycle to reduce validation output while correcting parameter/object usage errors.

Learn more about the Core setting.

Sub-settings: Image Layout, Command Buffer State, Object in Use, Query, and Shader.

• Key: validate_core
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_core", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_core = true

export VK_KHRONOS_VALIDATION_VALIDATE_CORE=true
export VK_VALIDATION_VALIDATE_CORE=true
export VK_VALIDATE_CORE=true

adb setprop debug.vulkan.khronos_validation.validate_core true
adb setprop debug.vulkan.validation.validate_core true
adb setprop debug.vulkan.validate_core true
adb setprop debug.vvl.validate_core true

Image Layout

Check that the layout of each image subresource is correct whenever it is used by a command buffer. These checks are very CPU intensive for some applications.

• Key: check_image_layout
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_image_layout", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_image_layout = true

export VK_KHRONOS_VALIDATION_CHECK_IMAGE_LAYOUT=true
export VK_VALIDATION_CHECK_IMAGE_LAYOUT=true
export VK_CHECK_IMAGE_LAYOUT=true

adb setprop debug.vulkan.khronos_validation.check_image_layout true
adb setprop debug.vulkan.validation.check_image_layout true
adb setprop debug.vulkan.check_image_layout true
adb setprop debug.vvl.check_image_layout true

Command Buffer State

Check that all Vulkan objects used by a command buffer have not been destroyed. These checks can be CPU intensive for some applications.

• Key: check_command_buffer
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_command_buffer", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_command_buffer = true

export VK_KHRONOS_VALIDATION_CHECK_COMMAND_BUFFER=true
export VK_VALIDATION_CHECK_COMMAND_BUFFER=true
export VK_CHECK_COMMAND_BUFFER=true

adb setprop debug.vulkan.khronos_validation.check_command_buffer true
adb setprop debug.vulkan.validation.check_command_buffer true
adb setprop debug.vulkan.check_command_buffer true
adb setprop debug.vvl.check_command_buffer true

Object in Use

Check that Vulkan objects are not in use by a command buffer when they are destroyed.

• Key: check_object_in_use
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_object_in_use", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_object_in_use = true

export VK_KHRONOS_VALIDATION_CHECK_OBJECT_IN_USE=true
export VK_VALIDATION_CHECK_OBJECT_IN_USE=true
export VK_CHECK_OBJECT_IN_USE=true

adb setprop debug.vulkan.khronos_validation.check_object_in_use true
adb setprop debug.vulkan.validation.check_object_in_use true
adb setprop debug.vulkan.check_object_in_use true
adb setprop debug.vvl.check_object_in_use true

Query

Checks for commands that use VkQueryPool objects.

• Key: check_query
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_query", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_query = true

export VK_KHRONOS_VALIDATION_CHECK_QUERY=true
export VK_VALIDATION_CHECK_QUERY=true
export VK_CHECK_QUERY=true

adb setprop debug.vulkan.khronos_validation.check_query true
adb setprop debug.vulkan.validation.check_query true
adb setprop debug.vulkan.check_query true
adb setprop debug.vvl.check_query true

Shader

This will validate the contents of the SPIR-V which can be CPU intensive during application start up. This does internal checks as well as calling spirv-val.

Sub-settings: Caching, and Disable spirv-val.

• Key: check_shaders
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_shaders", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_shaders = true

export VK_KHRONOS_VALIDATION_CHECK_SHADERS=true
export VK_VALIDATION_CHECK_SHADERS=true
export VK_CHECK_SHADERS=true

adb setprop debug.vulkan.khronos_validation.check_shaders true
adb setprop debug.vulkan.validation.check_shaders true
adb setprop debug.vulkan.check_shaders true
adb setprop debug.vvl.check_shaders true

Caching

Creates an internal instance of VK_EXT_validation_cache and upon vkDestroyInstance, will cache the shader validation so sequential usage of the validation layers will be skipped.

All the following condition must be fulfilled for the setting to be applied.

• Key: check_shaders_caching
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "check_shaders_caching", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.check_shaders_caching = true

export VK_KHRONOS_VALIDATION_CHECK_SHADERS_CACHING=true
export VK_VALIDATION_CHECK_SHADERS_CACHING=true
export VK_CHECK_SHADERS_CACHING=true

adb setprop debug.vulkan.khronos_validation.check_shaders_caching true
adb setprop debug.vulkan.validation.check_shaders_caching true
adb setprop debug.vulkan.check_shaders_caching true
adb setprop debug.vvl.check_shaders_caching true

Handle Wrapping

Handle wrapping checks. Disable this feature if you are experiencing crashes when creating new extensions or developing new Vulkan objects/structures.

Learn more about the Handle Wrapping setting.

• Key: unique_handles
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "unique_handles", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.unique_handles = true

export VK_KHRONOS_VALIDATION_UNIQUE_HANDLES=true
export VK_VALIDATION_UNIQUE_HANDLES=true
export VK_UNIQUE_HANDLES=true

adb setprop debug.vulkan.khronos_validation.unique_handles true
adb setprop debug.vulkan.validation.unique_handles true
adb setprop debug.vulkan.unique_handles true
adb setprop debug.vvl.unique_handles true

Object Lifetime

Object tracking checks. This may not always be necessary late in a development cycle.

Learn more about the Object Lifetime setting.

• Key: object_lifetime
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "object_lifetime", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.object_lifetime = true

export VK_KHRONOS_VALIDATION_OBJECT_LIFETIME=true
export VK_VALIDATION_OBJECT_LIFETIME=true
export VK_OBJECT_LIFETIME=true

adb setprop debug.vulkan.khronos_validation.object_lifetime true
adb setprop debug.vulkan.validation.object_lifetime true
adb setprop debug.vulkan.object_lifetime true
adb setprop debug.vvl.object_lifetime true

Stateless Parameter

Stateless parameter checks. This may not always be necessary late in a development cycle.

Learn more about the Stateless Parameter setting.

• Key: stateless_param
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "stateless_param", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.stateless_param = true

export VK_KHRONOS_VALIDATION_STATELESS_PARAM=true
export VK_VALIDATION_STATELESS_PARAM=true
export VK_STATELESS_PARAM=true

adb setprop debug.vulkan.khronos_validation.stateless_param true
adb setprop debug.vulkan.validation.stateless_param true
adb setprop debug.vulkan.stateless_param true
adb setprop debug.vvl.stateless_param true

Thread Safety

Thread checks. In order to not degrade performance, it might be best to run your program with thread-checking disabled most of the time, enabling it occasionally for a quick sanity check or when debugging difficult application behaviors.

Learn more about the Thread Safety setting.

• Key: thread_safety
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "thread_safety", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.thread_safety = true

export VK_KHRONOS_VALIDATION_THREAD_SAFETY=true
export VK_VALIDATION_THREAD_SAFETY=true
export VK_THREAD_SAFETY=true

adb setprop debug.vulkan.khronos_validation.thread_safety true
adb setprop debug.vulkan.validation.thread_safety true
adb setprop debug.vulkan.thread_safety true
adb setprop debug.vvl.thread_safety true

Synchronization

Check for resource access conflicts caused by missing or incorrectly used synchronization operations.

Learn more about the Synchronization setting.

Sub-settings: Submit time validation, Shader accesses heuristic, and Error messages.

• Key: validate_sync
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_sync", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_sync = false

export VK_KHRONOS_VALIDATION_VALIDATE_SYNC=false
export VK_VALIDATION_VALIDATE_SYNC=false
export VK_VALIDATE_SYNC=false

adb setprop debug.vulkan.khronos_validation.validate_sync false
adb setprop debug.vulkan.validation.validate_sync false
adb setprop debug.vulkan.validate_sync false
adb setprop debug.vvl.validate_sync false

Submit time validation

Enable synchronization validation on the boundary between submitted command buffers. This also validates accesses from presentation operations. This option can incur a significant performance cost.

• Key: syncval_submit_time_validation
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "syncval_submit_time_validation", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.syncval_submit_time_validation = true

export VK_KHRONOS_VALIDATION_SYNCVAL_SUBMIT_TIME_VALIDATION=true
export VK_VALIDATION_SYNCVAL_SUBMIT_TIME_VALIDATION=true
export VK_SYNCVAL_SUBMIT_TIME_VALIDATION=true

adb setprop debug.vulkan.khronos_validation.syncval_submit_time_validation true
adb setprop debug.vulkan.validation.syncval_submit_time_validation true
adb setprop debug.vulkan.syncval_submit_time_validation true
adb setprop debug.vvl.syncval_submit_time_validation true

Shader accesses heuristic

Take into account memory accesses performed by the shader based on SPIR-V static analysis. Warning: can produce false-positives, can ignore certain types of accesses.

• Key: syncval_shader_accesses_heuristic
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "syncval_shader_accesses_heuristic", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.syncval_shader_accesses_heuristic = false

export VK_KHRONOS_VALIDATION_SYNCVAL_SHADER_ACCESSES_HEURISTIC=false
export VK_VALIDATION_SYNCVAL_SHADER_ACCESSES_HEURISTIC=false
export VK_SYNCVAL_SHADER_ACCESSES_HEURISTIC=false

adb setprop debug.vulkan.khronos_validation.syncval_shader_accesses_heuristic false
adb setprop debug.vulkan.validation.syncval_shader_accesses_heuristic false
adb setprop debug.vulkan.syncval_shader_accesses_heuristic false
adb setprop debug.vvl.syncval_shader_accesses_heuristic false

Error messages

Options to configure synchronization validation error reporting.

Sub-setting: Extra properties,

• Key: syncval_reporting
• Type: GROUP
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

Extra properties

Append a section of key-value properties to the error message. Useful for filtering errors.

• Key: syncval_message_extra_properties
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "syncval_message_extra_properties", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.syncval_message_extra_properties = false

export VK_KHRONOS_VALIDATION_SYNCVAL_MESSAGE_EXTRA_PROPERTIES=false
export VK_VALIDATION_SYNCVAL_MESSAGE_EXTRA_PROPERTIES=false
export VK_SYNCVAL_MESSAGE_EXTRA_PROPERTIES=false

adb setprop debug.vulkan.khronos_validation.syncval_message_extra_properties false
adb setprop debug.vulkan.validation.syncval_message_extra_properties false
adb setprop debug.vulkan.syncval_message_extra_properties false
adb setprop debug.vvl.syncval_message_extra_properties false

Debug Printf

Enable DebugPrintf and will print anything use NonSemantic.DebugPrintf in their SPIR-V.

Learn more about the Debug Printf setting.

Sub-settings: Redirect Printf messages to stdout, Printf verbose, and Printf buffer size.

• Key: printf_enable
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "printf_enable", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.printf_enable = false

export VK_KHRONOS_VALIDATION_PRINTF_ENABLE=false
export VK_VALIDATION_PRINTF_ENABLE=false
export VK_PRINTF_ENABLE=false

Redirect Printf messages to stdout

Enable redirection of Debug Printf messages from the debug callback to stdout.

• Key: printf_to_stdout
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "printf_to_stdout", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.printf_to_stdout = true

export VK_KHRONOS_VALIDATION_PRINTF_TO_STDOUT=true
export VK_VALIDATION_PRINTF_TO_STDOUT=true
export VK_PRINTF_TO_STDOUT=true

Printf verbose

Will print out handles, instruction location, position in command buffer, and more.

• Key: printf_verbose
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "printf_verbose", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.printf_verbose = false

export VK_KHRONOS_VALIDATION_PRINTF_VERBOSE=false
export VK_VALIDATION_PRINTF_VERBOSE=false
export VK_PRINTF_VERBOSE=false

Printf buffer size

Set the size in bytes of the buffer per draw/dispatch/traceRays to hold the messages.

• Key: printf_buffer_size
• Type: INT
• Default Value: 1024
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

int32_t data[] = { 1024 };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "printf_buffer_size", VK_LAYER_SETTING_TYPE_INT32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.printf_buffer_size = 1024

export VK_KHRONOS_VALIDATION_PRINTF_BUFFER_SIZE=1024
export VK_VALIDATION_PRINTF_BUFFER_SIZE=1024
export VK_PRINTF_BUFFER_SIZE=1024

GPU Assisted Validation

Enable validation that cannot be done the CPU and needs hooks into the GPU execution.

Learn more about the GPU Assisted Validation setting.

Sub-settings: Safe Mode, Force on robustness features, Shader instrumentation, Buffer content validation, Advanced Settings, and Developer Debug Settings.

• Key: gpuav_enable
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_enable", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_enable = false

export VK_KHRONOS_VALIDATION_GPUAV_ENABLE=false
export VK_VALIDATION_GPUAV_ENABLE=false
export VK_GPUAV_ENABLE=false

Safe Mode

Will have GPU-AV try and prevent crashes, but will be much slower to validate. If using Safe Mode, consider using selective shader instrumentation, to only instrument the shaders/pipelines causing issues.

• Key: gpuav_safe_mode
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_safe_mode", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_safe_mode = false

export VK_KHRONOS_VALIDATION_GPUAV_SAFE_MODE=false
export VK_VALIDATION_GPUAV_SAFE_MODE=false
export VK_GPUAV_SAFE_MODE=false

Force on robustness features

This will enable all possible robustness features for the app at device creation time. This can be used to quickly detect if with robustness, your issue disappears. GPU-AV will also skip validating things already covered by robustness, so turning on should reduce GPU-AV performance overhead.

• Key: gpuav_force_on_robustness
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_force_on_robustness", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_force_on_robustness = false

export VK_KHRONOS_VALIDATION_GPUAV_FORCE_ON_ROBUSTNESS=false
export VK_VALIDATION_GPUAV_FORCE_ON_ROBUSTNESS=false
export VK_GPUAV_FORCE_ON_ROBUSTNESS=false

Shader instrumentation

Instrument shaders to validate descriptors, descriptor indexing, buffer device addresses and ray queries. Warning: will considerably slow down shader executions.

Learn more about the Shader instrumentation setting.

Sub-settings: Enable instrumenting shaders selectively, Descriptors indexing, Post process descriptor indexing, Out of bounds buffer device addresses, RayQuery SPIR-V instructions, and Out of bounds vertex attribute fetching.

• Key: gpuav_shader_instrumentation
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_shader_instrumentation", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_shader_instrumentation = true

export VK_KHRONOS_VALIDATION_GPUAV_SHADER_INSTRUMENTATION=true
export VK_VALIDATION_GPUAV_SHADER_INSTRUMENTATION=true
export VK_GPUAV_SHADER_INSTRUMENTATION=true

Enable instrumenting shaders selectively

Select which shaders to instrument by passing a VkValidationFeaturesEXT struct with GPU-AV enabled in the VkShaderModuleCreateInfo pNext or using a regex matching a shader/pipeline debug name. Because this only validates the selected shaders, it will allow GPU-AV to run much faster.

Learn more about the Enable instrumenting shaders selectively setting.

All the following condition must be fulfilled for the setting to be applied.

Sub-setting: Shader/pipeline name regexes,

• Key: gpuav_select_instrumented_shaders
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_select_instrumented_shaders", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_select_instrumented_shaders = false

export VK_KHRONOS_VALIDATION_GPUAV_SELECT_INSTRUMENTED_SHADERS=false
export VK_VALIDATION_GPUAV_SELECT_INSTRUMENTED_SHADERS=false
export VK_GPUAV_SELECT_INSTRUMENTED_SHADERS=false

Shader/pipeline name regexes

Any shader or pipeline library debug name (set with vkSetDebugUtilsObjectNameEXT) fully matching any listed regular expression will be instrumented when creating pipelines with those shaders or libraries. Regex grammar: Modified ECMAScript. No support for shader objects yet. Warning: instrumentation being performed at final pipeline creation time, if shaders modules have already been destroyed at this step (possible when using pipeline libraries), they won't be found by this regex selection system. In this case, consider naming pipeline libraries instead.

All the following condition must be fulfilled for the setting to be applied.

• Key: gpuav_shaders_to_instrument
• Type: LIST
• Default Value:
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX

const char* data[] = { "" };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "gpuav_shaders_to_instrument", VK_LAYER_SETTING_TYPE_STRING_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.gpuav_shaders_to_instrument = 

export VK_KHRONOS_VALIDATION_GPUAV_SHADERS_TO_INSTRUMENT=
export VK_VALIDATION_GPUAV_SHADERS_TO_INSTRUMENT=
export VK_GPUAV_SHADERS_TO_INSTRUMENT=

Best Practices

Outputs warnings related to common misuse of the API, but which are not explicitly prohibited by the specification.

Learn more about the Best Practices setting.

Sub-settings: ARM-specific best practices, AMD-specific best practices, IMG-specific best practices, and NVIDIA-specific best practices.

• Key: validate_best_practices
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_best_practices", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_best_practices = false

export VK_KHRONOS_VALIDATION_VALIDATE_BEST_PRACTICES=false
export VK_VALIDATION_VALIDATE_BEST_PRACTICES=false
export VK_VALIDATE_BEST_PRACTICES=false

adb setprop debug.vulkan.khronos_validation.validate_best_practices false
adb setprop debug.vulkan.validation.validate_best_practices false
adb setprop debug.vulkan.validate_best_practices false
adb setprop debug.vvl.validate_best_practices false

ARM-specific best practices

Outputs warnings for spec-conforming but non-ideal code on ARM GPUs.

• Key: validate_best_practices_arm
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_best_practices_arm", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_best_practices_arm = false

export VK_KHRONOS_VALIDATION_VALIDATE_BEST_PRACTICES_ARM=false
export VK_VALIDATION_VALIDATE_BEST_PRACTICES_ARM=false
export VK_VALIDATE_BEST_PRACTICES_ARM=false

adb setprop debug.vulkan.khronos_validation.validate_best_practices_arm false
adb setprop debug.vulkan.validation.validate_best_practices_arm false
adb setprop debug.vulkan.validate_best_practices_arm false
adb setprop debug.vvl.validate_best_practices_arm false

AMD-specific best practices

Outputs warnings for spec-conforming but non-ideal code on AMD GPUs.

• Key: validate_best_practices_amd
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_best_practices_amd", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_best_practices_amd = false

export VK_KHRONOS_VALIDATION_VALIDATE_BEST_PRACTICES_AMD=false
export VK_VALIDATION_VALIDATE_BEST_PRACTICES_AMD=false
export VK_VALIDATE_BEST_PRACTICES_AMD=false

IMG-specific best practices

Outputs warnings for spec-conforming but non-ideal code on Imagination GPUs.

• Key: validate_best_practices_img
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_best_practices_img", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_best_practices_img = false

export VK_KHRONOS_VALIDATION_VALIDATE_BEST_PRACTICES_IMG=false
export VK_VALIDATION_VALIDATE_BEST_PRACTICES_IMG=false
export VK_VALIDATE_BEST_PRACTICES_IMG=false

NVIDIA-specific best practices

Outputs warnings for spec-conforming but non-ideal code on NVIDIA GPUs.

• Key: validate_best_practices_nvidia
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "validate_best_practices_nvidia", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.validate_best_practices_nvidia = false

export VK_KHRONOS_VALIDATION_VALIDATE_BEST_PRACTICES_NVIDIA=false
export VK_VALIDATION_VALIDATE_BEST_PRACTICES_NVIDIA=false
export VK_VALIDATE_BEST_PRACTICES_NVIDIA=false

adb setprop debug.vulkan.khronos_validation.validate_best_practices_nvidia false
adb setprop debug.vulkan.validation.validate_best_practices_nvidia false
adb setprop debug.vulkan.validate_best_practices_nvidia false
adb setprop debug.vvl.validate_best_practices_nvidia false

Debug Action

Specifies what action is to be taken when a layer reports information.

• Key: debug_action
• Type: FLAGS
• Default Value: VK_DBG_LAYER_ACTION_LOG_MSG
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

const char* data[] = { "VK_DBG_LAYER_ACTION_LOG_MSG" };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "debug_action", VK_LAYER_SETTING_TYPE_STRING_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG

export VK_KHRONOS_VALIDATION_DEBUG_ACTION=VK_DBG_LAYER_ACTION_LOG_MSG
export VK_VALIDATION_DEBUG_ACTION=VK_DBG_LAYER_ACTION_LOG_MSG
export VK_DEBUG_ACTION=VK_DBG_LAYER_ACTION_LOG_MSG

adb setprop debug.vulkan.khronos_validation.debug_action VK_DBG_LAYER_ACTION_LOG_MSG
adb setprop debug.vulkan.validation.debug_action VK_DBG_LAYER_ACTION_LOG_MSG
adb setprop debug.vulkan.debug_action VK_DBG_LAYER_ACTION_LOG_MSG
adb setprop debug.vvl.debug_action VK_DBG_LAYER_ACTION_LOG_MSG

Log Filename

Specifies the output filename.

• Key: log_filename
• Type: SAVE_FILE
• Default Value: stdout
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

const char* data[] = { "stdout" };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "log_filename", VK_LAYER_SETTING_TYPE_STRING_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.log_filename = stdout

export VK_KHRONOS_VALIDATION_LOG_FILENAME=stdout
export VK_VALIDATION_LOG_FILENAME=stdout
export VK_LOG_FILENAME=stdout

adb setprop debug.vulkan.khronos_validation.log_filename stdout
adb setprop debug.vulkan.validation.log_filename stdout
adb setprop debug.vulkan.log_filename stdout
adb setprop debug.vvl.log_filename stdout

Message Severity

Comma-delineated list of options specifying the types of messages to be reported.

• Key: report_flags
• Type: FLAGS
• Default Value: error
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

const char* data[] = { "error" };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "report_flags", VK_LAYER_SETTING_TYPE_STRING_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.report_flags = error

export VK_KHRONOS_VALIDATION_REPORT_FLAGS=error
export VK_VALIDATION_REPORT_FLAGS=error
export VK_REPORT_FLAGS=error

adb setprop debug.vulkan.khronos_validation.report_flags error
adb setprop debug.vulkan.validation.report_flags error
adb setprop debug.vulkan.report_flags error
adb setprop debug.vvl.report_flags error

Limit Duplicated Messages

Enable limiting of duplicate messages.

Sub-setting: Max Duplicated Messages,

• Key: enable_message_limit
• Type: BOOL
• Default Value: true
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_TRUE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "enable_message_limit", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.enable_message_limit = true

export VK_KHRONOS_VALIDATION_ENABLE_MESSAGE_LIMIT=true
export VK_VALIDATION_ENABLE_MESSAGE_LIMIT=true
export VK_ENABLE_MESSAGE_LIMIT=true

adb setprop debug.vulkan.khronos_validation.enable_message_limit true
adb setprop debug.vulkan.validation.enable_message_limit true
adb setprop debug.vulkan.enable_message_limit true
adb setprop debug.vvl.enable_message_limit true

Max Duplicated Messages

Maximum number of times any single validation message should be reported.

• Key: duplicate_message_limit
• Type: INT
• Default Value: 10
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

int32_t data[] = { 10 };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "duplicate_message_limit", VK_LAYER_SETTING_TYPE_INT32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.duplicate_message_limit = 10

export VK_KHRONOS_VALIDATION_DUPLICATE_MESSAGE_LIMIT=10
export VK_VALIDATION_DUPLICATE_MESSAGE_LIMIT=10
export VK_DUPLICATE_MESSAGE_LIMIT=10
export VK_LAYER_DUPLICATE_MESSAGE_LIMIT=10

adb setprop debug.vulkan.khronos_validation.duplicate_message_limit 10
adb setprop debug.vulkan.validation.duplicate_message_limit 10
adb setprop debug.vulkan.duplicate_message_limit 10
adb setprop debug.vvl.duplicate_message_limit 10

Mute Message VUIDs

List of VUIDs and VUID identifiers which are to be IGNORED by the validation layer.

• Key: message_id_filter
• Type: LIST
• Default Value:
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

const char* data[] = { "" };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "message_id_filter", VK_LAYER_SETTING_TYPE_STRING_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.message_id_filter = 

export VK_KHRONOS_VALIDATION_MESSAGE_ID_FILTER=
export VK_VALIDATION_MESSAGE_ID_FILTER=
export VK_MESSAGE_ID_FILTER=
export VK_LAYER_MESSAGE_ID_FILTER=

adb setprop debug.vulkan.khronos_validation.message_id_filter 
adb setprop debug.vulkan.validation.message_id_filter 
adb setprop debug.vulkan.message_id_filter 
adb setprop debug.vvl.message_id_filter 

Message Format

Specifies how error messages are reported.

Sub-settings: JSON, and Display Application Name.

• Key: message_format
• Type: GROUP
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

JSON

Display Validation as JSON (VkDebugUtilsMessengerCallbackDataEXT::pMessage will contain JSON).

• Key: message_format_json
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "message_format_json", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.message_format_json = false

export VK_KHRONOS_VALIDATION_MESSAGE_FORMAT_JSON=false
export VK_VALIDATION_MESSAGE_FORMAT_JSON=false
export VK_MESSAGE_FORMAT_JSON=false

adb setprop debug.vulkan.khronos_validation.message_format_json false
adb setprop debug.vulkan.validation.message_format_json false
adb setprop debug.vulkan.message_format_json false
adb setprop debug.vvl.message_format_json false

Display Application Name

Useful when running multiple instances to know which instance the message is from.

• Key: message_format_display_application_name
• Type: BOOL
• Default Value: false
• Platforms: WINDOWS_X86, WINDOWS_ARM, LINUX, MACOS, ANDROID

VkBool32 data[] = { VK_FALSE };
VkLayerSettingEXT setting {
 "VK_LAYER_KHRONOS_validation", "message_format_display_application_name", VK_LAYER_SETTING_TYPE_BOOL32_EXT,
 static_cast<uint32_t>(std::size(data)), data };

khronos_validation.message_format_display_application_name = false

export VK_KHRONOS_VALIDATION_MESSAGE_FORMAT_DISPLAY_APPLICATION_NAME=false
export VK_VALIDATION_MESSAGE_FORMAT_DISPLAY_APPLICATION_NAME=false
export VK_MESSAGE_FORMAT_DISPLAY_APPLICATION_NAME=false

adb setprop debug.vulkan.khronos_validation.message_format_display_application_name false
adb setprop debug.vulkan.validation.message_format_display_application_name false
adb setprop debug.vulkan.message_format_display_application_name false
adb setprop debug.vvl.message_format_display_application_name false

Layer Presets

Standard

Good default validation setup that balance validation coverage and performance.

Preset Setting Values:

• Core: true
• Image Layout: true
• Command Buffer State: true
• Object in Use: true
• Query: true
• Shader: true
• Caching: true
• Handle Wrapping: true
• Object Lifetime: true
• Stateless Parameter: true
• Thread Safety: false
• Synchronization: false
• Debug Printf: false
• GPU Assisted Validation: false
• Best Practices: false
• Message Severity: error, warn
• Debug Action: VK_DBG_LAYER_ACTION_LOG_MSG
• Limit Duplicated Messages: true

Reduced-Overhead

Disables some checks in the interest of better performance.

Preset Setting Values:

• Core: true
• Image Layout: false
• Command Buffer State: false
• Object in Use: false
• Query: false
• Shader: true
• Caching: true
• Handle Wrapping: false
• Object Lifetime: true
• Stateless Parameter: true
• Thread Safety: false
• Synchronization: false
• Debug Printf: false
• GPU Assisted Validation: false
• Best Practices: false
• Message Severity: error
• Debug Action: VK_DBG_LAYER_ACTION_LOG_MSG
• Limit Duplicated Messages: true

Best Practices

Provides warnings on valid API usage that is potential API misuse.

Preset Setting Values:

• Core: false
• Image Layout: false
• Command Buffer State: false
• Object in Use: false
• Query: false
• Shader: false
• Caching: false
• Handle Wrapping: false
• Object Lifetime: false
• Stateless Parameter: false
• Thread Safety: false
• Synchronization: false
• Debug Printf: false
• GPU Assisted Validation: false
• Best Practices: true
• Message Severity: error, warn, perf
• Debug Action: VK_DBG_LAYER_ACTION_LOG_MSG
• Limit Duplicated Messages: true

Synchronization

Identify resource access conflicts due to missing or incorrect synchronization operations between actions reading or writing the same regions of memory.

Preset Setting Values:

• Core: false
• Image Layout: false
• Command Buffer State: false
• Object in Use: false
• Query: false
• Shader: false
• Caching: false
• Handle Wrapping: true
• Object Lifetime: false
• Stateless Parameter: false
• Thread Safety: true
• Synchronization: true
• Debug Printf: false
• GPU Assisted Validation: false
• Best Practices: false
• Message Severity: error
• Debug Action: VK_DBG_LAYER_ACTION_LOG_MSG
• Limit Duplicated Messages: true

GPU-Assisted

Check for API usage errors at shader execution time.

Preset Setting Values:

• Core: false
• Image Layout: false
• Command Buffer State: false
• Object in Use: false
• Query: false
• Shader: false
• Caching: false
• Handle Wrapping: false
• Object Lifetime: false
• Stateless Parameter: false
• Thread Safety: false
• Synchronization: false
• Debug Printf: false
• GPU Assisted Validation: true
• Shader instrumentation: true
• Enable instrumenting shaders selectively: false
• Buffer content validation: true
• Reserve Descriptor Set Binding Slot: true
• Best Practices: false
• Message Severity: error
• Debug Action: VK_DBG_LAYER_ACTION_LOG_MSG
• Limit Duplicated Messages: true

Debug Printf

Debug shader code by "printing" any values of interest to the debug callback or stdout.

Preset Setting Values:

• Core: false
• Image Layout: false
• Command Buffer State: false
• Object in Use: false
• Query: false
• Shader: false
• Caching: false
• Handle Wrapping: false
• Object Lifetime: false
• Stateless Parameter: false
• Thread Safety: false
• Synchronization: false
• GPU Assisted Validation: false
• Debug Printf: true
• Best Practices: false
• Message Severity: error, info
• Debug Action:
• Limit Duplicated Messages: false