1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/* Copyright (c) 2022-2025 The Khronos Group Inc.
* Copyright (c) 2022-2025 Valve Corporation
* Copyright (c) 2022-2025 LunarG, Inc.
* Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <array>
#include <vector>
#include <string>
#include <utility>
#include <cstdint>
#include <vulkan/vulkan.h>
#include <vulkan/utility/vk_struct_helper.hpp>
#define OBJECT_LAYER_NAME "VK_LAYER_KHRONOS_validation"
enum ValidationCheckDisables {
VALIDATION_CHECK_DISABLE_COMMAND_BUFFER_STATE,
VALIDATION_CHECK_DISABLE_OBJECT_IN_USE,
VALIDATION_CHECK_DISABLE_QUERY_VALIDATION,
VALIDATION_CHECK_DISABLE_IMAGE_LAYOUT_VALIDATION,
};
enum ValidationCheckEnables {
VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_ARM,
VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_AMD,
VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_IMG,
VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_NVIDIA,
VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_ALL,
};
// ValidationDisabled and ValidationEnabled vectors are containers for bools that can opt in or out of specific classes of
// validation checks. Enum values can be specified via the vk_layer_settings.txt config file or at CreateInstance time via the
// VK_EXT_validation_features extension that can selectively disable or enable checks.
enum DisableFlags {
command_buffer_state,
object_in_use,
query_validation,
image_layout_validation,
object_tracking,
core_checks,
thread_safety,
stateless_checks,
handle_wrapping,
shader_validation,
shader_validation_caching,
// Insert new disables above this line
kMaxDisableFlags,
};
enum EnableFlags {
gpu_validation,
gpu_validation_reserve_binding_slot,
best_practices,
vendor_specific_arm,
vendor_specific_amd,
vendor_specific_img,
vendor_specific_nvidia,
debug_printf_validation,
sync_validation,
deprecation_detection,
// Insert new enables above this line
kMaxEnableFlags,
};
using ValidationDisabled = std::array<bool, kMaxDisableFlags>;
using ValidationEnabled = std::array<bool, kMaxEnableFlags>;
// General settings to be used by all parts of the Validation Layers
struct GlobalSettings {
bool fine_grained_locking = true;
bool debug_disable_spirv_val = false;
// Have quick way to know if user only has requsted errors as we can skip larger, expensive parts of the code if the user will
// never see the message
bool only_report_errors = false;
// We have the spirv::Module state object designed to hold the SPIR-V and parse it so we can do validation on it, the
// issue/tricky part is gpuav/debugPrint use this to get the original SPIR-V (which we need to provide any useful error
// messages). These settings are here to make it more obvious what we want at runtime
//
// Stores a copy, needed to provide error messages and how DebugPrintf works
// (performance is fast, but memory overhead is higher)
bool spirv_store = true;
// Parsing of the SPIR-V to provide information for validation (core check, sync val, etc)
// (small performance hit for large shader)
bool spirv_parse = true;
// If we want to have spirv-opt potentially do constant folding on the spec constants
// (by far the largest performance bottle neck for large shaders using spec cosntants)
bool spirv_const_fold = true;
};
class DebugReport;
struct GpuAVSettings;
struct SyncValSettings;
struct MessageFormatSettings;
struct ConfigAndEnvSettings {
// Matches up with what is passed down to VK_EXT_layer_settings
const char *layer_description;
// Used so we can find things like VkValidationFeaturesEXT
const VkInstanceCreateInfo *create_info;
// Find grain way to turn off/on parts of validation
ValidationEnabled &enabled;
ValidationDisabled &disabled;
// Settings for DebugReport
DebugReport *debug_report;
GlobalSettings* global_settings;
// Individual settings for different internal layers
GpuAVSettings *gpuav_settings;
SyncValSettings *syncval_settings;
};
const std::vector<std::string> &GetDisableFlagNameHelper();
const std::vector<std::string> &GetEnableFlagNameHelper();
// Process validation features, flags and settings specified through extensions, a layer settings file, or environment variables
void ProcessConfigAndEnvSettings(ConfigAndEnvSettings *settings_data);
std::vector<std::pair<uint32_t, uint32_t>> &GetCustomStypeInfo();
|
