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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
#!/usr/bin/python3 -i
#
# Copyright (c) 2015-2025 The Khronos Group Inc.
# Copyright (c) 2015-2025 Valve Corporation
# Copyright (c) 2015-2025 LunarG, Inc.
# Copyright (c) 2015-2025 Google Inc.
# Copyright (c) 2023-2025 RasterGrid Kft.
#
# 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 vulkan_object import Command, Param
from base_generator import BaseGenerator
from generators.generator_utils import PlatformGuardHelper
def GetParentInstance(param: Param) -> str:
instanceParent = ['VkSurfaceKHR',
'VkDebugReportCallbackEXT',
'VkDebugUtilsMessengerEXT',
'VkDisplayKHR',
'VkDevice',
'VkInstance',
]
return 'ParentInstance' if param.type in instanceParent else ''
class ThreadSafetyOutputGenerator(BaseGenerator):
def __init__(self):
BaseGenerator.__init__(self)
# Commands shadowed by interface functions and are not implemented
self.manual_commands = [
'vkAllocateCommandBuffers',
'vkFreeCommandBuffers',
'vkCreateCommandPool',
'vkResetCommandPool',
'vkDestroyCommandPool',
'vkAllocateDescriptorSets',
'vkFreeDescriptorSets',
'vkResetDescriptorPool',
'vkDestroyDescriptorPool',
'vkGetSwapchainImagesKHR',
'vkDestroySwapchainKHR',
'vkDestroyDevice',
'vkGetDeviceQueue',
'vkGetDeviceQueue2',
'vkCreateDescriptorSetLayout',
'vkUpdateDescriptorSets',
'vkUpdateDescriptorSetWithTemplate',
'vkUpdateDescriptorSetWithTemplateKHR',
'vkGetDisplayPlaneSupportedDisplaysKHR',
'vkGetDisplayModePropertiesKHR',
'vkGetDisplayModeProperties2KHR',
'vkGetDisplayPlaneCapabilities2KHR',
'vkGetRandROutputDisplayEXT',
'vkGetDrmDisplayEXT',
'vkDeviceWaitIdle',
'vkRegisterDisplayEventEXT',
'vkCreateRayTracingPipelinesKHR',
'vkQueuePresentKHR',
'vkWaitForPresentKHR',
'vkCreatePipelineBinariesKHR',
]
self.blacklist = [
# Currently not wrapping debug helper functions
'vkSetDebugUtilsObjectNameEXT',
'vkSetDebugUtilsObjectTagEXT',
'vkDebugMarkerSetObjectTagEXT',
'vkDebugMarkerSetObjectNameEXT',
'vkCmdDebugMarkerBeginEXT',
'vkCmdDebugMarkerEndEXT',
'vkCmdDebugMarkerInsertEXT',
]
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.
* Copyright (c) 2015-2025 Google 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
if self.filename == 'thread_safety.cpp':
self.generateSource()
elif self.filename == 'thread_safety_device_defs.h':
self.generateDeviceDefs()
elif self.filename == 'thread_safety_instance_defs.h':
self.generateInstanceDefs()
self.write('// NOLINTEND') # Wrap for clang-tidy to ignore
def makeThreadUseBlock(self, command: Command, start: bool = False, finish: bool = False) -> str:
prefix = 'Start' if start else 'Finish'
out = []
# Find and add any parameters that are thread unsafe
for param in command.params:
parent_instance = '' if command.instance else GetParentInstance(param)
if param.externSyncPointer:
if param.length:
# Externsync can list pointers to arrays of members to synchronize
out.append(f'if ({param.name}) {{\n')
out.append(f' for (uint32_t index = 0; index < {param.length}; index++) {{\n')
for member in param.externSyncPointer:
# Replace first empty [] in member name with index
element = member.replace('[]','[index]',1)
# XXX TODO: Can we do better to lookup types of externsync members?
suffix = ''
if 'surface' in member:
suffix = 'ParentInstance'
if '[]' in element:
# TODO: These null checks can be removed if threading ends up behind parameter
# validation in layer order
element_ptr = element.split('[]')[0]
out.append(f'if ({element_ptr}) {{\n')
# Replace any second empty [] in element name with inner array index based on mapping array
# names like "pSomeThings[]" to "someThingCount" array size. This could be more robust by
# mapping a param member name to a struct type and "len" attribute.
limit = element[0:element.find('s[]')] + 'Count'
dotp = limit.rfind('.p')
limit = limit[0:dotp+1] + limit[dotp+2:dotp+3].lower() + limit[dotp+3:]
out.append(f'for (uint32_t index2=0; index2 < {limit}; index2++) {{\n')
element = element.replace('[]','[index2]')
out.append(f' {prefix}WriteObject{suffix}({element}, record_obj.location);')
out.append('}\n')
out.append('}\n')
else:
out.append(f'{prefix}WriteObject{suffix}({element}, record_obj.location);\n')
out.append('}\n')
out.append('}\n')
else:
# externsync can list members to synchronize
for member in param.externSyncPointer:
member = str(member).replace("::", "->")
member = str(member).replace(".", "->")
suffix = 'ParentInstance' if 'surface' in member else ''
out.append(f' {prefix}WriteObject{suffix}({member}, record_obj.location);\n')
elif param.externSync:
if param.length:
out.append(f'''
if ({param.name}) {{
for (uint32_t index = 0; index < {param.length}; index++) {{
{prefix}WriteObject{parent_instance}({param.name}[index], record_obj.location);
}}
}}\n''')
else:
out.append(f'{prefix}WriteObject{parent_instance}({param.name}, record_obj.location);\n')
if ('Destroy' in command.name or 'Free' in command.name or 'ReleasePerformanceConfigurationINTEL' in command.name) and prefix == 'Finish':
out.append(f'DestroyObject{parent_instance}({param.name});\n')
elif param.pointer and ('Create' in command.name or 'Allocate' in command.name or 'AcquirePerformanceConfigurationINTEL' in command.name) and prefix == 'Finish':
if param.type in self.vk.handles:
create_pipelines_call = True
create_shaders_call = True
# The CreateXxxPipelines/CreateShaders APIs can return a list of partly created pipelines/shaders upon failure
if not ('Create' in command.name and 'Pipelines' in command.name):
create_pipelines_call = False
if not ('Create' in command.name and 'Shaders' in command.name):
create_shaders_call = False
if not create_pipelines_call and not create_shaders_call:
out.append('if (record_obj.result == VK_SUCCESS) {\n')
create_pipelines_call = False
if param.length:
# Add pointer dereference for array counts that are pointer values
dereference = ''
for candidate in command.params:
if param.length == candidate.name:
if candidate.pointer:
dereference = '*'
param_len = param.length.replace("::", "->")
out.append(f'if ({param.name}) {{\n')
out.append(f' for (uint32_t index = 0; index < {dereference}{param_len}; index++) {{\n')
if create_pipelines_call:
out.append('if (!pPipelines[index]) continue;\n')
if create_shaders_call:
out.append('if (!pShaders[index]) continue;\n')
out.append(f'CreateObject({param.name}[index]);\n')
out.append('}\n')
out.append('}\n')
else:
out.append(f'CreateObject(*{param.name});\n')
if not create_pipelines_call and not create_shaders_call:
out.append('}\n')
else:
if param.type in self.vk.handles and param.type != 'VkPhysicalDevice':
if param.length and ('pPipelines' != param.name) and ('pShaders' != param.name or 'Create' not in command.name):
# Add pointer dereference for array counts that are pointer values
dereference = ''
for candidate in command.params:
if param.length == candidate.name:
if candidate.pointer:
dereference = '*'
param_len = param.length.replace("::", "->")
out.append(f'''
if ({param.name}) {{
for (uint32_t index = 0; index < {dereference}{param.length}; index++) {{
{prefix}ReadObject{parent_instance}({param.name}[index], record_obj.location);
}}
}}\n''')
elif not param.pointer:
# Pointer params are often being created.
# They are not being read from.
out.append(f'{prefix}ReadObject{parent_instance}({param.name}, record_obj.location);\n')
for param in [x for x in command.params if x.externSync]:
out.append('// Host access to ')
if param.externSyncPointer:
out.append(",".join(param.externSyncPointer))
else:
if param.length:
out.append(f'each member of {param.name}')
elif param.pointer:
out.append(f'the object referenced by {param.name}')
else:
out.append(param.name)
out.append(' must be externally synchronized\n')
# Find and add any "implicit" parameters that are thread unsafe
out.extend([f'// {x} must be externally synchronized between host accesses\n' for x in command.implicitExternSyncParams])
return "".join(out) if len(out) > 0 else None
def generateSource(self):
out = []
out.append('''
#include "thread_tracker/thread_safety_validation.h"
namespace threadsafety {
''')
guard_helper = PlatformGuardHelper()
for command in [x for x in self.vk.commands.values() if x.name not in self.blacklist and x.name not in self.manual_commands]:
# Determine first if this function needs to be intercepted
startThreadSafety = self.makeThreadUseBlock(command, start=True)
finishThreadSafety = self.makeThreadUseBlock(command, finish=True)
if startThreadSafety is None and finishThreadSafety is None:
continue
# 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')
aliasParams = ', '.join(paramList)
class_name = 'Device' if not command.instance else 'Instance'
out.extend(guard_helper.add_guard(command.protect))
prototype = command.cPrototype.split('VKAPI_CALL ')[1]
prototype = f'void {class_name}::PreCallRecord{prototype[2:]}'
prototype = prototype.replace(');', ', const RecordObject& record_obj) {\n')
out.append(prototype)
if command.alias:
out.append(f'PreCallRecord{command.alias[2:]}({aliasParams});')
else:
out.extend([startThreadSafety] if startThreadSafety is not None else [])
out.append('}\n\n')
prototype = prototype.replace('PreCallRecord', 'PostCallRecord')
out.append(prototype)
if command.alias:
out.append(f'PostCallRecord{command.alias[2:]}({aliasParams});')
else:
out.extend([finishThreadSafety] if finishThreadSafety is not None else [])
out.append('}\n\n')
out.extend(guard_helper.add_guard(None))
out.append('''
} // namespace threadsafety
''')
self.write("".join(out))
def dispatchableHandles(self, want_instance):
for handle in self.vk.handles.values():
if handle.dispatchable:
# TODO: handle.instance and handle.device are set wrong for VkDevice
if handle.name == 'VkDevice':
if want_instance:
yield handle
elif handle.instance == want_instance:
yield handle
def nonDispatchableHandles(self, want_instance):
for handle in self.vk.handles.values():
if not handle.dispatchable and handle.instance == want_instance:
yield handle
def generateDefs(self, want_instance):
out = []
guard_helper = PlatformGuardHelper()
for handle in self.dispatchableHandles(want_instance):
out.extend(guard_helper.add_guard(handle.protect))
out.append(f'Counter<{handle.name}> c_{handle.name};\n')
out.extend(guard_helper.add_guard(None))
out.append('#ifdef DISTINCT_NONDISPATCHABLE_HANDLES\n')
for handle in self.nonDispatchableHandles(want_instance):
out.extend(guard_helper.add_guard(handle.protect))
out.append(f'Counter<{handle.name}> c_{handle.name};\n')
out.extend(guard_helper.add_guard(None))
out.append('#else\n')
out.append('Counter<uint64_t> c_uint64_t;\n')
out.append('#endif // DISTINCT_NONDISPATCHABLE_HANDLES\n')
out.append('\n\n')
skip_wrappers = ('VkCommandBuffer',)
for handle in self.dispatchableHandles(want_instance):
if handle.name not in skip_wrappers:
out.extend(guard_helper.add_guard(handle.protect))
out.extend(f'WRAPPER({handle.name})\n')
out.extend(guard_helper.add_guard(None))
# Device needs to reference instance handles
if not want_instance:
for handle in self.dispatchableHandles(True):
out.extend(guard_helper.add_guard(handle.protect))
out.extend(f'WRAPPER_PARENT_INSTANCE({handle.name})\n')
out.extend(guard_helper.add_guard(None))
out.append('#ifdef DISTINCT_NONDISPATCHABLE_HANDLES\n')
for handle in self.nonDispatchableHandles(want_instance):
if handle.name not in skip_wrappers:
out.extend(guard_helper.add_guard(handle.protect))
out.extend(f'WRAPPER({handle.name})\n')
out.extend(guard_helper.add_guard(None))
# Device needs to reference instance handles
if not want_instance:
for handle in self.nonDispatchableHandles(True):
out.extend(guard_helper.add_guard(handle.protect))
out.extend(f'WRAPPER_PARENT_INSTANCE({handle.name})\n')
out.extend(guard_helper.add_guard(None))
out.append('#else\n')
out.append('WRAPPER(uint64_t)\n')
if not want_instance:
out.append('WRAPPER_PARENT_INSTANCE(uint64_t)\n')
out.append('#endif // DISTINCT_NONDISPATCHABLE_HANDLES\n')
out.append('\n\n')
out.append('void InitCounters() {\n')
for handle in self.dispatchableHandles(want_instance):
out.extend(guard_helper.add_guard(handle.protect))
out.append(f'c_{handle.name}.Init(kVulkanObjectType{handle.name[2:]}, this);\n')
out.extend(guard_helper.add_guard(None))
out.append('#ifdef DISTINCT_NONDISPATCHABLE_HANDLES\n')
for handle in self.nonDispatchableHandles(want_instance):
out.extend(guard_helper.add_guard(handle.protect))
out.append(f'c_{handle.name}.Init(kVulkanObjectType{handle.name[2:]}, this);\n')
out.extend(guard_helper.add_guard(None))
out.append('#else\n')
out.append('c_uint64_t.Init(kVulkanObjectTypeUnknown, this);\n')
out.append('#endif // DISTINCT_NONDISPATCHABLE_HANDLES\n')
out.append('}\n')
for command in [x for x in self.vk.commands.values() if x.name not in self.blacklist]:
if command.instance != want_instance:
continue
# Determine first if this function needs to be intercepted
startThreadSafety = self.makeThreadUseBlock(command, start=True)
finishThreadSafety = self.makeThreadUseBlock(command, finish=True)
if startThreadSafety is None and finishThreadSafety is None:
continue
out.extend(guard_helper.add_guard(command.protect))
prototype = command.cPrototype.split('VKAPI_CALL ')[1]
prototype = f'void PreCallRecord{prototype[2:]}'
prototype = prototype.replace(');', ', const RecordObject& record_obj) override;\n\n')
if 'ValidationCache' in command.name:
prototype = prototype.replace(' override;', ';')
out.append(prototype)
prototype = prototype.replace('PreCallRecord', 'PostCallRecord')
out.append(prototype)
out.extend(guard_helper.add_guard(None))
self.write("".join(out))
def generateDeviceDefs(self):
self.generateDefs(False)
def generateInstanceDefs(self):
self.generateDefs(True)
|
