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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
/*
** Copyright (c) 2019-2021 LunarG, Inc.
**
** Permission is hereby granted, free of charge, to any person obtaining a
** copy of this software and associated documentation files (the "Software"),
** to deal in the Software without restriction, including without limitation
** the rights to use, copy, modify, merge, publish, distribute, sublicense,
** and/or sell copies of the Software, and to permit persons to whom the
** Software is furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in
** all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
** FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
** DEALINGS IN THE SOFTWARE.
*/
#ifndef GFXRECON_ENCODE_VULKAN_STATE_TRACKER_H
#define GFXRECON_ENCODE_VULKAN_STATE_TRACKER_H
#include "encode/descriptor_update_template_info.h"
#include "encode/vulkan_handle_wrappers.h"
#include "generated/generated_vulkan_state_table.h"
#include "encode/vulkan_state_tracker_initializers.h"
#include "encode/vulkan_state_writer.h"
#include "format/format.h"
#include "format/format_util.h"
#include "generated/generated_vulkan_command_buffer_util.h"
#include "util/file_output_stream.h"
#include "util/defines.h"
#include "util/logging.h"
#include "util/memory_output_stream.h"
#include "vulkan/vulkan.h"
#include <cassert>
#include <functional>
#include <mutex>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(encode)
class VulkanStateTracker
{
public:
VulkanStateTracker();
~VulkanStateTracker();
void WriteState(VulkanStateWriter* writer, uint64_t frame_number)
{
if (writer != nullptr)
{
std::unique_lock<std::mutex> lock(state_table_mutex_);
writer->WriteState(state_table_, frame_number);
}
}
template <typename ParentHandle, typename Wrapper, typename CreateInfo>
void AddEntry(ParentHandle parent_handle,
typename Wrapper::HandleType* new_handle,
const CreateInfo* create_info,
format::ApiCallId create_call_id,
const util::MemoryOutputStream* create_parameter_buffer)
{
assert(new_handle != nullptr);
assert(create_parameter_buffer != nullptr);
if (*new_handle != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<Wrapper*>(*new_handle);
// Adds the handle wrapper to the object state table, filtering for duplicate handle retrieval.
std::unique_lock<std::mutex> lock(state_table_mutex_);
if (state_table_.InsertWrapper(wrapper->handle_id, wrapper))
{
vulkan_state_tracker::InitializeState<ParentHandle, Wrapper, CreateInfo>(
parent_handle,
wrapper,
create_info,
create_call_id,
std::make_shared<util::MemoryOutputStream>(create_parameter_buffer->GetData(),
create_parameter_buffer->GetDataSize()));
}
}
}
template <typename ParentHandle, typename Wrapper, typename AllocateInfo>
void AddPoolEntry(ParentHandle parent_handle,
uint32_t count,
typename Wrapper::HandleType* new_handles,
const AllocateInfo* alloc_info,
format::ApiCallId create_call_id,
const util::MemoryOutputStream* create_parameter_buffer)
{
assert(new_handles != nullptr);
assert(create_parameter_buffer != nullptr);
CreateParameters create_parameters = std::make_shared<util::MemoryOutputStream>(
create_parameter_buffer->GetData(), create_parameter_buffer->GetDataSize());
std::unique_lock<std::mutex> lock(state_table_mutex_);
for (uint32_t i = 0; i < count; ++i)
{
if (new_handles[i] != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<Wrapper*>(new_handles[i]);
// Adds the handle wrapper to the object state table, filtering for duplicate handle retrieval.
if (state_table_.InsertWrapper(wrapper->handle_id, wrapper))
{
vulkan_state_tracker::InitializePoolObjectState(
parent_handle, wrapper, i, alloc_info, create_call_id, create_parameters);
}
}
}
}
template <typename ParentHandle, typename SecondaryHandle, typename Wrapper, typename CreateInfo>
void AddGroupEntry(ParentHandle parent_handle,
SecondaryHandle secondary_handle,
uint32_t count,
typename Wrapper::HandleType* new_handles,
const CreateInfo* create_infos,
format::ApiCallId create_call_id,
const util::MemoryOutputStream* create_parameter_buffer)
{
assert(create_parameter_buffer != nullptr);
CreateParameters create_parameters = std::make_shared<util::MemoryOutputStream>(
create_parameter_buffer->GetData(), create_parameter_buffer->GetDataSize());
{
AddGroupHandles<ParentHandle, SecondaryHandle, Wrapper, CreateInfo>(
parent_handle, secondary_handle, count, new_handles, create_infos, create_call_id, create_parameters);
}
}
template <typename ParentHandle, typename Wrapper, typename HandleStruct>
void AddStructGroupEntry(ParentHandle parent_handle,
uint32_t count,
HandleStruct* handle_structs,
std::function<Wrapper*(HandleStruct*)> unwrap_struct_handle,
format::ApiCallId create_call_id,
const util::MemoryOutputStream* create_parameter_buffer)
{
assert(handle_structs != nullptr);
assert(unwrap_struct_handle != nullptr);
assert(create_parameter_buffer != nullptr);
CreateParameters create_parameters = std::make_shared<util::MemoryOutputStream>(
create_parameter_buffer->GetData(), create_parameter_buffer->GetDataSize());
std::unique_lock<std::mutex> lock(state_table_mutex_);
for (uint32_t i = 0; i < count; ++i)
{
auto wrapper = unwrap_struct_handle(&handle_structs[i]);
// VkDisplayPlaneProperties::currentDisplay can be a null wrapper.
if ((wrapper != nullptr) && (state_table_.InsertWrapper(wrapper->handle_id, wrapper)))
{
vulkan_state_tracker::InitializeGroupObjectState<ParentHandle, void*, Wrapper, void>(
parent_handle, nullptr, wrapper, nullptr, create_call_id, create_parameters);
}
}
}
void
AddStructGroupEntry(VkInstance parent_handle,
uint32_t count,
VkPhysicalDeviceGroupProperties* handle_structs,
std::function<PhysicalDeviceWrapper*(VkPhysicalDeviceGroupProperties*)> unwrap_struct_handle,
format::ApiCallId create_call_id,
const util::MemoryOutputStream* create_parameter_buffer)
{
assert(handle_structs != nullptr);
assert(create_parameter_buffer != nullptr);
GFXRECON_UNREFERENCED_PARAMETER(unwrap_struct_handle);
CreateParameters create_parameters = std::make_shared<util::MemoryOutputStream>(
create_parameter_buffer->GetData(), create_parameter_buffer->GetDataSize());
for (uint32_t i = 0; i < count; ++i)
{
AddGroupHandles<VkInstance, void*, PhysicalDeviceWrapper, void>(parent_handle,
nullptr,
handle_structs[i].physicalDeviceCount,
handle_structs[i].physicalDevices,
nullptr,
create_call_id,
create_parameters);
}
}
template <typename Wrapper>
void RemoveEntry(typename Wrapper::HandleType handle)
{
if (handle != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<Wrapper*>(handle);
// Scope the state table mutex lock because DestroyState also modifies the state table and will attempt to
// lock the mutex.
{
std::unique_lock<std::mutex> lock(state_table_mutex_);
if (!state_table_.RemoveWrapper(wrapper))
{
GFXRECON_LOG_WARNING(
"Attempting to remove entry from state tracker for object that is not being tracked");
}
}
DestroyState(wrapper);
}
}
void TrackCommand(VkCommandBuffer command_buffer,
format::ApiCallId call_id,
const util::MemoryOutputStream* parameter_buffer)
{
if (command_buffer != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<CommandBufferWrapper*>(command_buffer);
TrackCommandExecution(wrapper, call_id, parameter_buffer);
}
}
template <typename GetHandlesFunc, typename... GetHandlesArgs>
void TrackCommand(VkCommandBuffer command_buffer,
format::ApiCallId call_id,
const util::MemoryOutputStream* parameter_buffer,
GetHandlesFunc func,
GetHandlesArgs... args)
{
if (command_buffer != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<CommandBufferWrapper*>(command_buffer);
TrackCommandExecution(wrapper, call_id, parameter_buffer);
func(wrapper, args...);
}
}
void TrackTrimCommandPool(VkDevice device, VkCommandPool command_pool);
void TrackResetCommandPool(VkCommandPool command_pool);
void TrackPhysicalDeviceMemoryProperties(VkPhysicalDevice physical_device,
const VkPhysicalDeviceMemoryProperties* properties);
void TrackPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physical_device,
uint32_t property_count,
const VkQueueFamilyProperties* properties);
void TrackPhysicalDeviceQueueFamilyProperties2(format::ApiCallId call_id,
VkPhysicalDevice physical_device,
uint32_t property_count,
const VkQueueFamilyProperties2* properties);
void TrackPhysicalDeviceSurfaceSupport(VkPhysicalDevice physical_device,
uint32_t queue_family_index,
VkSurfaceKHR surface,
VkBool32 supported);
void TrackPhysicalDeviceSurfaceCapabilities(VkPhysicalDevice physical_device,
VkSurfaceKHR surface,
const VkSurfaceCapabilitiesKHR* capabilities);
void TrackPhysicalDeviceSurfaceCapabilities2(VkPhysicalDevice physical_device,
const VkPhysicalDeviceSurfaceInfo2KHR& surface_info,
VkSurfaceCapabilities2KHR* surface_capabilities);
void TrackPhysicalDeviceSurfaceFormats(VkPhysicalDevice physical_device,
VkSurfaceKHR surface,
uint32_t format_count,
const VkSurfaceFormatKHR* formats);
void TrackPhysicalDeviceSurfaceFormats2(VkPhysicalDevice physical_device,
const VkPhysicalDeviceSurfaceInfo2KHR& surface_info,
uint32_t surface_format_count,
VkSurfaceFormat2KHR* surface_formats);
void TrackPhysicalDeviceSurfacePresentModes(VkPhysicalDevice physical_device,
VkSurfaceKHR surface,
uint32_t mode_count,
const VkPresentModeKHR* modes,
const void* surface_info_pnext = nullptr);
void TrackDeviceGroupSurfacePresentModes(VkDevice device,
VkSurfaceKHR surface,
VkDeviceGroupPresentModeFlagsKHR* pModes,
const void* surface_info_pnext = nullptr);
void TrackBufferDeviceAddress(VkDevice device, VkBuffer buffer, VkDeviceAddress address);
void TrackBufferMemoryBinding(VkDevice device,
VkBuffer buffer,
VkDeviceMemory memory,
VkDeviceSize memoryOffset,
const void* bind_info_pnext = nullptr);
void TrackImageMemoryBinding(VkDevice device,
VkImage image,
VkDeviceMemory memory,
VkDeviceSize memoryOffset,
const void* bind_info_pnext = nullptr);
void TrackMappedMemory(VkDevice device,
VkDeviceMemory memory,
void* mapped_data,
VkDeviceSize mapped_offset,
VkDeviceSize mapped_size,
VkMemoryMapFlags mapped_flags);
void TrackBeginRenderPass(VkCommandBuffer command_buffer, const VkRenderPassBeginInfo* begin_info);
void TrackEndRenderPass(VkCommandBuffer command_buffer);
void TrackExecuteCommands(VkCommandBuffer command_buffer,
uint32_t command_buffer_count,
const VkCommandBuffer* command_buffers);
void TrackImageBarriers(VkCommandBuffer command_buffer,
uint32_t image_barrier_count,
const VkImageMemoryBarrier* image_barriers);
void TrackImageBarriers2KHR(VkCommandBuffer command_buffer,
uint32_t image_barrier_count,
const VkImageMemoryBarrier2KHR* image_barriers);
void TrackCommandBufferSubmissions(uint32_t submit_count, const VkSubmitInfo* submits);
void TrackCommandBufferSubmissions2(uint32_t submit_count, const VkSubmitInfo2* submits);
void TrackUpdateDescriptorSets(uint32_t write_count,
const VkWriteDescriptorSet* writes,
uint32_t copy_count,
const VkCopyDescriptorSet* copies);
void TrackUpdateDescriptorSetWithTemplate(VkDescriptorSet set,
const UpdateTemplateInfo* template_info,
const void* data);
void TrackResetDescriptorPool(VkDescriptorPool descriptor_pool);
void TrackQueryActivation(VkCommandBuffer command_buffer,
VkQueryPool query_pool,
uint32_t query,
VkQueryControlFlags flags,
uint32_t index);
void
TrackQueryReset(VkCommandBuffer command_buffer, VkQueryPool query_pool, uint32_t first_query, uint32_t query_count);
void TrackQueryReset(VkQueryPool query_pool, uint32_t first_query, uint32_t query_count);
void TrackSemaphoreSignalState(VkSemaphore signal);
void TrackSemaphoreSignalState(uint32_t wait_count,
const VkSemaphore* waits,
uint32_t signal_count,
const VkSemaphore* signals);
void TrackSemaphoreInfoSignalState(uint32_t wait_count,
const VkSemaphoreSubmitInfo* wait_infos,
uint32_t signal_count,
const VkSemaphoreSubmitInfo* signal_infos);
void TrackAcquireImage(
uint32_t image_index, VkSwapchainKHR swapchain, VkSemaphore semaphore, VkFence fence, uint32_t deviceMask);
void TrackPresentedImages(uint32_t count,
const VkSwapchainKHR* swapchains,
const uint32_t* image_indices,
VkQueue queue);
void TrackAccelerationStructureKHRDeviceAddress(VkDevice device,
VkAccelerationStructureKHR accel_struct,
VkDeviceAddress address);
void TrackDeviceMemoryDeviceAddress(VkDevice device, VkDeviceMemory memory, VkDeviceAddress address);
void TrackRayTracingShaderGroupHandles(VkDevice device, VkPipeline pipeline, size_t data_size, const void* data);
void TrackAcquireFullScreenExclusiveMode(VkDevice device, VkSwapchainKHR swapchain);
void TrackReleaseFullScreenExclusiveMode(VkDevice device, VkSwapchainKHR swapchain);
void TrackSetPrivateData(VkDevice device,
VkObjectType objectType,
uint64_t objectHandle,
VkPrivateDataSlot privateDataSlot,
uint64_t data);
void TrackSetLocalDimmingAMD(VkDevice device, VkSwapchainKHR swapChain, VkBool32 localDimmingEnable);
private:
template <typename ParentHandle, typename SecondaryHandle, typename Wrapper, typename CreateInfo>
void AddGroupHandles(ParentHandle parent_handle,
SecondaryHandle secondary_handle,
uint32_t count,
typename Wrapper::HandleType* new_handles,
const CreateInfo* create_infos,
format::ApiCallId create_call_id,
CreateParameters create_parameters)
{
assert(new_handles != nullptr);
assert(create_parameters != nullptr);
std::unique_lock<std::mutex> lock(state_table_mutex_);
for (uint32_t i = 0; i < count; ++i)
{
if (new_handles[i] != VK_NULL_HANDLE)
{
auto wrapper = reinterpret_cast<Wrapper*>(new_handles[i]);
// Adds the handle wrapper to the object state table, filtering for duplicate handle retrieval.
if (state_table_.InsertWrapper(wrapper->handle_id, wrapper))
{
const CreateInfo* create_info = nullptr;
// Not all handle creation operations will have a create info structure (e.g.
// VkPhysicalDevice handles retrieved with vkEnumeratePhysicalDevices).
if (create_infos != nullptr)
{
create_info = vulkan_state_tracker::GetCreateInfoEntry(i, create_infos);
}
vulkan_state_tracker::
InitializeGroupObjectState<ParentHandle, SecondaryHandle, Wrapper, CreateInfo>(
parent_handle, secondary_handle, wrapper, create_info, create_call_id, create_parameters);
}
}
}
}
void TrackCommandExecution(CommandBufferWrapper* wrapper,
format::ApiCallId call_id,
const util::MemoryOutputStream* parameter_buffer);
template <typename Wrapper>
void DestroyState(Wrapper* wrapper)
{
assert(wrapper != nullptr);
wrapper->create_parameters = nullptr;
}
void DestroyState(InstanceWrapper* wrapper);
void DestroyState(DeviceWrapper* wrapper);
void DestroyState(CommandPoolWrapper* wrapper);
void DestroyState(DescriptorPoolWrapper* wrapper);
void DestroyState(SwapchainKHRWrapper* wrapper);
private:
void TrackQuerySubmissions(CommandBufferWrapper* command_wrapper);
std::mutex state_table_mutex_;
VulkanStateTable state_table_;
};
GFXRECON_END_NAMESPACE(encode)
GFXRECON_END_NAMESPACE(gfxrecon)
#endif // GFXRECON_ENCODE_VULKAN_STATE_TRACKER_H
|
