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
|
/*
** Copyright (c) 2018 Valve Corporation
** Copyright (c) 2018 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.
*/
#include "decode/descriptor_update_template_decoder.h"
#include "decode/custom_vulkan_struct_decoders.h"
#include "decode/decode_allocator.h"
#include "decode/value_decoder.h"
#include "format/format.h"
#include "generated/generated_vulkan_struct_decoders.h"
#include "util/defines.h"
#include <cassert>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(decode)
DescriptorUpdateTemplateDecoder::DescriptorUpdateTemplateDecoder() :
template_memory_(nullptr), decoded_image_info_(nullptr), decoded_buffer_info_(nullptr),
decoded_texel_buffer_view_handle_ids_(nullptr), image_info_count_(0), buffer_info_count_(0),
texel_buffer_view_count_(0), image_info_(nullptr), buffer_info_(nullptr), texel_buffer_views_(nullptr),
decoded_acceleration_structure_khr_handle_ids_(nullptr), acceleration_structure_khr_count_(0),
acceleration_structures_khr_(nullptr)
{}
DescriptorUpdateTemplateDecoder::~DescriptorUpdateTemplateDecoder() {}
size_t DescriptorUpdateTemplateDecoder::Decode(const uint8_t* buffer, size_t buffer_size)
{
size_t bytes_read = DecodeAttributes(buffer, buffer_size);
// The update template should identify as a struct pointer.
assert(((GetAttributeMask() & format::PointerAttributes::kIsStruct) == format::PointerAttributes::kIsStruct) &&
((GetAttributeMask() & format::PointerAttributes::kIsSingle) == format::PointerAttributes::kIsSingle));
if (!IsNull() && HasData())
{
// Get the total number of encoded values and allocate memory.
bytes_read +=
ValueDecoder::DecodeSizeTValue((buffer + bytes_read), (buffer_size - bytes_read), &image_info_count_);
bytes_read +=
ValueDecoder::DecodeSizeTValue((buffer + bytes_read), (buffer_size - bytes_read), &buffer_info_count_);
bytes_read += ValueDecoder::DecodeSizeTValue(
(buffer + bytes_read), (buffer_size - bytes_read), &texel_buffer_view_count_);
size_t buffer_info_offset = image_info_count_ * sizeof(VkDescriptorImageInfo);
size_t texel_buffer_view_offset = buffer_info_offset + (buffer_info_count_ * sizeof(VkDescriptorBufferInfo));
size_t total_size = texel_buffer_view_offset + (texel_buffer_view_count_ * sizeof(VkBufferView));
assert(template_memory_ == nullptr);
template_memory_ = DecodeAllocator::Allocate<uint8_t>(total_size);
// Read each value type.
if (image_info_count_ > 0)
{
image_info_ = reinterpret_cast<VkDescriptorImageInfo*>(template_memory_);
decoded_image_info_ = DecodeAllocator::Allocate<Decoded_VkDescriptorImageInfo>(image_info_count_);
for (size_t i = 0; i < image_info_count_; ++i)
{
decoded_image_info_[i].decoded_value = &image_info_[i];
bytes_read += DecodeStruct((buffer + bytes_read), (buffer_size - bytes_read), &decoded_image_info_[i]);
}
}
if (buffer_info_count_ > 0)
{
buffer_info_ = reinterpret_cast<VkDescriptorBufferInfo*>(template_memory_ + buffer_info_offset);
decoded_buffer_info_ = DecodeAllocator::Allocate<Decoded_VkDescriptorBufferInfo>(buffer_info_count_);
for (size_t i = 0; i < buffer_info_count_; ++i)
{
decoded_buffer_info_[i].decoded_value = &buffer_info_[i];
bytes_read += DecodeStruct((buffer + bytes_read), (buffer_size - bytes_read), &decoded_buffer_info_[i]);
}
}
if (texel_buffer_view_count_ > 0)
{
texel_buffer_views_ = reinterpret_cast<VkBufferView*>(template_memory_ + texel_buffer_view_offset);
decoded_texel_buffer_view_handle_ids_ =
DecodeAllocator::Allocate<format::HandleId>(texel_buffer_view_count_);
bytes_read += ValueDecoder::DecodeHandleIdArray((buffer + bytes_read),
(buffer_size - bytes_read),
decoded_texel_buffer_view_handle_ids_,
texel_buffer_view_count_);
}
// While there are remaining unread bytes in the buffer, decode the descriptor types which are optional in the
// capture file.
while (bytes_read < buffer_size)
{
size_t struct_count = 0;
size_t current_size = total_size;
bytes_read +=
ValueDecoder::DecodeSizeTValue((buffer + bytes_read), (buffer_size - bytes_read), &struct_count);
if (bytes_read == buffer_size)
{
// A few captures in the wild were written with an uninitialized
// struct_count and no additional bytes. Commit 7d190ac9 fixed the encoding format.
GFXRECON_LOG_WARNING_ONCE(
"A deprecated incorrect encoding of DescriptorUpdateTemplate was detected. This "
"capture is probably invalid. Replay may subsequently fail or crash.");
}
else if (struct_count > 0)
{
VkDescriptorType descriptor_type;
bytes_read +=
ValueDecoder::DecodeEnumValue((buffer + bytes_read), (buffer_size - bytes_read), &descriptor_type);
if (descriptor_type == VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR)
{
acceleration_structure_khr_count_ = struct_count;
total_size =
current_size + (acceleration_structure_khr_count_ * sizeof(VkAccelerationStructureKHR));
// Increase size of template_memory_ to hold these new descriptor structs.
uint8_t* current_template_memory = template_memory_;
template_memory_ = DecodeAllocator::Allocate<uint8_t>(total_size);
if (current_size > 0)
{
util::platform::MemoryCopy(template_memory_, total_size, current_template_memory, current_size);
}
acceleration_structures_khr_ =
reinterpret_cast<VkAccelerationStructureKHR*>(template_memory_ + current_size);
decoded_acceleration_structure_khr_handle_ids_ =
DecodeAllocator::Allocate<format::HandleId>(acceleration_structure_khr_count_);
bytes_read += ValueDecoder::DecodeHandleIdArray((buffer + bytes_read),
(buffer_size - bytes_read),
decoded_acceleration_structure_khr_handle_ids_,
acceleration_structure_khr_count_);
}
else
{
// If descriptor_type is not recognized, it is possible the capture file was created with a
// newer version of the capture layer that had support for additional optional descriptor types.
// Display a warning and exit the processing loop.
GFXRECON_LOG_WARNING("Unrecognized VkDescriptorType %d found when decoding data for descriptor "
"update with template.",
static_cast<int>(descriptor_type));
break;
}
}
}
assert(bytes_read <= buffer_size);
}
return bytes_read;
}
GFXRECON_END_NAMESPACE(decode)
GFXRECON_END_NAMESPACE(gfxrecon)
|
