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
|
/*
** Copyright (c) 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_VULKAN_RESOURCE_ALLOCATOR_H
#define GFXRECON_DECODE_VULKAN_RESOURCE_ALLOCATOR_H
#include "decode/handle_pointer_decoder.h"
#include "decode/struct_pointer_decoder.h"
#include "format/format.h"
#include "util/defines.h"
#include "vulkan/vulkan.h"
#include <string>
#include <vector>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(decode)
struct DeviceMemoryInfo;
struct BufferInfo;
struct ImageInfo;
class VulkanResourceAllocator
{
public:
typedef uintptr_t ResourceData;
typedef uintptr_t MemoryData;
public:
struct Functions
{
PFN_vkGetPhysicalDeviceProperties get_physical_device_properties{ nullptr };
PFN_vkGetPhysicalDeviceMemoryProperties get_physical_device_memory_properties{ nullptr };
PFN_vkGetPhysicalDeviceMemoryProperties2 get_physical_device_memory_properties2{ nullptr };
PFN_vkAllocateMemory allocate_memory{ nullptr };
PFN_vkFreeMemory free_memory{ nullptr };
PFN_vkGetDeviceMemoryCommitment get_device_memory_commitment{ nullptr };
PFN_vkMapMemory map_memory{ nullptr };
PFN_vkUnmapMemory unmap_memory{ nullptr };
PFN_vkFlushMappedMemoryRanges flush_memory_ranges{ nullptr };
PFN_vkInvalidateMappedMemoryRanges invalidate_memory_ranges{ nullptr };
PFN_vkCreateBuffer create_buffer{ nullptr };
PFN_vkDestroyBuffer destroy_buffer{ nullptr };
PFN_vkGetBufferMemoryRequirements get_buffer_memory_requirements{ nullptr };
PFN_vkGetBufferMemoryRequirements2 get_buffer_memory_requirements2{ nullptr };
PFN_vkBindBufferMemory bind_buffer_memory{ nullptr };
PFN_vkBindBufferMemory2 bind_buffer_memory2{ nullptr };
PFN_vkCmdCopyBuffer cmd_copy_buffer{ nullptr };
PFN_vkCreateImage create_image{ nullptr };
PFN_vkDestroyImage destroy_image{ nullptr };
PFN_vkGetImageMemoryRequirements get_image_memory_requirements{ nullptr };
PFN_vkGetImageMemoryRequirements2 get_image_memory_requirements2{ nullptr };
PFN_vkGetImageSubresourceLayout get_image_subresource_layout{ nullptr };
PFN_vkBindImageMemory bind_image_memory{ nullptr };
PFN_vkBindImageMemory2 bind_image_memory2{ nullptr };
PFN_vkGetInstanceProcAddr get_instance_proc_addr{ nullptr };
PFN_vkGetDeviceProcAddr get_device_proc_addr{ nullptr };
};
public:
virtual ~VulkanResourceAllocator() {}
virtual VkResult Initialize(uint32_t api_version,
VkInstance instance,
VkPhysicalDevice physical_device,
VkDevice device,
const std::vector<std::string>& enabled_device_extensions,
VkPhysicalDeviceType capture_device_type,
const VkPhysicalDeviceMemoryProperties& capture_memory_properties,
const VkPhysicalDeviceMemoryProperties& replay_memory_properties,
const Functions& functions) = 0;
virtual void Destroy() = 0;
virtual VkResult CreateBuffer(const VkBufferCreateInfo* create_info,
const VkAllocationCallbacks* allocation_callbacks,
format::HandleId capture_id,
VkBuffer* buffer,
ResourceData* allocator_data) = 0;
virtual void
DestroyBuffer(VkBuffer buffer, const VkAllocationCallbacks* allocation_callbacks, ResourceData allocator_data) = 0;
virtual VkResult CreateImage(const VkImageCreateInfo* create_info,
const VkAllocationCallbacks* allocation_callbacks,
format::HandleId capture_id,
VkImage* image,
ResourceData* allocator_data) = 0;
virtual void
DestroyImage(VkImage image, const VkAllocationCallbacks* allocation_callbacks, ResourceData allocator_data) = 0;
virtual void GetImageSubresourceLayout(VkImage image,
const VkImageSubresource* subresource,
VkSubresourceLayout* layout,
const VkSubresourceLayout* original_layout,
ResourceData allocator_data) = 0;
virtual VkResult AllocateMemory(const VkMemoryAllocateInfo* allocate_info,
const VkAllocationCallbacks* allocation_callbacks,
format::HandleId capture_id,
VkDeviceMemory* memory,
MemoryData* allocator_data) = 0;
virtual void
FreeMemory(VkDeviceMemory memory, const VkAllocationCallbacks* allocation_callbacks, MemoryData allocator_data) = 0;
virtual void GetDeviceMemoryCommitment(VkDeviceMemory memory,
VkDeviceSize* committed_memory_in_bytes,
MemoryData allocator_data) = 0;
virtual VkResult BindBufferMemory(VkBuffer buffer,
VkDeviceMemory memory,
VkDeviceSize memory_offset,
ResourceData allocator_buffer_data,
MemoryData allocator_memory_data,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
virtual VkResult BindBufferMemory2(uint32_t bind_info_count,
const VkBindBufferMemoryInfo* bind_infos,
const ResourceData* allocator_buffer_datas,
const MemoryData* allocator_memory_datas,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
virtual VkResult BindImageMemory(VkImage image,
VkDeviceMemory memory,
VkDeviceSize memory_offset,
ResourceData allocator_image_data,
MemoryData allocator_memory_data,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
virtual VkResult BindImageMemory2(uint32_t bind_info_count,
const VkBindImageMemoryInfo* bind_infos,
const ResourceData* allocator_image_datas,
const MemoryData* allocator_memory_datas,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
virtual VkResult MapMemory(VkDeviceMemory memory,
VkDeviceSize offset,
VkDeviceSize size,
VkMemoryMapFlags flags,
void** data,
MemoryData allocator_data) = 0;
virtual void UnmapMemory(VkDeviceMemory memory, MemoryData allocator_data) = 0;
virtual VkResult FlushMappedMemoryRanges(uint32_t memory_range_count,
const VkMappedMemoryRange* memory_ranges,
const MemoryData* allocator_datas) = 0;
virtual VkResult InvalidateMappedMemoryRanges(uint32_t memory_range_count,
const VkMappedMemoryRange* memory_ranges,
const MemoryData* allocator_datas) = 0;
// Offset is relative to the start of the pointer returned by vkMapMemory.
virtual VkResult
WriteMappedMemoryRange(MemoryData allocator_data, uint64_t offset, uint64_t size, const uint8_t* data) = 0;
virtual void ReportAllocateMemoryIncompatibility(const VkMemoryAllocateInfo* allocate_info) = 0;
virtual void ReportBindBufferIncompatibility(VkBuffer buffer,
ResourceData allocator_resource_data,
MemoryData allocator_memory_data) = 0;
virtual void ReportBindBuffer2Incompatibility(uint32_t bind_info_count,
const VkBindBufferMemoryInfo* bind_infos,
const ResourceData* allocator_resource_datas,
const MemoryData* allocator_memory_datas) = 0;
virtual void ReportBindImageIncompatibility(VkImage image,
ResourceData allocator_resource_data,
MemoryData allocator_memory_data) = 0;
virtual void ReportBindImage2Incompatibility(uint32_t bind_info_count,
const VkBindImageMemoryInfo* bind_infos,
const ResourceData* allocator_resource_datas,
const MemoryData* allocator_memory_datas) = 0;
// Direct allocation methods that perform memory allocation and resource creation without performing memory
// translation. These methods allow the replay tool to allocate staging resources through the resource allocator so
// that the allocator is aware of all allocations performed at replay.
virtual VkResult CreateBufferDirect(const VkBufferCreateInfo* create_info,
const VkAllocationCallbacks* allocation_callbacks,
VkBuffer* buffer,
ResourceData* allocator_data) = 0;
virtual void DestroyBufferDirect(VkBuffer buffer,
const VkAllocationCallbacks* allocation_callbacks,
ResourceData allocator_data) = 0;
virtual VkResult CreateImageDirect(const VkImageCreateInfo* create_info,
const VkAllocationCallbacks* allocation_callbacks,
VkImage* image,
ResourceData* allocator_data) = 0;
virtual void DestroyImageDirect(VkImage image,
const VkAllocationCallbacks* allocation_callbacks,
ResourceData allocator_data) = 0;
virtual VkResult AllocateMemoryDirect(const VkMemoryAllocateInfo* allocate_info,
const VkAllocationCallbacks* allocation_callbacks,
VkDeviceMemory* memory,
MemoryData* allocator_data) = 0;
virtual void FreeMemoryDirect(VkDeviceMemory memory,
const VkAllocationCallbacks* allocation_callbacks,
MemoryData allocator_data) = 0;
virtual VkResult BindBufferMemoryDirect(VkBuffer buffer,
VkDeviceMemory memory,
VkDeviceSize memory_offset,
ResourceData allocator_buffer_data,
MemoryData allocator_memory_data,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
virtual VkResult BindImageMemoryDirect(VkImage image,
VkDeviceMemory memory,
VkDeviceSize memory_offset,
ResourceData allocator_image_data,
MemoryData allocator_memory_data,
VkMemoryPropertyFlags* bind_memory_properties) = 0;
// Map the memory that the buffer was bound to. The returned pointer references the start of the buffer memory (it
// is the start of the memory the resource was bound to plus the resource bind offset).
virtual VkResult
MapResourceMemoryDirect(VkDeviceSize size, VkMemoryMapFlags flags, void** data, ResourceData allocator_data) = 0;
virtual void UnmapResourceMemoryDirect(ResourceData allocator_data) = 0;
virtual VkResult FlushMappedMemoryRangesDirect(uint32_t memory_range_count,
const VkMappedMemoryRange* memory_ranges,
const MemoryData* allocator_datas) = 0;
virtual VkResult InvalidateMappedMemoryRangesDirect(uint32_t memory_range_count,
const VkMappedMemoryRange* memory_ranges,
const MemoryData* allocator_datas) = 0;
virtual bool SupportsOpaqueDeviceAddresses() = 0;
};
GFXRECON_END_NAMESPACE(decode)
GFXRECON_END_NAMESPACE(gfxrecon)
#endif // GFXRECON_DECODE_VULKAN_RESOURCE_ALLOCATOR_H
|
