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
|
/*
** Copyright (c) 2018-2020 Valve Corporation
** Copyright (c) 2018-2020 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_DECODE_VALUE_DECODER_H
#define GFXRECON_DECODE_VALUE_DECODER_H
#include "format/format.h"
#include "util/defines.h"
#include "vulkan/vulkan.h"
#include <cassert>
#include <type_traits>
#include <memory.h>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(decode)
class ValueDecoder
{
public:
// clang-format off
// Values
static size_t DecodeInt8Value(const uint8_t* buffer, size_t buffer_size, int8_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeUInt8Value(const uint8_t* buffer, size_t buffer_size, uint8_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeUInt16Value(const uint8_t* buffer, size_t buffer_size, uint16_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeInt32Value(const uint8_t* buffer, size_t buffer_size, int32_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeUInt32Value(const uint8_t* buffer, size_t buffer_size, uint32_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeUInt32BitFieldValue(const uint8_t* buffer, size_t buffer_size, const uint32_t& value) { return 0; }
#if defined(WIN32)
// Oveload for WIN32 LONG type. Pointers from the LONG typedef of unsigned long are not compatible with int32_t pointers.
static size_t DecodeInt32Value(const uint8_t* buffer, size_t buffer_size, long* value) { return DecodeValue(buffer, buffer_size, value); }
// Oveload for WIN32 DWORD type. Pointers from the DWORD typedef of unsigned long are not compatible with uint32_t pointers.
static size_t DecodeUInt32Value(const uint8_t* buffer, size_t buffer_size, unsigned long* value) { return DecodeValue(buffer, buffer_size, value); }
#endif
static size_t DecodeInt64Value(const uint8_t* buffer, size_t buffer_size, int64_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeUInt64Value(const uint8_t* buffer, size_t buffer_size, uint64_t* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeFloatValue(const uint8_t* buffer, size_t buffer_size, float* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeVkBool32Value(const uint8_t* buffer, size_t buffer_size, VkBool32* value) { return DecodeValue(buffer, buffer_size, value); }
static size_t DecodeVkSampleMaskValue(const uint8_t* buffer, size_t buffer_size, VkSampleMask* value) { return DecodeValueFrom<format::SampleMaskEncodeType>(buffer, buffer_size, value); }
static size_t DecodeVkDeviceSizeValue(const uint8_t* buffer, size_t buffer_size, VkDeviceSize* value) { return DecodeValueFrom<format::DeviceSizeEncodeType>(buffer, buffer_size, value); }
static size_t DecodeVkDeviceAddressValue(const uint8_t* buffer, size_t buffer_size, VkDeviceAddress* value) { return DecodeValueFrom<format::DeviceAddressEncodeType>(buffer, buffer_size, value); }
static size_t DecodeSizeTValue(const uint8_t* buffer, size_t buffer_size, size_t* value) { return DecodeValueFrom<format::SizeTEncodeType>(buffer, buffer_size, value); }
#if (defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XLIB_XRANDR_EXT)) && !defined(GFXRECON_ARCH64)
// Oveload for the 32-bit XID type. Pointers from the 32-bit XID typedef of unsigned long are not compatible with size_t pointers.
static size_t DecodeSizeTValue(const uint8_t* buffer, size_t buffer_size, unsigned long* value) { return DecodeValueFrom<format::SizeTEncodeType>(buffer, buffer_size, value); }
#elif defined(WIN32)
#if !defined(GFXRECON_ARCH64)
// Oveload for 32-bit WIN32 SIZE_T type. Pointers from the unsigned long typedef of are not compatible with size_t pointers.
static size_t DecodeSizeTValue(const uint8_t* buffer, size_t buffer_size, SIZE_T* value) { return DecodeValueFrom<format::SizeTEncodeType>(buffer, buffer_size, value); }
#endif
// Oveload for WIN32 LONG_PTR type. Pointers from the LONG_PTR typedef of __int64 / long are not compatible with size_t pointers.
static size_t DecodeSizeTValue(const uint8_t* buffer, size_t buffer_size, LONG_PTR* value) { return DecodeValueFrom<format::SizeTEncodeType>(buffer, buffer_size, value); }
#endif
// Treat pointers to non-Vulkan objects as 64-bit object IDs.
static size_t DecodeAddress(const uint8_t* buffer, size_t buffer_size, uint64_t* value) { return DecodeValueFrom<format::AddressEncodeType>(buffer, buffer_size, value); }
static size_t DecodeVoidPtr(const uint8_t* buffer, size_t buffer_size, uint64_t* value) { return DecodeAddress(buffer, buffer_size, value); }
static size_t DecodeFunctionPtr(const uint8_t* buffer, size_t buffer_size, uint64_t* value) { return DecodeAddress(buffer, buffer_size, value); }
static size_t DecodeHandleIdValue(const uint8_t* buffer, size_t buffer_size, format::HandleId* value) { return DecodeValueFrom<format::HandleEncodeType>(buffer, buffer_size, value); }
template<typename T>
static size_t DecodeEnumValue(const uint8_t* buffer, size_t buffer_size, T* value) { return DecodeValueFrom<format::EnumEncodeType>(buffer, buffer_size, value); }
template<typename T>
static size_t DecodeFlagsValue(const uint8_t* buffer, size_t buffer_size, T* value) { return DecodeValueFrom<format::FlagsEncodeType>(buffer, buffer_size, value); }
template<typename T>
static size_t DecodeFlags64Value(const uint8_t* buffer, size_t buffer_size, T* value) { return DecodeValueFrom<format::Flags64EncodeType>(buffer, buffer_size, value); }
// Arrays
static size_t DecodeInt32Array(const uint8_t* buffer, size_t buffer_size, int32_t* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeUInt32Array(const uint8_t* buffer, size_t buffer_size, uint32_t* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeInt64Array(const uint8_t* buffer, size_t buffer_size, int64_t* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeUInt64Array(const uint8_t* buffer, size_t buffer_size, uint64_t* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeFloatArray(const uint8_t* buffer, size_t buffer_size, float* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeVkBool32Array(const uint8_t* buffer, size_t buffer_size, VkBool32* arr, size_t len) { return DecodeArray(buffer, buffer_size, arr, len); }
static size_t DecodeVkSampleMaskArray(const uint8_t* buffer, size_t buffer_size, VkSampleMask* arr, size_t len) { return DecodeArrayFrom<format::SampleMaskEncodeType>(buffer, buffer_size, arr, len); }
static size_t DecodeVkDeviceSizeArray(const uint8_t* buffer, size_t buffer_size, VkDeviceSize* arr, size_t len) { return DecodeArrayFrom<format::DeviceSizeEncodeType>(buffer, buffer_size, arr, len); }
static size_t DecodeVkDeviceAddressArray(const uint8_t* buffer, size_t buffer_size, VkDeviceAddress* arr, size_t len) { return DecodeArrayFrom<format::DeviceAddressEncodeType>(buffer, buffer_size, arr, len); }
static size_t DecodeSizeTArray(const uint8_t* buffer, size_t buffer_size, size_t* arr, size_t len) { return DecodeArrayFrom<format::SizeTEncodeType>(buffer, buffer_size, arr, len); }
static size_t DecodeUInt8Array(const uint8_t* buffer, size_t buffer_size, void* arr, size_t len) { return DecodeArray(buffer, buffer_size, reinterpret_cast<uint8_t*>(arr), len); }
static size_t DecodeVoidArray(const uint8_t* buffer, size_t buffer_size, void* arr, size_t len) { return DecodeArray(buffer, buffer_size, reinterpret_cast<uint8_t*>(arr), len); }
static size_t DecodeHandleIdArray(const uint8_t* buffer, size_t buffer_size, format::HandleId* arr, size_t len) { return DecodeArrayFrom<format::HandleEncodeType>(buffer, buffer_size, arr, len); }
template<typename T>
static size_t DecodeEnumArray(const uint8_t* buffer, size_t buffer_size, T* arr, size_t len) { return DecodeArrayFrom<format::EnumEncodeType>(buffer, buffer_size, arr, len); }
template<typename T>
static size_t DecodeFlagsArray(const uint8_t* buffer, size_t buffer_size, T* arr, size_t len) { return DecodeArrayFrom<format::FlagsEncodeType>(buffer, buffer_size, arr, len); }
template<typename T>
static size_t DecodeFlags64Array(const uint8_t* buffer, size_t buffer_size, T* arr, size_t len) { return DecodeArrayFrom<format::Flags64EncodeType>(buffer, buffer_size, arr, len); }
// clang-format on
// Perform a type conversion for array elements when the original type has a size that is not equal to the target
// type for conversion.
template <typename SrcT, typename DstT>
static typename std::enable_if<sizeof(SrcT) != sizeof(DstT), size_t>::type
DecodeArrayFrom(const uint8_t* buffer, size_t buffer_size, DstT* arr, size_t len)
{
assert(arr != nullptr);
size_t bytes_read = 0;
size_t data_size = len * sizeof(SrcT);
if (buffer_size >= data_size)
{
for (size_t i = 0; i < len; ++i)
{
SrcT from_value = 0;
bytes_read += DecodeValue((buffer + bytes_read), (buffer_size - bytes_read), &from_value);
arr[i] = TypeCast<DstT>(from_value);
}
}
return bytes_read;
}
// Overload for the case where the original type and the conversion type have matching sizes, where we can skip the
// type conversion.
template <typename SrcT, typename DstT>
static typename std::enable_if<sizeof(SrcT) == sizeof(DstT), size_t>::type
DecodeArrayFrom(const uint8_t* buffer, size_t buffer_size, DstT* arr, size_t len)
{
return DecodeArray(buffer, buffer_size, arr, len);
}
private:
template <typename DstT, typename SrcT>
static typename std::enable_if<!std::is_pointer<SrcT>::value && !std::is_pointer<DstT>::value, DstT>::type
TypeCast(SrcT value)
{
return static_cast<DstT>(value);
}
template <typename DstT, typename SrcT>
static typename std::enable_if<std::is_pointer<SrcT>::value || std::is_pointer<DstT>::value, DstT>::type
TypeCast(SrcT value)
{
return reinterpret_cast<DstT>(value);
}
template <typename T>
static size_t DecodeValue(const uint8_t* buffer, size_t buffer_size, T* value)
{
assert(value != nullptr);
size_t bytes_read = 0;
size_t data_size = sizeof(T);
if (buffer_size >= data_size)
{
bytes_read = data_size;
memcpy(value, buffer, data_size);
}
return bytes_read;
}
template <typename SrcT, typename DstT>
static size_t DecodeValueFrom(const uint8_t* buffer, size_t buffer_size, DstT* value)
{
assert(value != nullptr);
size_t bytes_read = 0;
size_t data_size = sizeof(SrcT);
if (buffer_size >= data_size)
{
SrcT from_type = 0;
bytes_read = data_size;
memcpy(&from_type, buffer, data_size);
(*value) = TypeCast<DstT>(from_type);
}
return bytes_read;
}
template <typename T>
static size_t DecodeArray(const uint8_t* buffer, size_t buffer_size, T* arr, size_t len)
{
assert(arr != nullptr);
size_t bytes_read = 0;
size_t data_size = len * sizeof(T);
if (buffer_size >= data_size)
{
bytes_read = data_size;
memcpy(arr, buffer, data_size);
}
return bytes_read;
}
};
GFXRECON_END_NAMESPACE(decode)
GFXRECON_END_NAMESPACE(gfxrecon)
#endif // GFXRECON_DECODE_VALUE_DECODER_H
|
