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
|
/*
* Copyright 2019-2021 Diligent Graphics LLC
* Copyright 2015-2019 Egor Yusov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* In no event and under no legal theory, whether in tort (including negligence),
* contract, or otherwise, unless required by applicable law (such as deliberate
* and grossly negligent acts) or agreed to in writing, shall any Contributor be
* liable for any damages, including any direct, indirect, special, incidental,
* or consequential damages of any character arising as a result of this License or
* out of the use or inability to use the software (including but not limited to damages
* for loss of goodwill, work stoppage, computer failure or malfunction, or any and
* all other commercial damages or losses), even if such Contributor has been advised
* of the possibility of such damages.
*/
#pragma once
#include <mutex>
#include "VulkanUtilities/VulkanHeaders.h"
#include "VulkanUtilities/VulkanMemoryManager.hpp"
#include "VulkanUtilities/VulkanLogicalDevice.hpp"
#include "VulkanUtilities/VulkanObjectWrappers.hpp"
#include "DynamicHeap.hpp"
namespace Diligent
{
// Vulkand dynamic heap implementation consists of a number of dynamic heaps, one per context.
// Every dynamic heap suballocates chunk of memory from the global memory manager. Within
// every chunk, memory is allocated in a simple lock-free linear fashion. All used allocations are discarded
// when FinishFrame() is called
class RenderDeviceVkImpl;
class VulkanRingBuffer;
class VulkanDynamicMemoryManager;
// sizeof(VulkanDynamicAllocation) must be at least 16 to avoid false cache line sharing problems
struct VulkanDynamicAllocation
{
VulkanDynamicAllocation() noexcept {}
// clang-format off
VulkanDynamicAllocation(VulkanDynamicMemoryManager& _DynamicMemMgr, size_t _AlignedOffset, size_t _Size) noexcept :
pDynamicMemMgr{&_DynamicMemMgr},
AlignedOffset {_AlignedOffset },
Size {_Size }
{}
VulkanDynamicAllocation (const VulkanDynamicAllocation&) = delete;
VulkanDynamicAllocation& operator = (const VulkanDynamicAllocation&) = delete;
VulkanDynamicAllocation (VulkanDynamicAllocation&& rhs)noexcept :
pDynamicMemMgr{rhs.pDynamicMemMgr},
AlignedOffset {rhs.AlignedOffset },
Size {rhs.Size }
#ifdef DILIGENT_DEVELOPMENT
, dvpFrameNumber{rhs.dvpFrameNumber}
#endif
{
rhs.pDynamicMemMgr = nullptr;
rhs.AlignedOffset = 0;
rhs.Size = 0;
#ifdef DILIGENT_DEVELOPMENT
rhs.dvpFrameNumber = 0;
#endif
}
// clang-format on
VulkanDynamicAllocation& operator=(VulkanDynamicAllocation&& rhs) noexcept // Must be noexcept on MSVC, so can't use = default
{
pDynamicMemMgr = rhs.pDynamicMemMgr;
AlignedOffset = rhs.AlignedOffset;
Size = rhs.Size;
rhs.pDynamicMemMgr = nullptr;
rhs.AlignedOffset = 0;
rhs.Size = 0;
#ifdef DILIGENT_DEVELOPMENT
dvpFrameNumber = rhs.dvpFrameNumber;
rhs.dvpFrameNumber = 0;
#endif
return *this;
}
VulkanDynamicMemoryManager* pDynamicMemMgr = nullptr;
size_t AlignedOffset = 0; // Offset from the start of the buffer
size_t Size = 0; // Reserved size of this allocation
#ifdef DILIGENT_DEVELOPMENT
Uint64 dvpFrameNumber = 0;
#endif
};
// VulkanDynamicMemoryManager manages allocation of master blocks from global dynamic buffer
//
// _______________________________________________________________________
// | |
// | VulkanDynamicMemoryManager |
// | |
// | || - - - - - - - - - - Dynamic Memory Buffer- - - - - - - - - -|| |
// | || MasterBlock[0] | MasterBlock[1] | ... | MasterBlock[N-1] || |
// |_______________________________________________________________________|
//
// We cannot use global memory manager for dynamic resources because they
// need to use the same Vulkan buffer
class VulkanDynamicMemoryManager : public DynamicHeap::MasterBlockListBasedManager
{
public:
using TBase = DynamicHeap::MasterBlockListBasedManager;
using OffsetType = TBase::OffsetType;
using MasterBlock = TBase::MasterBlock;
VulkanDynamicMemoryManager(IMemoryAllocator& Allocator,
class RenderDeviceVkImpl& DeviceVk,
Uint32 Size,
Uint64 CommandQueueMask);
~VulkanDynamicMemoryManager();
// clang-format off
VulkanDynamicMemoryManager (const VulkanDynamicMemoryManager&) = delete;
VulkanDynamicMemoryManager ( VulkanDynamicMemoryManager&&) = delete;
VulkanDynamicMemoryManager& operator= (const VulkanDynamicMemoryManager&) = delete;
VulkanDynamicMemoryManager& operator= ( VulkanDynamicMemoryManager&&) = delete;
VkBuffer GetVkBuffer() const{return m_VkBuffer;}
Uint8* GetCPUAddress()const{return m_CPUAddress;}
// clang-format on
void Destroy();
static constexpr const Uint32 MasterBlockAlignment = 1024;
MasterBlock AllocateMasterBlock(OffsetType SizeInBytes, OffsetType Alignment);
private:
RenderDeviceVkImpl& m_DeviceVk;
VulkanUtilities::BufferWrapper m_VkBuffer;
VulkanUtilities::DeviceMemoryWrapper m_BufferMemory;
Uint8* m_CPUAddress;
const VkDeviceSize m_DefaultAlignment;
const Uint64 m_CommandQueueMask;
OffsetType m_TotalPeakSize = 0;
};
// Dynamic heap is used by a device context to allocate dynamic space when
// mapping a buffer or a texture. This is very similar to upload heap,
// however dynamic heap uses special persistently mapped buffer while
// upload heap uses global memory manager.
//
// The heap allocates master blocks from the global dynamic memory manager.
// The pages are released and returned to the manager at the end of every frame.
//
// _______________________________________________________________________________________________________________________________
// | |
// | VulkanDynamicHeap |
// | |
// | || - - - - - - - - - MasterBlock[0]- - - - - - - - -|| || - - - - - - - - - MasterBlock[1]- - - - - - - - -|| |
// | || Allocation0 | Allocation1 | ... | AllocationN || || Allocation0 | Allocation1 | ... | AllocationM || ... |
// |__________|____________________________________________________________________________________________________________________|
// | A |
// | | |
// |Allocate() AllocateMasterBlock()| |FinishFrame()
// | ______|___________________V____
// V | |
// | VulkanDynamicMemoryManager |
// | |
// | |Global dynamic buffer| |
// |______________________________|
//
class VulkanDynamicHeap
{
public:
// clang-format off
VulkanDynamicHeap(VulkanDynamicMemoryManager& DynamicMemMgr, std::string HeapName, Uint32 PageSize) :
m_GlobalDynamicMemMgr{DynamicMemMgr},
m_HeapName {std::move(HeapName)},
m_MasterBlockSize (PageSize)
{}
VulkanDynamicHeap (const VulkanDynamicHeap&) = delete;
VulkanDynamicHeap (VulkanDynamicHeap&&) = delete;
VulkanDynamicHeap& operator= (const VulkanDynamicHeap&) = delete;
VulkanDynamicHeap& operator= (VulkanDynamicHeap&&) = delete;
// clang-format on
~VulkanDynamicHeap();
VulkanDynamicAllocation Allocate(Uint32 SizeInBytes, Uint32 Alignment);
// Releases all master blocks that are later returned to the global dynamic memory manager.
// CmdQueueMask indicates which command queues the allocations from this heap were used
// with during the last frame.
// As global dynamic memory manager is hosted by the render device, the dynamic heap can
// be destroyed before the blocks are actually returned to the global dynamic memory manager.
void ReleaseMasterBlocks(RenderDeviceVkImpl& DeviceVkImpl, Uint64 CmdQueueMask);
using OffsetType = VulkanDynamicMemoryManager::OffsetType;
using MasterBlock = VulkanDynamicMemoryManager::MasterBlock;
static constexpr OffsetType InvalidOffset = static_cast<OffsetType>(-1);
size_t GetAllocatedMasterBlockCount() const { return m_MasterBlocks.size(); }
private:
VulkanDynamicMemoryManager& m_GlobalDynamicMemMgr;
const std::string m_HeapName;
std::vector<MasterBlock> m_MasterBlocks;
OffsetType m_CurrOffset = InvalidOffset;
const Uint32 m_MasterBlockSize;
Uint32 m_AvailableSize = 0;
Uint32 m_CurrAlignedSize = 0;
Uint32 m_CurrUsedSize = 0;
Uint32 m_PeakAlignedSize = 0;
Uint32 m_PeakUsedSize = 0;
Uint32 m_CurrAllocatedSize = 0;
Uint32 m_PeakAllocatedSize = 0;
};
} // namespace Diligent
|
