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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
#!/usr/bin/python3 -i
#
# Copyright (c) 2015-2025 The Khronos Group Inc.
# Copyright (c) 2015-2025 Valve Corporation
# Copyright (c) 2015-2025 LunarG, Inc.
#
# 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.
import os
from base_generator import BaseGenerator
from generators.generator_utils import PlatformGuardHelper
# If there is another success code other than VK_SUCCESS
def hasNonVkSuccess(successCodes: list[str]) -> bool:
if successCodes is None or len(successCodes) == 0:
return False
return len(successCodes) > 1 or 'VK_SUCCESS' not in successCodes
class BestPracticesOutputGenerator(BaseGenerator):
def __init__(self):
BaseGenerator.__init__(self)
# Commands which are not autogenerated but still intercepted
# More are added from a first pass over the functions
self.no_autogen_list = [
'vkEnumerateInstanceVersion',
'vkCreateValidationCacheEXT',
'vkDestroyValidationCacheEXT',
'vkMergeValidationCachesEXT',
'vkGetValidationCacheDataEXT',
]
# Commands that require an extra parameter for state sharing between validate/record steps
self.extra_parameter_map = {
'vkCreateShaderModule' : 'chassis::CreateShaderModule',
'vkCreateShadersEXT' : 'chassis::ShaderObject',
'vkAllocateDescriptorSets' : 'vvl::AllocateDescriptorSetsData',
}
self.pipeline_parameter_map = {
'vkCreateGraphicsPipelines' : ', chassis::CreateGraphicsPipelines& chassis_state',
'vkCreateComputePipelines' : ', chassis::CreateComputePipelines& chassis_state',
'vkCreateRayTracingPipelinesNV' : '',
'vkCreateRayTracingPipelinesKHR' : ', std::shared_ptr<chassis::CreateRayTracingPipelinesKHR> chassis_state',
}
# Commands that have a manually written post-call-record step which needs to be called from the autogen'd fcn
self.manual_postcallrecord_list = [
'vkQueuePresentKHR',
'vkQueueBindSparse',
'vkCreateGraphicsPipelines',
'vkBindBufferMemory2',
'vkBindImageMemory2',
# AMD tracked
'vkCreateComputePipelines',
'vkCmdPipelineBarrier',
'vkQueueSubmit',
]
self.extension_info = dict()
def generate(self):
self.write(f'''// *** THIS FILE IS GENERATED - DO NOT EDIT ***
// See {os.path.basename(__file__)} for modifications
/***************************************************************************
*
* Copyright (c) 2015-2025 The Khronos Group Inc.
* Copyright (c) 2015-2025 Valve Corporation
* Copyright (c) 2015-2025 LunarG, Inc.
*
* 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.
****************************************************************************/\n''')
self.write('// NOLINTBEGIN') # Wrap for clang-tidy to ignore
# Build additional pass of functions to ignore
for name, command in self.vk.commands.items():
if command.returnType != 'VkResult':
self.no_autogen_list.append(name)
# This is just to remove un-used commands from be generated
# This can be removed if another use for these commands are needed
elif (command.errorCodes is None and not hasNonVkSuccess(command.successCodes)):
self.no_autogen_list.append(name)
if self.filename == 'best_practices_instance_methods.h':
self.generateInstanceHeader()
elif self.filename == 'best_practices_device_methods.h':
self.generateDeviceHeader()
elif self.filename == 'best_practices.cpp':
self.generateSource()
else:
self.write(f'\nFile name {self.filename} has no code to generate\n')
self.write('// NOLINTEND') # Wrap for clang-tidy to ignore
def generateHeader(self, want_instance):
out = []
guard_helper = PlatformGuardHelper()
# List all Function declarations
for command in [x for x in self.vk.commands.values() if x.name not in self.no_autogen_list and x.instance == want_instance]:
out.extend(guard_helper.add_guard(command.protect))
prototype = command.cPrototype.split("VKAPI_CALL ")[1]
prototype = f'void PostCallRecord{prototype[2:]}'
prototype = prototype.replace(');', ', const RecordObject& record_obj) {\n')
prototype = prototype.replace(') {', ') override;\n')
if command.name in self.extra_parameter_map:
prototype = prototype.replace(')', f', {self.extra_parameter_map[command.name]}& chassis_state)')
elif command.name in self.pipeline_parameter_map:
prototype = prototype.replace(')', f', PipelineStates& pipeline_states {self.pipeline_parameter_map[command.name]})')
out.append(prototype)
out.extend(guard_helper.add_guard(None))
self.write("".join(out))
def generateDeviceHeader(self):
self.generateHeader(False)
def generateInstanceHeader(self):
self.generateHeader(True)
def generateSource(self):
guard_helper = PlatformGuardHelper()
out = []
out.append('''
#include "best_practices/best_practices_validation.h"
DeprecationData GetDeprecatedData(vvl::Extension extension_name) {
static const DeprecationData empty_deprecated_data{DeprecationReason::Empty, vvl::Extension::Empty};
static const vvl::unordered_map<vvl::Extension, DeprecationData> deprecated_extensions = {
''')
for extension in self.vk.extensions.values():
target = None
reason = None
if extension.promotedTo is not None:
reason = 'DeprecationReason::Promoted'
target = extension.promotedTo
elif extension.obsoletedBy is not None:
reason = 'DeprecationReason::Obsoleted'
target = extension.obsoletedBy
elif extension.deprecatedBy is not None:
reason = 'DeprecationReason::Deprecated'
target = extension.deprecatedBy
else:
continue
if len(target) == 0:
target = 'vvl::Extension::Empty'
elif 'VERSION' in target:
target = f'vvl::Version::_{target}'
else:
target = f'vvl::Extension::_{target}'
out.append(f' {{vvl::Extension::_{extension.name}, {{{reason}, {{{target}}}}}}},\n')
out.append(''' };
auto it = deprecated_extensions.find(extension_name);
return (it == deprecated_extensions.end()) ? empty_deprecated_data : it->second;
}
std::string GetSpecialUse(vvl::Extension extension_name) {
const vvl::unordered_map<vvl::Extension, std::string> special_use_extensions = {
''')
for extension in self.vk.extensions.values():
if extension.specialUse is not None:
out.append(f' {{vvl::Extension::_{extension.name}, "{", ".join(extension.specialUse)}"}},\n')
out.append(''' };
auto it = special_use_extensions.find(extension_name);
return (it == special_use_extensions.end()) ? "" : it->second;
}
''')
for command in [x for x in self.vk.commands.values() if x.name not in self.no_autogen_list]:
paramList = [param.name for param in command.params]
paramList.append('record_obj')
if command.name in self.extra_parameter_map:
paramList.append('chassis_state')
elif command.name in self.pipeline_parameter_map:
paramList.append('pipeline_states')
if self.pipeline_parameter_map[command.name]:
paramList.append('chassis_state')
params = ', '.join(paramList)
class_name = 'BestPractices' if not command.instance else 'bp_state::Instance'
out.extend(guard_helper.add_guard(command.protect, extra_newline=True))
prototype = command.cPrototype.split("VKAPI_CALL ")[1]
prototype = f'void {class_name}::PostCallRecord{prototype[2:]}'
prototype = prototype.replace(');', ', const RecordObject& record_obj) {\n')
if command.name in self.extra_parameter_map:
prototype = prototype.replace(')', f', {self.extra_parameter_map[command.name]}& chassis_state)')
elif command.name in self.pipeline_parameter_map:
prototype = prototype.replace(')', f', PipelineStates& pipeline_states {self.pipeline_parameter_map[command.name]})')
out.append(prototype)
if command.alias:
# For alias that are promoted, just point to new function, RecordObject will allow us to distinguish the caller
paramList = [param.name for param in command.params]
paramList.append('record_obj')
params = ', '.join(paramList)
out.append(f'PostCallRecord{command.alias[2:]}({params});')
else:
if command.name in self.manual_postcallrecord_list:
out.append(f'ManualPostCallRecord{command.name[2:]}({params});\n')
if (command.errorCodes is not None or hasNonVkSuccess(command.successCodes)):
if command.name == 'vkCreateInstance':
handle = '*pInstance'
elif command.name.startswith('vkEnumerateInstance'):
handle = '(VkInstance)VK_NULL_HANDLE'
else:
handle = command.params[0].name
out.append(f'bp_state::LogResult(*this, {handle}, record_obj);\n')
out.append('}\n')
out.extend(guard_helper.add_guard(None, extra_newline=True))
self.write(''.join(out))
|
