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
|
/*
** 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_WRITER_H
#define GFXRECON_ENCODE_VULKAN_STATE_WRITER_H
#include "encode/parameter_encoder.h"
#include "encode/vulkan_handle_wrappers.h"
#include "generated/generated_vulkan_state_table.h"
#include "format/format.h"
#include "format/platform_types.h"
#include "generated/generated_vulkan_dispatch_table.h"
#include "util/compressor.h"
#include "util/defines.h"
#include "util/file_output_stream.h"
#include "util/memory_output_stream.h"
#include "vulkan/vulkan.h"
#include <set>
#include <vector>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(encode)
class VulkanStateWriter
{
public:
VulkanStateWriter(util::FileOutputStream* output_stream, util::Compressor* compressor, format::ThreadId thread_id);
~VulkanStateWriter();
// Returns number of bytes written to the output_stream.
void WriteState(const VulkanStateTable& state_table, uint64_t frame_number);
private:
// Data structures for processing resource memory snapshots.
struct BufferSnapshotInfo
{
const BufferWrapper* buffer_wrapper{ nullptr };
const DeviceMemoryWrapper* memory_wrapper{ nullptr };
VkMemoryPropertyFlags memory_properties{};
bool need_staging_copy{ false };
};
struct ImageSnapshotInfo
{
const ImageWrapper* image_wrapper{ nullptr };
const DeviceMemoryWrapper* memory_wrapper{ nullptr };
VkMemoryPropertyFlags memory_properties{};
bool need_staging_copy{ false };
VkImageAspectFlagBits aspect{};
VkDeviceSize resource_size{ 0 }; // Combined size of all sub-resources.
std::vector<uint64_t> level_sizes; // Combined size of all layers in a mip level.
};
struct ResourceSnapshotInfo
{
std::vector<BufferSnapshotInfo> buffers;
std::vector<ImageSnapshotInfo> images;
};
typedef std::unordered_map<uint32_t, ResourceSnapshotInfo> ResourceSnapshotQueueFamilyTable;
typedef std::unordered_map<const DeviceWrapper*, ResourceSnapshotQueueFamilyTable> DeviceResourceTables;
struct QueryActivationData
{
format::HandleId pool_id{ format::kNullHandleId };
VkQueryType type{};
VkQueryControlFlags flags{ 0 };
uint32_t index{ 0 };
uint32_t type_index{ 0 };
};
typedef std::vector<QueryActivationData> QueryActivationList;
typedef std::unordered_map<uint32_t, QueryActivationList> QueryActivationQueueFamilyTable;
private:
void WritePhysicalDeviceState(const VulkanStateTable& state_table);
void WriteDeviceState(const VulkanStateTable& state_table);
void WriteCommandBufferState(const VulkanStateTable& state_table);
void WriteTrimCommandPool(const VulkanStateTable& state_table);
void WritePrivateDataSlotState(const VulkanStateTable& state_table);
void WriteFenceState(const VulkanStateTable& state_table);
void WriteEventState(const VulkanStateTable& state_table);
void WriteSemaphoreState(const VulkanStateTable& state_table);
void WriteBufferViewState(const VulkanStateTable& state_table);
void WriteImageViewState(const VulkanStateTable& state_table);
void WriteFramebufferState(const VulkanStateTable& state_table);
void WritePipelineLayoutState(const VulkanStateTable& state_table);
void WritePipelineState(const VulkanStateTable& state_table);
void WriteDescriptorSetState(const VulkanStateTable& state_table);
void WriteQueryPoolState(const VulkanStateTable& state_table);
void WriteSurfaceKhrState(const VulkanStateTable& state_table);
void WriteSwapchainKhrState(const VulkanStateTable& state_table);
void WriteBufferState(const VulkanStateTable& state_table);
void WriteDeviceMemoryState(const VulkanStateTable& state_table);
void WriteAccelerationStructureKHRState(const VulkanStateTable& state_table);
void
ProcessHardwareBuffer(format::HandleId memory_id, AHardwareBuffer* hardware_buffer, VkDeviceSize allocation_size);
void ProcessBufferMemory(const DeviceWrapper* device_wrapper,
const std::vector<BufferSnapshotInfo>& buffer_snapshot_info,
uint32_t queue_family_index,
VkQueue queue,
VkCommandBuffer command_buffer,
VkBuffer staging_buffer,
VkDeviceMemory staging_memory,
bool is_staging_memory_coherent);
void ProcessImageMemory(const DeviceWrapper* device_wrapper,
const std::vector<ImageSnapshotInfo>& image_snapshot_info,
uint32_t queue_family_index,
VkQueue queue,
VkCommandBuffer command_buffer,
VkBuffer staging_buffer,
VkDeviceMemory staging_memory,
bool is_staging_memory_coherent,
const VulkanStateTable& state_table);
void WriteBufferMemoryState(const VulkanStateTable& state_table,
DeviceResourceTables* resources,
VkDeviceSize* max_resource_size,
VkDeviceSize* max_staging_copy_size);
void WriteImageMemoryState(const VulkanStateTable& state_table,
DeviceResourceTables* resources,
VkDeviceSize* max_resource_size,
VkDeviceSize* max_staging_copy_size);
void WriteImageSubresourceLayouts(const ImageWrapper* image_wrapper, VkImageAspectFlags aspect_flags);
void WriteResourceMemoryState(const VulkanStateTable& state_table);
void WriteMappedMemoryState(const VulkanStateTable& state_table);
void WriteSwapchainImageState(const VulkanStateTable& state_table);
void WritePhysicalDevicePropertiesMetaData(const PhysicalDeviceWrapper* physical_device_wrapper);
template <typename T>
void WriteGetPhysicalDeviceQueueFamilyProperties(format::ApiCallId call_id,
format::HandleId physical_device_id,
uint32_t property_count,
T* properties);
void WriteGetPhysicalDeviceSurfaceSupport(format::HandleId physical_device_id,
uint32_t queue_family_index,
format::HandleId surface_id,
VkBool32 supported);
void WriteGetPhysicalDeviceSurfaceCapabilities(format::HandleId physical_device_id,
format::HandleId surface_id,
const SurfaceCapabilities& capabilities,
const VulkanStateTable& state_table);
void WriteGetPhysicalDeviceSurfaceFormats(format::HandleId physical_device_id,
format::HandleId surface_id,
const SurfaceFormats& formats,
const VulkanStateTable& state_table);
void WriteGetPhysicalDeviceSurfacePresentModes(format::HandleId physical_device_id,
format::HandleId surface_id,
const SurfacePresentModes& present_modes,
const VulkanStateTable& state_table);
void WriteGetDeviceGroupSurfacePresentModes(format::HandleId device_id,
format::HandleId surface_id,
const GroupSurfacePresentModes& present_modes,
const VulkanStateTable& state_table);
void WriteCommandProcessingCreateCommands(format::HandleId device_id,
uint32_t queue_family_index,
format::HandleId queue_id,
format::HandleId command_pool_id,
format::HandleId command_buffer_id);
void WriteCommandBegin(format::HandleId command_buffer_id);
void WriteCommandEnd(format::HandleId command_buffer_id);
void WriteCommandExecution(format::HandleId queue_id,
uint32_t command_buffer_count,
const format::HandleId* command_buffer_ids,
uint32_t signal_semaphore_count,
const format::HandleId* signal_semaphore_ids,
uint32_t wait_semaphore_count,
const format::HandleId* wait_semaphore_ids,
const VkPipelineStageFlags* wait_dst_stage_mask);
void WriteCommandExecution(format::HandleId queue_id, format::HandleId command_buffer_id)
{
WriteCommandExecution(queue_id, 1, &command_buffer_id, 0, nullptr, 0, nullptr, nullptr);
}
void WriteCommandBufferCommands(const CommandBufferWrapper* wrapper, const VulkanStateTable& state_table);
void WriteDescriptorUpdateCommand(format::HandleId device_id,
const DescriptorInfo* binding,
VkWriteDescriptorSet* write);
void WriteQueryPoolReset(format::HandleId device_id,
const std::vector<const QueryPoolWrapper*>& query_pool_wrappers);
void WriteQueryActivation(format::HandleId device_id,
uint32_t queue_family_index,
const QueryActivationList& active_queries);
void WriteCreateFence(format::HandleId device_id, format::HandleId fence_id, bool signaled);
void WriteSetEvent(format::HandleId device_id, format::HandleId event_id);
void WriteSignalSemaphoreValue(format::ApiCallId api_call_id,
format::HandleId device_id,
format::HandleId semaphore,
uint64_t value);
void WriteDestroyDeviceObject(format::ApiCallId call_id,
format::HandleId device_id,
format::HandleId object_id,
const VkAllocationCallbacks* allocator);
void DestroyTemporaryDeviceObject(format::ApiCallId call_id,
format::HandleId object_id,
const util::MemoryOutputStream* create_parameters);
void WriteFunctionCall(format::ApiCallId call_id, util::MemoryOutputStream* parameter_buffer);
void WriteFillMemoryCmd(format::HandleId memory_id, VkDeviceSize offset, VkDeviceSize size, const void* data);
void WriteResizeWindowCmd(format::HandleId surface_id, uint32_t width, uint32_t height);
void WriteResizeWindowCmd2(format::HandleId surface_id,
uint32_t width,
uint32_t height,
VkSurfaceTransformFlagBitsKHR pre_transform);
void WriteCreateHardwareBufferCmd(format::HandleId memory_id,
AHardwareBuffer* hardware_buffer,
const std::vector<format::HardwareBufferPlaneInfo>& plane_info);
void WriteSetDevicePropertiesCommand(format::HandleId physical_device_id,
const VkPhysicalDeviceProperties& properties);
void WriteSetDeviceMemoryPropertiesCommand(format::HandleId physical_device_id,
const VkPhysicalDeviceMemoryProperties& memory_properties);
void WriteSetOpaqueAddressCommand(format::HandleId device_id, format::HandleId object_id, VkDeviceAddress address);
void WriteSetRayTracingShaderGroupHandlesCommand(format::HandleId device_id,
format::HandleId pipeline_id,
size_t data_size,
const void* data);
template <typename Wrapper>
void StandardCreateWrite(const VulkanStateTable& state_table)
{
std::set<util::MemoryOutputStream*> processed;
state_table.VisitWrappers([&](const Wrapper* wrapper) {
// Filter duplicate entries for calls that create multiple objects, where objects created by the same call
// all reference the same parameter buffer.
if (processed.find(wrapper->create_parameters.get()) == processed.end())
{
WriteFunctionCall(wrapper->create_call_id, wrapper->create_parameters.get());
processed.insert(wrapper->create_parameters.get());
}
});
}
VkMemoryPropertyFlags GetMemoryProperties(const DeviceWrapper* device_wrapper,
const DeviceMemoryWrapper* memory_wrapper,
const VulkanStateTable& state_table);
bool FindMemoryTypeIndex(const DeviceWrapper* device_wrapper,
uint32_t memory_type_bits,
VkMemoryPropertyFlags desired_flags,
uint32_t* found_index,
VkMemoryPropertyFlags* found_flags,
const VulkanStateTable& state_table) const;
void InvalidateMappedMemoryRange(const DeviceWrapper* device_wrapper,
VkDeviceMemory memory,
VkDeviceSize offset,
VkDeviceSize size);
void GetFenceStatus(const DeviceWrapper* device_wrapper, VkFence fence, bool* result);
VkQueue GetQueue(const DeviceWrapper* device_wrapper, uint32_t queue_family_index, uint32_t queue_index);
VkCommandPool GetCommandPool(const DeviceWrapper* device_wrapper, uint32_t queue_family_index);
VkCommandBuffer GetCommandBuffer(const DeviceWrapper* device_wrapper, VkCommandPool command_pool);
VkResult SubmitCommandBuffer(VkQueue queue, VkCommandBuffer command_buffer, const DeviceTable* device_table);
VkResult CreateStagingBuffer(const DeviceWrapper* device_wrapper,
VkDeviceSize size,
VkBuffer* buffer,
VkDeviceMemory* memory,
VkMemoryPropertyFlags* memory_property_flags,
const VulkanStateTable& state_table);
VkResult ResolveImage(const DeviceWrapper* device_wrapper,
const ImageWrapper* image_wrapper,
VkQueue queue,
VkCommandBuffer command_buffer,
VkImage* resolve_image,
VkDeviceMemory* resolve_memory,
const VulkanStateTable& state_table);
VkImageAspectFlags GetFormatAspectMask(VkFormat format);
void GetFormatAspects(VkFormat format, std::vector<VkImageAspectFlagBits>* aspects, bool* combined_depth_stencil);
VkFormat GetImageAspectFormat(VkFormat format, VkImageAspectFlagBits aspect);
void GetImageSizes(const ImageWrapper* image_wrapper, ImageSnapshotInfo* info);
bool CheckCommandHandles(const CommandBufferWrapper* wrapper, const VulkanStateTable& state_table);
bool
CheckCommandHandle(CommandHandleType handle_type, format::HandleId handle, const VulkanStateTable& state_table);
bool CheckDescriptorStatus(const DescriptorInfo* descriptor,
uint32_t index,
const VulkanStateTable& state_table,
VkDescriptorType* descriptor_type);
bool IsBufferValid(format::HandleId buffer_id, const VulkanStateTable& state_table);
bool IsBufferViewValid(format::HandleId view_id, const VulkanStateTable& state_table);
bool IsImageValid(format::HandleId image_id, const VulkanStateTable& state_table);
bool IsImageViewValid(format::HandleId view_id, const VulkanStateTable& state_table);
bool IsFramebufferValid(format::HandleId framebuffer_id, const VulkanStateTable& state_table);
bool IsFramebufferValid(const FramebufferWrapper* framebuffer_wrapper, const VulkanStateTable& state_table);
private:
util::FileOutputStream* output_stream_;
util::Compressor* compressor_;
std::vector<uint8_t> compressed_parameter_buffer_;
format::ThreadId thread_id_;
util::MemoryOutputStream parameter_stream_;
ParameterEncoder encoder_;
};
GFXRECON_END_NAMESPACE(encode)
GFXRECON_END_NAMESPACE(gfxrecon)
#endif // GFXRECON_ENCODE_VULKAN_STATE_WRITER_H
|
