Line data Source code
1 : //
2 : // Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved.
3 : //
4 : // Permission is hereby granted, free of charge, to any person obtaining a copy
5 : // of this software and associated documentation files (the "Software"), to deal
6 : // in the Software without restriction, including without limitation the rights
7 : // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 : // copies of the Software, and to permit persons to whom the Software is
9 : // furnished to do so, subject to the following conditions:
10 : //
11 : // The above copyright notice and this permission notice shall be included in
12 : // all copies or substantial portions of the Software.
13 : //
14 : // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 : // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 : // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 : // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 : // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 : // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 : // THE SOFTWARE.
21 : //
22 :
23 : #ifndef AMD_VULKAN_MEMORY_ALLOCATOR_H
24 : #define AMD_VULKAN_MEMORY_ALLOCATOR_H
25 :
26 : /** \mainpage Vulkan Memory Allocator
27 :
28 : <b>Version 3.0.1 (2022-05-26)</b>
29 :
30 : Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. \n
31 : License: MIT
32 :
33 : <b>API documentation divided into groups:</b> [Modules](modules.html)
34 :
35 : \section main_table_of_contents Table of contents
36 :
37 : - <b>User guide</b>
38 : - \subpage quick_start
39 : - [Project setup](@ref quick_start_project_setup)
40 : - [Initialization](@ref quick_start_initialization)
41 : - [Resource allocation](@ref quick_start_resource_allocation)
42 : - \subpage choosing_memory_type
43 : - [Usage](@ref choosing_memory_type_usage)
44 : - [Required and preferred flags](@ref choosing_memory_type_required_preferred_flags)
45 : - [Explicit memory types](@ref choosing_memory_type_explicit_memory_types)
46 : - [Custom memory pools](@ref choosing_memory_type_custom_memory_pools)
47 : - [Dedicated allocations](@ref choosing_memory_type_dedicated_allocations)
48 : - \subpage memory_mapping
49 : - [Mapping functions](@ref memory_mapping_mapping_functions)
50 : - [Persistently mapped memory](@ref memory_mapping_persistently_mapped_memory)
51 : - [Cache flush and invalidate](@ref memory_mapping_cache_control)
52 : - \subpage staying_within_budget
53 : - [Querying for budget](@ref staying_within_budget_querying_for_budget)
54 : - [Controlling memory usage](@ref staying_within_budget_controlling_memory_usage)
55 : - \subpage resource_aliasing
56 : - \subpage custom_memory_pools
57 : - [Choosing memory type index](@ref custom_memory_pools_MemTypeIndex)
58 : - [Linear allocation algorithm](@ref linear_algorithm)
59 : - [Free-at-once](@ref linear_algorithm_free_at_once)
60 : - [Stack](@ref linear_algorithm_stack)
61 : - [Double stack](@ref linear_algorithm_double_stack)
62 : - [Ring buffer](@ref linear_algorithm_ring_buffer)
63 : - \subpage defragmentation
64 : - \subpage statistics
65 : - [Numeric statistics](@ref statistics_numeric_statistics)
66 : - [JSON dump](@ref statistics_json_dump)
67 : - \subpage allocation_annotation
68 : - [Allocation user data](@ref allocation_user_data)
69 : - [Allocation names](@ref allocation_names)
70 : - \subpage virtual_allocator
71 : - \subpage debugging_memory_usage
72 : - [Memory initialization](@ref debugging_memory_usage_initialization)
73 : - [Margins](@ref debugging_memory_usage_margins)
74 : - [Corruption detection](@ref debugging_memory_usage_corruption_detection)
75 : - \subpage opengl_interop
76 : - \subpage usage_patterns
77 : - [GPU-only resource](@ref usage_patterns_gpu_only)
78 : - [Staging copy for upload](@ref usage_patterns_staging_copy_upload)
79 : - [Readback](@ref usage_patterns_readback)
80 : - [Advanced data uploading](@ref usage_patterns_advanced_data_uploading)
81 : - [Other use cases](@ref usage_patterns_other_use_cases)
82 : - \subpage configuration
83 : - [Pointers to Vulkan functions](@ref config_Vulkan_functions)
84 : - [Custom host memory allocator](@ref custom_memory_allocator)
85 : - [Device memory allocation callbacks](@ref allocation_callbacks)
86 : - [Device heap memory limit](@ref heap_memory_limit)
87 : - <b>Extension support</b>
88 : - \subpage vk_khr_dedicated_allocation
89 : - \subpage enabling_buffer_device_address
90 : - \subpage vk_ext_memory_priority
91 : - \subpage vk_amd_device_coherent_memory
92 : - \subpage general_considerations
93 : - [Thread safety](@ref general_considerations_thread_safety)
94 : - [Versioning and compatibility](@ref general_considerations_versioning_and_compatibility)
95 : - [Validation layer warnings](@ref general_considerations_validation_layer_warnings)
96 : - [Allocation algorithm](@ref general_considerations_allocation_algorithm)
97 : - [Features not supported](@ref general_considerations_features_not_supported)
98 :
99 : \section main_see_also See also
100 :
101 : - [**Product page on GPUOpen**](https://gpuopen.com/gaming-product/vulkan-memory-allocator/)
102 : - [**Source repository on GitHub**](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator)
103 :
104 : \defgroup group_init Library initialization
105 :
106 : \brief API elements related to the initialization and management of the entire library, especially #VmaAllocator object.
107 :
108 : \defgroup group_alloc Memory allocation
109 :
110 : \brief API elements related to the allocation, deallocation, and management of Vulkan memory, buffers, images.
111 : Most basic ones being: vmaCreateBuffer(), vmaCreateImage().
112 :
113 : \defgroup group_virtual Virtual allocator
114 :
115 : \brief API elements related to the mechanism of \ref virtual_allocator - using the core allocation algorithm
116 : for user-defined purpose without allocating any real GPU memory.
117 :
118 : \defgroup group_stats Statistics
119 :
120 : \brief API elements that query current status of the allocator, from memory usage, budget, to full dump of the internal state in JSON format.
121 : See documentation chapter: \ref statistics.
122 : */
123 :
124 :
125 : #ifdef __cplusplus
126 : extern "C" {
127 : #endif
128 :
129 : #ifndef VULKAN_H_
130 : #include <vulkan/vulkan.h>
131 : #endif
132 :
133 : // Define this macro to declare maximum supported Vulkan version in format AAABBBCCC,
134 : // where AAA = major, BBB = minor, CCC = patch.
135 : // If you want to use version > 1.0, it still needs to be enabled via VmaAllocatorCreateInfo::vulkanApiVersion.
136 : #if !defined(VMA_VULKAN_VERSION)
137 : #if defined(VK_VERSION_1_3)
138 : #define VMA_VULKAN_VERSION 1003000
139 : #elif defined(VK_VERSION_1_2)
140 : #define VMA_VULKAN_VERSION 1002000
141 : #elif defined(VK_VERSION_1_1)
142 : #define VMA_VULKAN_VERSION 1001000
143 : #else
144 : #define VMA_VULKAN_VERSION 1000000
145 : #endif
146 : #endif
147 :
148 : #if defined(__ANDROID__) && defined(VK_NO_PROTOTYPES) && VMA_STATIC_VULKAN_FUNCTIONS
149 : extern PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr;
150 : extern PFN_vkGetDeviceProcAddr vkGetDeviceProcAddr;
151 : extern PFN_vkGetPhysicalDeviceProperties vkGetPhysicalDeviceProperties;
152 : extern PFN_vkGetPhysicalDeviceMemoryProperties vkGetPhysicalDeviceMemoryProperties;
153 : extern PFN_vkAllocateMemory vkAllocateMemory;
154 : extern PFN_vkFreeMemory vkFreeMemory;
155 : extern PFN_vkMapMemory vkMapMemory;
156 : extern PFN_vkUnmapMemory vkUnmapMemory;
157 : extern PFN_vkFlushMappedMemoryRanges vkFlushMappedMemoryRanges;
158 : extern PFN_vkInvalidateMappedMemoryRanges vkInvalidateMappedMemoryRanges;
159 : extern PFN_vkBindBufferMemory vkBindBufferMemory;
160 : extern PFN_vkBindImageMemory vkBindImageMemory;
161 : extern PFN_vkGetBufferMemoryRequirements vkGetBufferMemoryRequirements;
162 : extern PFN_vkGetImageMemoryRequirements vkGetImageMemoryRequirements;
163 : extern PFN_vkCreateBuffer vkCreateBuffer;
164 : extern PFN_vkDestroyBuffer vkDestroyBuffer;
165 : extern PFN_vkCreateImage vkCreateImage;
166 : extern PFN_vkDestroyImage vkDestroyImage;
167 : extern PFN_vkCmdCopyBuffer vkCmdCopyBuffer;
168 : #if VMA_VULKAN_VERSION >= 1001000
169 : extern PFN_vkGetBufferMemoryRequirements2 vkGetBufferMemoryRequirements2;
170 : extern PFN_vkGetImageMemoryRequirements2 vkGetImageMemoryRequirements2;
171 : extern PFN_vkBindBufferMemory2 vkBindBufferMemory2;
172 : extern PFN_vkBindImageMemory2 vkBindImageMemory2;
173 : extern PFN_vkGetPhysicalDeviceMemoryProperties2 vkGetPhysicalDeviceMemoryProperties2;
174 : #endif // #if VMA_VULKAN_VERSION >= 1001000
175 : #endif // #if defined(__ANDROID__) && VMA_STATIC_VULKAN_FUNCTIONS && VK_NO_PROTOTYPES
176 :
177 : #if !defined(VMA_DEDICATED_ALLOCATION)
178 : #if VK_KHR_get_memory_requirements2 && VK_KHR_dedicated_allocation
179 : #define VMA_DEDICATED_ALLOCATION 1
180 : #else
181 : #define VMA_DEDICATED_ALLOCATION 0
182 : #endif
183 : #endif
184 :
185 : #if !defined(VMA_BIND_MEMORY2)
186 : #if VK_KHR_bind_memory2
187 : #define VMA_BIND_MEMORY2 1
188 : #else
189 : #define VMA_BIND_MEMORY2 0
190 : #endif
191 : #endif
192 :
193 : #if !defined(VMA_MEMORY_BUDGET)
194 : #if VK_EXT_memory_budget && (VK_KHR_get_physical_device_properties2 || VMA_VULKAN_VERSION >= 1001000)
195 : #define VMA_MEMORY_BUDGET 1
196 : #else
197 : #define VMA_MEMORY_BUDGET 0
198 : #endif
199 : #endif
200 :
201 : // Defined to 1 when VK_KHR_buffer_device_address device extension or equivalent core Vulkan 1.2 feature is defined in its headers.
202 : #if !defined(VMA_BUFFER_DEVICE_ADDRESS)
203 : #if VK_KHR_buffer_device_address || VMA_VULKAN_VERSION >= 1002000
204 : #define VMA_BUFFER_DEVICE_ADDRESS 1
205 : #else
206 : #define VMA_BUFFER_DEVICE_ADDRESS 0
207 : #endif
208 : #endif
209 :
210 : // Defined to 1 when VK_EXT_memory_priority device extension is defined in Vulkan headers.
211 : #if !defined(VMA_MEMORY_PRIORITY)
212 : #if VK_EXT_memory_priority
213 : #define VMA_MEMORY_PRIORITY 1
214 : #else
215 : #define VMA_MEMORY_PRIORITY 0
216 : #endif
217 : #endif
218 :
219 : // Defined to 1 when VK_KHR_external_memory device extension is defined in Vulkan headers.
220 : #if !defined(VMA_EXTERNAL_MEMORY)
221 : #if VK_KHR_external_memory
222 : #define VMA_EXTERNAL_MEMORY 1
223 : #else
224 : #define VMA_EXTERNAL_MEMORY 0
225 : #endif
226 : #endif
227 :
228 : // Define these macros to decorate all public functions with additional code,
229 : // before and after returned type, appropriately. This may be useful for
230 : // exporting the functions when compiling VMA as a separate library. Example:
231 : // #define VMA_CALL_PRE __declspec(dllexport)
232 : // #define VMA_CALL_POST __cdecl
233 : #ifndef VMA_CALL_PRE
234 : #define VMA_CALL_PRE
235 : #endif
236 : #ifndef VMA_CALL_POST
237 : #define VMA_CALL_POST
238 : #endif
239 :
240 : // Define this macro to decorate pointers with an attribute specifying the
241 : // length of the array they point to if they are not null.
242 : //
243 : // The length may be one of
244 : // - The name of another parameter in the argument list where the pointer is declared
245 : // - The name of another member in the struct where the pointer is declared
246 : // - The name of a member of a struct type, meaning the value of that member in
247 : // the context of the call. For example
248 : // VMA_LEN_IF_NOT_NULL("VkPhysicalDeviceMemoryProperties::memoryHeapCount"),
249 : // this means the number of memory heaps available in the device associated
250 : // with the VmaAllocator being dealt with.
251 : #ifndef VMA_LEN_IF_NOT_NULL
252 : #define VMA_LEN_IF_NOT_NULL(len)
253 : #endif
254 :
255 : // The VMA_NULLABLE macro is defined to be _Nullable when compiling with Clang.
256 : // see: https://clang.llvm.org/docs/AttributeReference.html#nullable
257 : #ifndef VMA_NULLABLE
258 : #ifdef __clang__
259 : #define VMA_NULLABLE _Nullable
260 : #else
261 : #define VMA_NULLABLE
262 : #endif
263 : #endif
264 :
265 : // The VMA_NOT_NULL macro is defined to be _Nonnull when compiling with Clang.
266 : // see: https://clang.llvm.org/docs/AttributeReference.html#nonnull
267 : #ifndef VMA_NOT_NULL
268 : #ifdef __clang__
269 : #define VMA_NOT_NULL _Nonnull
270 : #else
271 : #define VMA_NOT_NULL
272 : #endif
273 : #endif
274 :
275 : // If non-dispatchable handles are represented as pointers then we can give
276 : // then nullability annotations
277 : #ifndef VMA_NOT_NULL_NON_DISPATCHABLE
278 : #if defined(__LP64__) || defined(_WIN64) || (defined(__x86_64__) && !defined(__ILP32__) ) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__)
279 : #define VMA_NOT_NULL_NON_DISPATCHABLE VMA_NOT_NULL
280 : #else
281 : #define VMA_NOT_NULL_NON_DISPATCHABLE
282 : #endif
283 : #endif
284 :
285 : #ifndef VMA_NULLABLE_NON_DISPATCHABLE
286 : #if defined(__LP64__) || defined(_WIN64) || (defined(__x86_64__) && !defined(__ILP32__) ) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__)
287 : #define VMA_NULLABLE_NON_DISPATCHABLE VMA_NULLABLE
288 : #else
289 : #define VMA_NULLABLE_NON_DISPATCHABLE
290 : #endif
291 : #endif
292 :
293 : #ifndef VMA_STATS_STRING_ENABLED
294 : #define VMA_STATS_STRING_ENABLED 1
295 : #endif
296 :
297 : ////////////////////////////////////////////////////////////////////////////////
298 : ////////////////////////////////////////////////////////////////////////////////
299 : //
300 : // INTERFACE
301 : //
302 : ////////////////////////////////////////////////////////////////////////////////
303 : ////////////////////////////////////////////////////////////////////////////////
304 :
305 : // Sections for managing code placement in file, only for development purposes e.g. for convenient folding inside an IDE.
306 : #ifndef _VMA_ENUM_DECLARATIONS
307 :
308 : /**
309 : \addtogroup group_init
310 : @{
311 : */
312 :
313 : /// Flags for created #VmaAllocator.
314 : typedef enum VmaAllocatorCreateFlagBits
315 : {
316 : /** \brief Allocator and all objects created from it will not be synchronized internally, so you must guarantee they are used from only one thread at a time or synchronized externally by you.
317 :
318 : Using this flag may increase performance because internal mutexes are not used.
319 : */
320 : VMA_ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT = 0x00000001,
321 : /** \brief Enables usage of VK_KHR_dedicated_allocation extension.
322 :
323 : The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion `== VK_API_VERSION_1_0`.
324 : When it is `VK_API_VERSION_1_1`, the flag is ignored because the extension has been promoted to Vulkan 1.1.
325 :
326 : Using this extension will automatically allocate dedicated blocks of memory for
327 : some buffers and images instead of suballocating place for them out of bigger
328 : memory blocks (as if you explicitly used #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT
329 : flag) when it is recommended by the driver. It may improve performance on some
330 : GPUs.
331 :
332 : You may set this flag only if you found out that following device extensions are
333 : supported, you enabled them while creating Vulkan device passed as
334 : VmaAllocatorCreateInfo::device, and you want them to be used internally by this
335 : library:
336 :
337 : - VK_KHR_get_memory_requirements2 (device extension)
338 : - VK_KHR_dedicated_allocation (device extension)
339 :
340 : When this flag is set, you can experience following warnings reported by Vulkan
341 : validation layer. You can ignore them.
342 :
343 : > vkBindBufferMemory(): Binding memory to buffer 0x2d but vkGetBufferMemoryRequirements() has not been called on that buffer.
344 : */
345 : VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT = 0x00000002,
346 : /**
347 : Enables usage of VK_KHR_bind_memory2 extension.
348 :
349 : The flag works only if VmaAllocatorCreateInfo::vulkanApiVersion `== VK_API_VERSION_1_0`.
350 : When it is `VK_API_VERSION_1_1`, the flag is ignored because the extension has been promoted to Vulkan 1.1.
351 :
352 : You may set this flag only if you found out that this device extension is supported,
353 : you enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device,
354 : and you want it to be used internally by this library.
355 :
356 : The extension provides functions `vkBindBufferMemory2KHR` and `vkBindImageMemory2KHR`,
357 : which allow to pass a chain of `pNext` structures while binding.
358 : This flag is required if you use `pNext` parameter in vmaBindBufferMemory2() or vmaBindImageMemory2().
359 : */
360 : VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT = 0x00000004,
361 : /**
362 : Enables usage of VK_EXT_memory_budget extension.
363 :
364 : You may set this flag only if you found out that this device extension is supported,
365 : you enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device,
366 : and you want it to be used internally by this library, along with another instance extension
367 : VK_KHR_get_physical_device_properties2, which is required by it (or Vulkan 1.1, where this extension is promoted).
368 :
369 : The extension provides query for current memory usage and budget, which will probably
370 : be more accurate than an estimation used by the library otherwise.
371 : */
372 : VMA_ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT = 0x00000008,
373 : /**
374 : Enables usage of VK_AMD_device_coherent_memory extension.
375 :
376 : You may set this flag only if you:
377 :
378 : - found out that this device extension is supported and enabled it while creating Vulkan device passed as VmaAllocatorCreateInfo::device,
379 : - checked that `VkPhysicalDeviceCoherentMemoryFeaturesAMD::deviceCoherentMemory` is true and set it while creating the Vulkan device,
380 : - want it to be used internally by this library.
381 :
382 : The extension and accompanying device feature provide access to memory types with
383 : `VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD` and `VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD` flags.
384 : They are useful mostly for writing breadcrumb markers - a common method for debugging GPU crash/hang/TDR.
385 :
386 : When the extension is not enabled, such memory types are still enumerated, but their usage is illegal.
387 : To protect from this error, if you don't create the allocator with this flag, it will refuse to allocate any memory or create a custom pool in such memory type,
388 : returning `VK_ERROR_FEATURE_NOT_PRESENT`.
389 : */
390 : VMA_ALLOCATOR_CREATE_AMD_DEVICE_COHERENT_MEMORY_BIT = 0x00000010,
391 : /**
392 : Enables usage of "buffer device address" feature, which allows you to use function
393 : `vkGetBufferDeviceAddress*` to get raw GPU pointer to a buffer and pass it for usage inside a shader.
394 :
395 : You may set this flag only if you:
396 :
397 : 1. (For Vulkan version < 1.2) Found as available and enabled device extension
398 : VK_KHR_buffer_device_address.
399 : This extension is promoted to core Vulkan 1.2.
400 : 2. Found as available and enabled device feature `VkPhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddress`.
401 :
402 : When this flag is set, you can create buffers with `VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT` using VMA.
403 : The library automatically adds `VK_MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT` to
404 : allocated memory blocks wherever it might be needed.
405 :
406 : For more information, see documentation chapter \ref enabling_buffer_device_address.
407 : */
408 : VMA_ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT = 0x00000020,
409 : /**
410 : Enables usage of VK_EXT_memory_priority extension in the library.
411 :
412 : You may set this flag only if you found available and enabled this device extension,
413 : along with `VkPhysicalDeviceMemoryPriorityFeaturesEXT::memoryPriority == VK_TRUE`,
414 : while creating Vulkan device passed as VmaAllocatorCreateInfo::device.
415 :
416 : When this flag is used, VmaAllocationCreateInfo::priority and VmaPoolCreateInfo::priority
417 : are used to set priorities of allocated Vulkan memory. Without it, these variables are ignored.
418 :
419 : A priority must be a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.
420 : Larger values are higher priority. The granularity of the priorities is implementation-dependent.
421 : It is automatically passed to every call to `vkAllocateMemory` done by the library using structure `VkMemoryPriorityAllocateInfoEXT`.
422 : The value to be used for default priority is 0.5.
423 : For more details, see the documentation of the VK_EXT_memory_priority extension.
424 : */
425 : VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT = 0x00000040,
426 :
427 : VMA_ALLOCATOR_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
428 : } VmaAllocatorCreateFlagBits;
429 : /// See #VmaAllocatorCreateFlagBits.
430 : typedef VkFlags VmaAllocatorCreateFlags;
431 :
432 : /** @} */
433 :
434 : /**
435 : \addtogroup group_alloc
436 : @{
437 : */
438 :
439 : /// \brief Intended usage of the allocated memory.
440 : typedef enum VmaMemoryUsage
441 : {
442 : /** No intended memory usage specified.
443 : Use other members of VmaAllocationCreateInfo to specify your requirements.
444 : */
445 : VMA_MEMORY_USAGE_UNKNOWN = 0,
446 : /**
447 : \deprecated Obsolete, preserved for backward compatibility.
448 : Prefers `VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT`.
449 : */
450 : VMA_MEMORY_USAGE_GPU_ONLY = 1,
451 : /**
452 : \deprecated Obsolete, preserved for backward compatibility.
453 : Guarantees `VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT` and `VK_MEMORY_PROPERTY_HOST_COHERENT_BIT`.
454 : */
455 : VMA_MEMORY_USAGE_CPU_ONLY = 2,
456 : /**
457 : \deprecated Obsolete, preserved for backward compatibility.
458 : Guarantees `VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT`, prefers `VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT`.
459 : */
460 : VMA_MEMORY_USAGE_CPU_TO_GPU = 3,
461 : /**
462 : \deprecated Obsolete, preserved for backward compatibility.
463 : Guarantees `VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT`, prefers `VK_MEMORY_PROPERTY_HOST_CACHED_BIT`.
464 : */
465 : VMA_MEMORY_USAGE_GPU_TO_CPU = 4,
466 : /**
467 : \deprecated Obsolete, preserved for backward compatibility.
468 : Prefers not `VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT`.
469 : */
470 : VMA_MEMORY_USAGE_CPU_COPY = 5,
471 : /**
472 : Lazily allocated GPU memory having `VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT`.
473 : Exists mostly on mobile platforms. Using it on desktop PC or other GPUs with no such memory type present will fail the allocation.
474 :
475 : Usage: Memory for transient attachment images (color attachments, depth attachments etc.), created with `VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT`.
476 :
477 : Allocations with this usage are always created as dedicated - it implies #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.
478 : */
479 : VMA_MEMORY_USAGE_GPU_LAZILY_ALLOCATED = 6,
480 : /**
481 : Selects best memory type automatically.
482 : This flag is recommended for most common use cases.
483 :
484 : When using this flag, if you want to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT),
485 : you must pass one of the flags: #VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or #VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT
486 : in VmaAllocationCreateInfo::flags.
487 :
488 : It can be used only with functions that let the library know `VkBufferCreateInfo` or `VkImageCreateInfo`, e.g.
489 : vmaCreateBuffer(), vmaCreateImage(), vmaFindMemoryTypeIndexForBufferInfo(), vmaFindMemoryTypeIndexForImageInfo()
490 : and not with generic memory allocation functions.
491 : */
492 : VMA_MEMORY_USAGE_AUTO = 7,
493 : /**
494 : Selects best memory type automatically with preference for GPU (device) memory.
495 :
496 : When using this flag, if you want to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT),
497 : you must pass one of the flags: #VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or #VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT
498 : in VmaAllocationCreateInfo::flags.
499 :
500 : It can be used only with functions that let the library know `VkBufferCreateInfo` or `VkImageCreateInfo`, e.g.
501 : vmaCreateBuffer(), vmaCreateImage(), vmaFindMemoryTypeIndexForBufferInfo(), vmaFindMemoryTypeIndexForImageInfo()
502 : and not with generic memory allocation functions.
503 : */
504 : VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE = 8,
505 : /**
506 : Selects best memory type automatically with preference for CPU (host) memory.
507 :
508 : When using this flag, if you want to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT),
509 : you must pass one of the flags: #VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or #VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT
510 : in VmaAllocationCreateInfo::flags.
511 :
512 : It can be used only with functions that let the library know `VkBufferCreateInfo` or `VkImageCreateInfo`, e.g.
513 : vmaCreateBuffer(), vmaCreateImage(), vmaFindMemoryTypeIndexForBufferInfo(), vmaFindMemoryTypeIndexForImageInfo()
514 : and not with generic memory allocation functions.
515 : */
516 : VMA_MEMORY_USAGE_AUTO_PREFER_HOST = 9,
517 :
518 : VMA_MEMORY_USAGE_MAX_ENUM = 0x7FFFFFFF
519 : } VmaMemoryUsage;
520 :
521 : /// Flags to be passed as VmaAllocationCreateInfo::flags.
522 : typedef enum VmaAllocationCreateFlagBits
523 : {
524 : /** \brief Set this flag if the allocation should have its own memory block.
525 :
526 : Use it for special, big resources, like fullscreen images used as attachments.
527 : */
528 : VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT = 0x00000001,
529 :
530 : /** \brief Set this flag to only try to allocate from existing `VkDeviceMemory` blocks and never create new such block.
531 :
532 : If new allocation cannot be placed in any of the existing blocks, allocation
533 : fails with `VK_ERROR_OUT_OF_DEVICE_MEMORY` error.
534 :
535 : You should not use #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT and
536 : #VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT at the same time. It makes no sense.
537 : */
538 : VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT = 0x00000002,
539 : /** \brief Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.
540 :
541 : Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData.
542 :
543 : It is valid to use this flag for allocation made from memory type that is not
544 : `HOST_VISIBLE`. This flag is then ignored and memory is not mapped. This is
545 : useful if you need an allocation that is efficient to use on GPU
546 : (`DEVICE_LOCAL`) and still want to map it directly if possible on platforms that
547 : support it (e.g. Intel GPU).
548 : */
549 : VMA_ALLOCATION_CREATE_MAPPED_BIT = 0x00000004,
550 : /** \deprecated Preserved for backward compatibility. Consider using vmaSetAllocationName() instead.
551 :
552 : Set this flag to treat VmaAllocationCreateInfo::pUserData as pointer to a
553 : null-terminated string. Instead of copying pointer value, a local copy of the
554 : string is made and stored in allocation's `pName`. The string is automatically
555 : freed together with the allocation. It is also used in vmaBuildStatsString().
556 : */
557 : VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT = 0x00000020,
558 : /** Allocation will be created from upper stack in a double stack pool.
559 :
560 : This flag is only allowed for custom pools created with #VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT flag.
561 : */
562 : VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT = 0x00000040,
563 : /** Create both buffer/image and allocation, but don't bind them together.
564 : It is useful when you want to bind yourself to do some more advanced binding, e.g. using some extensions.
565 : The flag is meaningful only with functions that bind by default: vmaCreateBuffer(), vmaCreateImage().
566 : Otherwise it is ignored.
567 :
568 : If you want to make sure the new buffer/image is not tied to the new memory allocation
569 : through `VkMemoryDedicatedAllocateInfoKHR` structure in case the allocation ends up in its own memory block,
570 : use also flag #VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT.
571 : */
572 : VMA_ALLOCATION_CREATE_DONT_BIND_BIT = 0x00000080,
573 : /** Create allocation only if additional device memory required for it, if any, won't exceed
574 : memory budget. Otherwise return `VK_ERROR_OUT_OF_DEVICE_MEMORY`.
575 : */
576 : VMA_ALLOCATION_CREATE_WITHIN_BUDGET_BIT = 0x00000100,
577 : /** \brief Set this flag if the allocated memory will have aliasing resources.
578 :
579 : Usage of this flag prevents supplying `VkMemoryDedicatedAllocateInfoKHR` when #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT is specified.
580 : Otherwise created dedicated memory will not be suitable for aliasing resources, resulting in Vulkan Validation Layer errors.
581 : */
582 : VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT = 0x00000200,
583 : /**
584 : Requests possibility to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT).
585 :
586 : - If you use #VMA_MEMORY_USAGE_AUTO or other `VMA_MEMORY_USAGE_AUTO*` value,
587 : you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.
588 : - If you use other value of #VmaMemoryUsage, this flag is ignored and mapping is always possible in memory types that are `HOST_VISIBLE`.
589 : This includes allocations created in \ref custom_memory_pools.
590 :
591 : Declares that mapped memory will only be written sequentially, e.g. using `memcpy()` or a loop writing number-by-number,
592 : never read or accessed randomly, so a memory type can be selected that is uncached and write-combined.
593 :
594 : \warning Violating this declaration may work correctly, but will likely be very slow.
595 : Watch out for implicit reads introduced by doing e.g. `pMappedData[i] += x;`
596 : Better prepare your data in a local variable and `memcpy()` it to the mapped pointer all at once.
597 : */
598 : VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT = 0x00000400,
599 : /**
600 : Requests possibility to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT).
601 :
602 : - If you use #VMA_MEMORY_USAGE_AUTO or other `VMA_MEMORY_USAGE_AUTO*` value,
603 : you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.
604 : - If you use other value of #VmaMemoryUsage, this flag is ignored and mapping is always possible in memory types that are `HOST_VISIBLE`.
605 : This includes allocations created in \ref custom_memory_pools.
606 :
607 : Declares that mapped memory can be read, written, and accessed in random order,
608 : so a `HOST_CACHED` memory type is required.
609 : */
610 : VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT = 0x00000800,
611 : /**
612 : Together with #VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or #VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT,
613 : it says that despite request for host access, a not-`HOST_VISIBLE` memory type can be selected
614 : if it may improve performance.
615 :
616 : By using this flag, you declare that you will check if the allocation ended up in a `HOST_VISIBLE` memory type
617 : (e.g. using vmaGetAllocationMemoryProperties()) and if not, you will create some "staging" buffer and
618 : issue an explicit transfer to write/read your data.
619 : To prepare for this possibility, don't forget to add appropriate flags like
620 : `VK_BUFFER_USAGE_TRANSFER_DST_BIT`, `VK_BUFFER_USAGE_TRANSFER_SRC_BIT` to the parameters of created buffer or image.
621 : */
622 : VMA_ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT = 0x00001000,
623 : /** Allocation strategy that chooses smallest possible free range for the allocation
624 : to minimize memory usage and fragmentation, possibly at the expense of allocation time.
625 : */
626 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = 0x00010000,
627 : /** Allocation strategy that chooses first suitable free range for the allocation -
628 : not necessarily in terms of the smallest offset but the one that is easiest and fastest to find
629 : to minimize allocation time, possibly at the expense of allocation quality.
630 : */
631 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT = 0x00020000,
632 : /** Allocation strategy that chooses always the lowest offset in available space.
633 : This is not the most efficient strategy but achieves highly packed data.
634 : Used internally by defragmentation, not recomended in typical usage.
635 : */
636 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT = 0x00040000,
637 : /** Alias to #VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT.
638 : */
639 : VMA_ALLOCATION_CREATE_STRATEGY_BEST_FIT_BIT = VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT,
640 : /** Alias to #VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT.
641 : */
642 : VMA_ALLOCATION_CREATE_STRATEGY_FIRST_FIT_BIT = VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT,
643 : /** A bit mask to extract only `STRATEGY` bits from entire set of flags.
644 : */
645 : VMA_ALLOCATION_CREATE_STRATEGY_MASK =
646 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT |
647 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT |
648 : VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT,
649 :
650 : VMA_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
651 : } VmaAllocationCreateFlagBits;
652 : /// See #VmaAllocationCreateFlagBits.
653 : typedef VkFlags VmaAllocationCreateFlags;
654 :
655 : /// Flags to be passed as VmaPoolCreateInfo::flags.
656 : typedef enum VmaPoolCreateFlagBits
657 : {
658 : /** \brief Use this flag if you always allocate only buffers and linear images or only optimal images out of this pool and so Buffer-Image Granularity can be ignored.
659 :
660 : This is an optional optimization flag.
661 :
662 : If you always allocate using vmaCreateBuffer(), vmaCreateImage(),
663 : vmaAllocateMemoryForBuffer(), then you don't need to use it because allocator
664 : knows exact type of your allocations so it can handle Buffer-Image Granularity
665 : in the optimal way.
666 :
667 : If you also allocate using vmaAllocateMemoryForImage() or vmaAllocateMemory(),
668 : exact type of such allocations is not known, so allocator must be conservative
669 : in handling Buffer-Image Granularity, which can lead to suboptimal allocation
670 : (wasted memory). In that case, if you can make sure you always allocate only
671 : buffers and linear images or only optimal images out of this pool, use this flag
672 : to make allocator disregard Buffer-Image Granularity and so make allocations
673 : faster and more optimal.
674 : */
675 : VMA_POOL_CREATE_IGNORE_BUFFER_IMAGE_GRANULARITY_BIT = 0x00000002,
676 :
677 : /** \brief Enables alternative, linear allocation algorithm in this pool.
678 :
679 : Specify this flag to enable linear allocation algorithm, which always creates
680 : new allocations after last one and doesn't reuse space from allocations freed in
681 : between. It trades memory consumption for simplified algorithm and data
682 : structure, which has better performance and uses less memory for metadata.
683 :
684 : By using this flag, you can achieve behavior of free-at-once, stack,
685 : ring buffer, and double stack.
686 : For details, see documentation chapter \ref linear_algorithm.
687 : */
688 : VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT = 0x00000004,
689 :
690 : /** Bit mask to extract only `ALGORITHM` bits from entire set of flags.
691 : */
692 : VMA_POOL_CREATE_ALGORITHM_MASK =
693 : VMA_POOL_CREATE_LINEAR_ALGORITHM_BIT,
694 :
695 : VMA_POOL_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
696 : } VmaPoolCreateFlagBits;
697 : /// Flags to be passed as VmaPoolCreateInfo::flags. See #VmaPoolCreateFlagBits.
698 : typedef VkFlags VmaPoolCreateFlags;
699 :
700 : /// Flags to be passed as VmaDefragmentationInfo::flags.
701 : typedef enum VmaDefragmentationFlagBits
702 : {
703 : /* \brief Use simple but fast algorithm for defragmentation.
704 : May not achieve best results but will require least time to compute and least allocations to copy.
705 : */
706 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT = 0x1,
707 : /* \brief Default defragmentation algorithm, applied also when no `ALGORITHM` flag is specified.
708 : Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
709 : */
710 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT = 0x2,
711 : /* \brief Perform full defragmentation of memory.
712 : Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
713 : */
714 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT = 0x4,
715 : /** \brief Use the most roboust algorithm at the cost of time to compute and number of copies to make.
716 : Only available when bufferImageGranularity is greater than 1, since it aims to reduce
717 : alignment issues between different types of resources.
718 : Otherwise falls back to same behavior as #VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT.
719 : */
720 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT = 0x8,
721 :
722 : /// A bit mask to extract only `ALGORITHM` bits from entire set of flags.
723 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_MASK =
724 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FAST_BIT |
725 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED_BIT |
726 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_FULL_BIT |
727 : VMA_DEFRAGMENTATION_FLAG_ALGORITHM_EXTENSIVE_BIT,
728 :
729 : VMA_DEFRAGMENTATION_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
730 : } VmaDefragmentationFlagBits;
731 : /// See #VmaDefragmentationFlagBits.
732 : typedef VkFlags VmaDefragmentationFlags;
733 :
734 : /// Operation performed on single defragmentation move. See structure #VmaDefragmentationMove.
735 : typedef enum VmaDefragmentationMoveOperation
736 : {
737 : /// Buffer/image has been recreated at `dstTmpAllocation`, data has been copied, old buffer/image has been destroyed. `srcAllocation` should be changed to point to the new place. This is the default value set by vmaBeginDefragmentationPass().
738 : VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY = 0,
739 : /// Set this value if you cannot move the allocation. New place reserved at `dstTmpAllocation` will be freed. `srcAllocation` will remain unchanged.
740 : VMA_DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1,
741 : /// Set this value if you decide to abandon the allocation and you destroyed the buffer/image. New place reserved at `dstTmpAllocation` will be freed, along with `srcAllocation`, which will be destroyed.
742 : VMA_DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2,
743 : } VmaDefragmentationMoveOperation;
744 :
745 : /** @} */
746 :
747 : /**
748 : \addtogroup group_virtual
749 : @{
750 : */
751 :
752 : /// Flags to be passed as VmaVirtualBlockCreateInfo::flags.
753 : typedef enum VmaVirtualBlockCreateFlagBits
754 : {
755 : /** \brief Enables alternative, linear allocation algorithm in this virtual block.
756 :
757 : Specify this flag to enable linear allocation algorithm, which always creates
758 : new allocations after last one and doesn't reuse space from allocations freed in
759 : between. It trades memory consumption for simplified algorithm and data
760 : structure, which has better performance and uses less memory for metadata.
761 :
762 : By using this flag, you can achieve behavior of free-at-once, stack,
763 : ring buffer, and double stack.
764 : For details, see documentation chapter \ref linear_algorithm.
765 : */
766 : VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT = 0x00000001,
767 :
768 : /** \brief Bit mask to extract only `ALGORITHM` bits from entire set of flags.
769 : */
770 : VMA_VIRTUAL_BLOCK_CREATE_ALGORITHM_MASK =
771 : VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT,
772 :
773 : VMA_VIRTUAL_BLOCK_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
774 : } VmaVirtualBlockCreateFlagBits;
775 : /// Flags to be passed as VmaVirtualBlockCreateInfo::flags. See #VmaVirtualBlockCreateFlagBits.
776 : typedef VkFlags VmaVirtualBlockCreateFlags;
777 :
778 : /// Flags to be passed as VmaVirtualAllocationCreateInfo::flags.
779 : typedef enum VmaVirtualAllocationCreateFlagBits
780 : {
781 : /** \brief Allocation will be created from upper stack in a double stack pool.
782 :
783 : This flag is only allowed for virtual blocks created with #VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT flag.
784 : */
785 : VMA_VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT = VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT,
786 : /** \brief Allocation strategy that tries to minimize memory usage.
787 : */
788 : VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT = VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT,
789 : /** \brief Allocation strategy that tries to minimize allocation time.
790 : */
791 : VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT = VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT,
792 : /** Allocation strategy that chooses always the lowest offset in available space.
793 : This is not the most efficient strategy but achieves highly packed data.
794 : */
795 : VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT = VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT,
796 : /** \brief A bit mask to extract only `STRATEGY` bits from entire set of flags.
797 :
798 : These strategy flags are binary compatible with equivalent flags in #VmaAllocationCreateFlagBits.
799 : */
800 : VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK = VMA_ALLOCATION_CREATE_STRATEGY_MASK,
801 :
802 : VMA_VIRTUAL_ALLOCATION_CREATE_FLAG_BITS_MAX_ENUM = 0x7FFFFFFF
803 : } VmaVirtualAllocationCreateFlagBits;
804 : /// Flags to be passed as VmaVirtualAllocationCreateInfo::flags. See #VmaVirtualAllocationCreateFlagBits.
805 : typedef VkFlags VmaVirtualAllocationCreateFlags;
806 :
807 : /** @} */
808 :
809 : #endif // _VMA_ENUM_DECLARATIONS
810 :
811 : #ifndef _VMA_DATA_TYPES_DECLARATIONS
812 :
813 : /**
814 : \addtogroup group_init
815 : @{ */
816 :
817 : /** \struct VmaAllocator
818 : \brief Represents main object of this library initialized.
819 :
820 : Fill structure #VmaAllocatorCreateInfo and call function vmaCreateAllocator() to create it.
821 : Call function vmaDestroyAllocator() to destroy it.
822 :
823 : It is recommended to create just one object of this type per `VkDevice` object,
824 : right after Vulkan is initialized and keep it alive until before Vulkan device is destroyed.
825 : */
826 : VK_DEFINE_HANDLE(VmaAllocator)
827 :
828 : /** @} */
829 :
830 : /**
831 : \addtogroup group_alloc
832 : @{
833 : */
834 :
835 : /** \struct VmaPool
836 : \brief Represents custom memory pool
837 :
838 : Fill structure VmaPoolCreateInfo and call function vmaCreatePool() to create it.
839 : Call function vmaDestroyPool() to destroy it.
840 :
841 : For more information see [Custom memory pools](@ref choosing_memory_type_custom_memory_pools).
842 : */
843 : VK_DEFINE_HANDLE(VmaPool)
844 :
845 : /** \struct VmaAllocation
846 : \brief Represents single memory allocation.
847 :
848 : It may be either dedicated block of `VkDeviceMemory` or a specific region of a bigger block of this type
849 : plus unique offset.
850 :
851 : There are multiple ways to create such object.
852 : You need to fill structure VmaAllocationCreateInfo.
853 : For more information see [Choosing memory type](@ref choosing_memory_type).
854 :
855 : Although the library provides convenience functions that create Vulkan buffer or image,
856 : allocate memory for it and bind them together,
857 : binding of the allocation to a buffer or an image is out of scope of the allocation itself.
858 : Allocation object can exist without buffer/image bound,
859 : binding can be done manually by the user, and destruction of it can be done
860 : independently of destruction of the allocation.
861 :
862 : The object also remembers its size and some other information.
863 : To retrieve this information, use function vmaGetAllocationInfo() and inspect
864 : returned structure VmaAllocationInfo.
865 : */
866 : VK_DEFINE_HANDLE(VmaAllocation)
867 :
868 : /** \struct VmaDefragmentationContext
869 : \brief An opaque object that represents started defragmentation process.
870 :
871 : Fill structure #VmaDefragmentationInfo and call function vmaBeginDefragmentation() to create it.
872 : Call function vmaEndDefragmentation() to destroy it.
873 : */
874 : VK_DEFINE_HANDLE(VmaDefragmentationContext)
875 :
876 : /** @} */
877 :
878 : /**
879 : \addtogroup group_virtual
880 : @{
881 : */
882 :
883 : /** \struct VmaVirtualAllocation
884 : \brief Represents single memory allocation done inside VmaVirtualBlock.
885 :
886 : Use it as a unique identifier to virtual allocation within the single block.
887 :
888 : Use value `VK_NULL_HANDLE` to represent a null/invalid allocation.
889 : */
890 : VK_DEFINE_NON_DISPATCHABLE_HANDLE(VmaVirtualAllocation);
891 :
892 : /** @} */
893 :
894 : /**
895 : \addtogroup group_virtual
896 : @{
897 : */
898 :
899 : /** \struct VmaVirtualBlock
900 : \brief Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory.
901 :
902 : Fill in #VmaVirtualBlockCreateInfo structure and use vmaCreateVirtualBlock() to create it. Use vmaDestroyVirtualBlock() to destroy it.
903 : For more information, see documentation chapter \ref virtual_allocator.
904 :
905 : This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
906 : */
907 : VK_DEFINE_HANDLE(VmaVirtualBlock)
908 :
909 : /** @} */
910 :
911 : /**
912 : \addtogroup group_init
913 : @{
914 : */
915 :
916 : /// Callback function called after successful vkAllocateMemory.
917 : typedef void (VKAPI_PTR* PFN_vmaAllocateDeviceMemoryFunction)(
918 : VmaAllocator VMA_NOT_NULL allocator,
919 : uint32_t memoryType,
920 : VkDeviceMemory VMA_NOT_NULL_NON_DISPATCHABLE memory,
921 : VkDeviceSize size,
922 : void* VMA_NULLABLE pUserData);
923 :
924 : /// Callback function called before vkFreeMemory.
925 : typedef void (VKAPI_PTR* PFN_vmaFreeDeviceMemoryFunction)(
926 : VmaAllocator VMA_NOT_NULL allocator,
927 : uint32_t memoryType,
928 : VkDeviceMemory VMA_NOT_NULL_NON_DISPATCHABLE memory,
929 : VkDeviceSize size,
930 : void* VMA_NULLABLE pUserData);
931 :
932 : /** \brief Set of callbacks that the library will call for `vkAllocateMemory` and `vkFreeMemory`.
933 :
934 : Provided for informative purpose, e.g. to gather statistics about number of
935 : allocations or total amount of memory allocated in Vulkan.
936 :
937 : Used in VmaAllocatorCreateInfo::pDeviceMemoryCallbacks.
938 : */
939 : typedef struct VmaDeviceMemoryCallbacks
940 : {
941 : /// Optional, can be null.
942 : PFN_vmaAllocateDeviceMemoryFunction VMA_NULLABLE pfnAllocate;
943 : /// Optional, can be null.
944 : PFN_vmaFreeDeviceMemoryFunction VMA_NULLABLE pfnFree;
945 : /// Optional, can be null.
946 : void* VMA_NULLABLE pUserData;
947 : } VmaDeviceMemoryCallbacks;
948 :
949 : /** \brief Pointers to some Vulkan functions - a subset used by the library.
950 :
951 : Used in VmaAllocatorCreateInfo::pVulkanFunctions.
952 : */
953 : typedef struct VmaVulkanFunctions
954 : {
955 : /// Required when using VMA_DYNAMIC_VULKAN_FUNCTIONS.
956 : PFN_vkGetInstanceProcAddr VMA_NULLABLE vkGetInstanceProcAddr;
957 : /// Required when using VMA_DYNAMIC_VULKAN_FUNCTIONS.
958 : PFN_vkGetDeviceProcAddr VMA_NULLABLE vkGetDeviceProcAddr;
959 : PFN_vkGetPhysicalDeviceProperties VMA_NULLABLE vkGetPhysicalDeviceProperties;
960 : PFN_vkGetPhysicalDeviceMemoryProperties VMA_NULLABLE vkGetPhysicalDeviceMemoryProperties;
961 : PFN_vkAllocateMemory VMA_NULLABLE vkAllocateMemory;
962 : PFN_vkFreeMemory VMA_NULLABLE vkFreeMemory;
963 : PFN_vkMapMemory VMA_NULLABLE vkMapMemory;
964 : PFN_vkUnmapMemory VMA_NULLABLE vkUnmapMemory;
965 : PFN_vkFlushMappedMemoryRanges VMA_NULLABLE vkFlushMappedMemoryRanges;
966 : PFN_vkInvalidateMappedMemoryRanges VMA_NULLABLE vkInvalidateMappedMemoryRanges;
967 : PFN_vkBindBufferMemory VMA_NULLABLE vkBindBufferMemory;
968 : PFN_vkBindImageMemory VMA_NULLABLE vkBindImageMemory;
969 : PFN_vkGetBufferMemoryRequirements VMA_NULLABLE vkGetBufferMemoryRequirements;
970 : PFN_vkGetImageMemoryRequirements VMA_NULLABLE vkGetImageMemoryRequirements;
971 : PFN_vkCreateBuffer VMA_NULLABLE vkCreateBuffer;
972 : PFN_vkDestroyBuffer VMA_NULLABLE vkDestroyBuffer;
973 : PFN_vkCreateImage VMA_NULLABLE vkCreateImage;
974 : PFN_vkDestroyImage VMA_NULLABLE vkDestroyImage;
975 : PFN_vkCmdCopyBuffer VMA_NULLABLE vkCmdCopyBuffer;
976 : #if VMA_DEDICATED_ALLOCATION || VMA_VULKAN_VERSION >= 1001000
977 : /// Fetch "vkGetBufferMemoryRequirements2" on Vulkan >= 1.1, fetch "vkGetBufferMemoryRequirements2KHR" when using VK_KHR_dedicated_allocation extension.
978 : PFN_vkGetBufferMemoryRequirements2KHR VMA_NULLABLE vkGetBufferMemoryRequirements2KHR;
979 : /// Fetch "vkGetImageMemoryRequirements2" on Vulkan >= 1.1, fetch "vkGetImageMemoryRequirements2KHR" when using VK_KHR_dedicated_allocation extension.
980 : PFN_vkGetImageMemoryRequirements2KHR VMA_NULLABLE vkGetImageMemoryRequirements2KHR;
981 : #endif
982 : #if VMA_BIND_MEMORY2 || VMA_VULKAN_VERSION >= 1001000
983 : /// Fetch "vkBindBufferMemory2" on Vulkan >= 1.1, fetch "vkBindBufferMemory2KHR" when using VK_KHR_bind_memory2 extension.
984 : PFN_vkBindBufferMemory2KHR VMA_NULLABLE vkBindBufferMemory2KHR;
985 : /// Fetch "vkBindImageMemory2" on Vulkan >= 1.1, fetch "vkBindImageMemory2KHR" when using VK_KHR_bind_memory2 extension.
986 : PFN_vkBindImageMemory2KHR VMA_NULLABLE vkBindImageMemory2KHR;
987 : #endif
988 : #if VMA_MEMORY_BUDGET || VMA_VULKAN_VERSION >= 1001000
989 : PFN_vkGetPhysicalDeviceMemoryProperties2KHR VMA_NULLABLE vkGetPhysicalDeviceMemoryProperties2KHR;
990 : #endif
991 : #if VMA_VULKAN_VERSION >= 1003000
992 : /// Fetch from "vkGetDeviceBufferMemoryRequirements" on Vulkan >= 1.3, but you can also fetch it from "vkGetDeviceBufferMemoryRequirementsKHR" if you enabled extension VK_KHR_maintenance4.
993 : PFN_vkGetDeviceBufferMemoryRequirements VMA_NULLABLE vkGetDeviceBufferMemoryRequirements;
994 : /// Fetch from "vkGetDeviceImageMemoryRequirements" on Vulkan >= 1.3, but you can also fetch it from "vkGetDeviceImageMemoryRequirementsKHR" if you enabled extension VK_KHR_maintenance4.
995 : PFN_vkGetDeviceImageMemoryRequirements VMA_NULLABLE vkGetDeviceImageMemoryRequirements;
996 : #endif
997 : } VmaVulkanFunctions;
998 :
999 : /// Description of a Allocator to be created.
1000 : typedef struct VmaAllocatorCreateInfo
1001 : {
1002 : /// Flags for created allocator. Use #VmaAllocatorCreateFlagBits enum.
1003 : VmaAllocatorCreateFlags flags;
1004 : /// Vulkan physical device.
1005 : /** It must be valid throughout whole lifetime of created allocator. */
1006 : VkPhysicalDevice VMA_NOT_NULL physicalDevice;
1007 : /// Vulkan device.
1008 : /** It must be valid throughout whole lifetime of created allocator. */
1009 : VkDevice VMA_NOT_NULL device;
1010 : /// Preferred size of a single `VkDeviceMemory` block to be allocated from large heaps > 1 GiB. Optional.
1011 : /** Set to 0 to use default, which is currently 256 MiB. */
1012 : VkDeviceSize preferredLargeHeapBlockSize;
1013 : /// Custom CPU memory allocation callbacks. Optional.
1014 : /** Optional, can be null. When specified, will also be used for all CPU-side memory allocations. */
1015 : const VkAllocationCallbacks* VMA_NULLABLE pAllocationCallbacks;
1016 : /// Informative callbacks for `vkAllocateMemory`, `vkFreeMemory`. Optional.
1017 : /** Optional, can be null. */
1018 : const VmaDeviceMemoryCallbacks* VMA_NULLABLE pDeviceMemoryCallbacks;
1019 : /** \brief Either null or a pointer to an array of limits on maximum number of bytes that can be allocated out of particular Vulkan memory heap.
1020 :
1021 : If not NULL, it must be a pointer to an array of
1022 : `VkPhysicalDeviceMemoryProperties::memoryHeapCount` elements, defining limit on
1023 : maximum number of bytes that can be allocated out of particular Vulkan memory
1024 : heap.
1025 :
1026 : Any of the elements may be equal to `VK_WHOLE_SIZE`, which means no limit on that
1027 : heap. This is also the default in case of `pHeapSizeLimit` = NULL.
1028 :
1029 : If there is a limit defined for a heap:
1030 :
1031 : - If user tries to allocate more memory from that heap using this allocator,
1032 : the allocation fails with `VK_ERROR_OUT_OF_DEVICE_MEMORY`.
1033 : - If the limit is smaller than heap size reported in `VkMemoryHeap::size`, the
1034 : value of this limit will be reported instead when using vmaGetMemoryProperties().
1035 :
1036 : Warning! Using this feature may not be equivalent to installing a GPU with
1037 : smaller amount of memory, because graphics driver doesn't necessary fail new
1038 : allocations with `VK_ERROR_OUT_OF_DEVICE_MEMORY` result when memory capacity is
1039 : exceeded. It may return success and just silently migrate some device memory
1040 : blocks to system RAM. This driver behavior can also be controlled using
1041 : VK_AMD_memory_overallocation_behavior extension.
1042 : */
1043 : const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL("VkPhysicalDeviceMemoryProperties::memoryHeapCount") pHeapSizeLimit;
1044 :
1045 : /** \brief Pointers to Vulkan functions. Can be null.
1046 :
1047 : For details see [Pointers to Vulkan functions](@ref config_Vulkan_functions).
1048 : */
1049 : const VmaVulkanFunctions* VMA_NULLABLE pVulkanFunctions;
1050 : /** \brief Handle to Vulkan instance object.
1051 :
1052 : Starting from version 3.0.0 this member is no longer optional, it must be set!
1053 : */
1054 : VkInstance VMA_NOT_NULL instance;
1055 : /** \brief Optional. The highest version of Vulkan that the application is designed to use.
1056 :
1057 : It must be a value in the format as created by macro `VK_MAKE_VERSION` or a constant like: `VK_API_VERSION_1_1`, `VK_API_VERSION_1_0`.
1058 : The patch version number specified is ignored. Only the major and minor versions are considered.
1059 : It must be less or equal (preferably equal) to value as passed to `vkCreateInstance` as `VkApplicationInfo::apiVersion`.
1060 : Only versions 1.0, 1.1, 1.2, 1.3 are supported by the current implementation.
1061 : Leaving it initialized to zero is equivalent to `VK_API_VERSION_1_0`.
1062 : */
1063 : uint32_t vulkanApiVersion;
1064 : #if VMA_EXTERNAL_MEMORY
1065 : /** \brief Either null or a pointer to an array of external memory handle types for each Vulkan memory type.
1066 :
1067 : If not NULL, it must be a pointer to an array of `VkPhysicalDeviceMemoryProperties::memoryTypeCount`
1068 : elements, defining external memory handle types of particular Vulkan memory type,
1069 : to be passed using `VkExportMemoryAllocateInfoKHR`.
1070 :
1071 : Any of the elements may be equal to 0, which means not to use `VkExportMemoryAllocateInfoKHR` on this memory type.
1072 : This is also the default in case of `pTypeExternalMemoryHandleTypes` = NULL.
1073 : */
1074 : const VkExternalMemoryHandleTypeFlagsKHR* VMA_NULLABLE VMA_LEN_IF_NOT_NULL("VkPhysicalDeviceMemoryProperties::memoryTypeCount") pTypeExternalMemoryHandleTypes;
1075 : #endif // #if VMA_EXTERNAL_MEMORY
1076 : } VmaAllocatorCreateInfo;
1077 :
1078 : /// Information about existing #VmaAllocator object.
1079 : typedef struct VmaAllocatorInfo
1080 : {
1081 : /** \brief Handle to Vulkan instance object.
1082 :
1083 : This is the same value as has been passed through VmaAllocatorCreateInfo::instance.
1084 : */
1085 : VkInstance VMA_NOT_NULL instance;
1086 : /** \brief Handle to Vulkan physical device object.
1087 :
1088 : This is the same value as has been passed through VmaAllocatorCreateInfo::physicalDevice.
1089 : */
1090 : VkPhysicalDevice VMA_NOT_NULL physicalDevice;
1091 : /** \brief Handle to Vulkan device object.
1092 :
1093 : This is the same value as has been passed through VmaAllocatorCreateInfo::device.
1094 : */
1095 : VkDevice VMA_NOT_NULL device;
1096 : } VmaAllocatorInfo;
1097 :
1098 : /** @} */
1099 :
1100 : /**
1101 : \addtogroup group_stats
1102 : @{
1103 : */
1104 :
1105 : /** \brief Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total.
1106 :
1107 : These are fast to calculate.
1108 : See functions: vmaGetHeapBudgets(), vmaGetPoolStatistics().
1109 : */
1110 : typedef struct VmaStatistics
1111 : {
1112 : /** \brief Number of `VkDeviceMemory` objects - Vulkan memory blocks allocated.
1113 : */
1114 : uint32_t blockCount;
1115 : /** \brief Number of #VmaAllocation objects allocated.
1116 :
1117 : Dedicated allocations have their own blocks, so each one adds 1 to `allocationCount` as well as `blockCount`.
1118 : */
1119 : uint32_t allocationCount;
1120 : /** \brief Number of bytes allocated in `VkDeviceMemory` blocks.
1121 :
1122 : \note To avoid confusion, please be aware that what Vulkan calls an "allocation" - a whole `VkDeviceMemory` object
1123 : (e.g. as in `VkPhysicalDeviceLimits::maxMemoryAllocationCount`) is called a "block" in VMA, while VMA calls
1124 : "allocation" a #VmaAllocation object that represents a memory region sub-allocated from such block, usually for a single buffer or image.
1125 : */
1126 : VkDeviceSize blockBytes;
1127 : /** \brief Total number of bytes occupied by all #VmaAllocation objects.
1128 :
1129 : Always less or equal than `blockBytes`.
1130 : Difference `(blockBytes - allocationBytes)` is the amount of memory allocated from Vulkan
1131 : but unused by any #VmaAllocation.
1132 : */
1133 : VkDeviceSize allocationBytes;
1134 : } VmaStatistics;
1135 :
1136 : /** \brief More detailed statistics than #VmaStatistics.
1137 :
1138 : These are slower to calculate. Use for debugging purposes.
1139 : See functions: vmaCalculateStatistics(), vmaCalculatePoolStatistics().
1140 :
1141 : Previous version of the statistics API provided averages, but they have been removed
1142 : because they can be easily calculated as:
1143 :
1144 : \code
1145 : VkDeviceSize allocationSizeAvg = detailedStats.statistics.allocationBytes / detailedStats.statistics.allocationCount;
1146 : VkDeviceSize unusedBytes = detailedStats.statistics.blockBytes - detailedStats.statistics.allocationBytes;
1147 : VkDeviceSize unusedRangeSizeAvg = unusedBytes / detailedStats.unusedRangeCount;
1148 : \endcode
1149 : */
1150 : typedef struct VmaDetailedStatistics
1151 : {
1152 : /// Basic statistics.
1153 : VmaStatistics statistics;
1154 : /// Number of free ranges of memory between allocations.
1155 : uint32_t unusedRangeCount;
1156 : /// Smallest allocation size. `VK_WHOLE_SIZE` if there are 0 allocations.
1157 : VkDeviceSize allocationSizeMin;
1158 : /// Largest allocation size. 0 if there are 0 allocations.
1159 : VkDeviceSize allocationSizeMax;
1160 : /// Smallest empty range size. `VK_WHOLE_SIZE` if there are 0 empty ranges.
1161 : VkDeviceSize unusedRangeSizeMin;
1162 : /// Largest empty range size. 0 if there are 0 empty ranges.
1163 : VkDeviceSize unusedRangeSizeMax;
1164 : } VmaDetailedStatistics;
1165 :
1166 : /** \brief General statistics from current state of the Allocator -
1167 : total memory usage across all memory heaps and types.
1168 :
1169 : These are slower to calculate. Use for debugging purposes.
1170 : See function vmaCalculateStatistics().
1171 : */
1172 : typedef struct VmaTotalStatistics
1173 : {
1174 : VmaDetailedStatistics memoryType[VK_MAX_MEMORY_TYPES];
1175 : VmaDetailedStatistics memoryHeap[VK_MAX_MEMORY_HEAPS];
1176 : VmaDetailedStatistics total;
1177 : } VmaTotalStatistics;
1178 :
1179 : /** \brief Statistics of current memory usage and available budget for a specific memory heap.
1180 :
1181 : These are fast to calculate.
1182 : See function vmaGetHeapBudgets().
1183 : */
1184 : typedef struct VmaBudget
1185 : {
1186 : /** \brief Statistics fetched from the library.
1187 : */
1188 : VmaStatistics statistics;
1189 : /** \brief Estimated current memory usage of the program, in bytes.
1190 :
1191 : Fetched from system using VK_EXT_memory_budget extension if enabled.
1192 :
1193 : It might be different than `statistics.blockBytes` (usually higher) due to additional implicit objects
1194 : also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or
1195 : `VkDeviceMemory` blocks allocated outside of this library, if any.
1196 : */
1197 : VkDeviceSize usage;
1198 : /** \brief Estimated amount of memory available to the program, in bytes.
1199 :
1200 : Fetched from system using VK_EXT_memory_budget extension if enabled.
1201 :
1202 : It might be different (most probably smaller) than `VkMemoryHeap::size[heapIndex]` due to factors
1203 : external to the program, decided by the operating system.
1204 : Difference `budget - usage` is the amount of additional memory that can probably
1205 : be allocated without problems. Exceeding the budget may result in various problems.
1206 : */
1207 : VkDeviceSize budget;
1208 : } VmaBudget;
1209 :
1210 : /** @} */
1211 :
1212 : /**
1213 : \addtogroup group_alloc
1214 : @{
1215 : */
1216 :
1217 : /** \brief Parameters of new #VmaAllocation.
1218 :
1219 : To be used with functions like vmaCreateBuffer(), vmaCreateImage(), and many others.
1220 : */
1221 : typedef struct VmaAllocationCreateInfo
1222 : {
1223 : /// Use #VmaAllocationCreateFlagBits enum.
1224 : VmaAllocationCreateFlags flags;
1225 : /** \brief Intended usage of memory.
1226 :
1227 : You can leave #VMA_MEMORY_USAGE_UNKNOWN if you specify memory requirements in other way. \n
1228 : If `pool` is not null, this member is ignored.
1229 : */
1230 : VmaMemoryUsage usage;
1231 : /** \brief Flags that must be set in a Memory Type chosen for an allocation.
1232 :
1233 : Leave 0 if you specify memory requirements in other way. \n
1234 : If `pool` is not null, this member is ignored.*/
1235 : VkMemoryPropertyFlags requiredFlags;
1236 : /** \brief Flags that preferably should be set in a memory type chosen for an allocation.
1237 :
1238 : Set to 0 if no additional flags are preferred. \n
1239 : If `pool` is not null, this member is ignored. */
1240 : VkMemoryPropertyFlags preferredFlags;
1241 : /** \brief Bitmask containing one bit set for every memory type acceptable for this allocation.
1242 :
1243 : Value 0 is equivalent to `UINT32_MAX` - it means any memory type is accepted if
1244 : it meets other requirements specified by this structure, with no further
1245 : restrictions on memory type index. \n
1246 : If `pool` is not null, this member is ignored.
1247 : */
1248 : uint32_t memoryTypeBits;
1249 : /** \brief Pool that this allocation should be created in.
1250 :
1251 : Leave `VK_NULL_HANDLE` to allocate from default pool. If not null, members:
1252 : `usage`, `requiredFlags`, `preferredFlags`, `memoryTypeBits` are ignored.
1253 : */
1254 : VmaPool VMA_NULLABLE pool;
1255 : /** \brief Custom general-purpose pointer that will be stored in #VmaAllocation, can be read as VmaAllocationInfo::pUserData and changed using vmaSetAllocationUserData().
1256 :
1257 : If #VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT is used, it must be either
1258 : null or pointer to a null-terminated string. The string will be then copied to
1259 : internal buffer, so it doesn't need to be valid after allocation call.
1260 : */
1261 : void* VMA_NULLABLE pUserData;
1262 : /** \brief A floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.
1263 :
1264 : It is used only when #VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the #VmaAllocator object
1265 : and this allocation ends up as dedicated or is explicitly forced as dedicated using #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.
1266 : Otherwise, it has the priority of a memory block where it is placed and this variable is ignored.
1267 : */
1268 : float priority;
1269 : } VmaAllocationCreateInfo;
1270 :
1271 : /// Describes parameter of created #VmaPool.
1272 : typedef struct VmaPoolCreateInfo
1273 : {
1274 : /** \brief Vulkan memory type index to allocate this pool from.
1275 : */
1276 : uint32_t memoryTypeIndex;
1277 : /** \brief Use combination of #VmaPoolCreateFlagBits.
1278 : */
1279 : VmaPoolCreateFlags flags;
1280 : /** \brief Size of a single `VkDeviceMemory` block to be allocated as part of this pool, in bytes. Optional.
1281 :
1282 : Specify nonzero to set explicit, constant size of memory blocks used by this
1283 : pool.
1284 :
1285 : Leave 0 to use default and let the library manage block sizes automatically.
1286 : Sizes of particular blocks may vary.
1287 : In this case, the pool will also support dedicated allocations.
1288 : */
1289 : VkDeviceSize blockSize;
1290 : /** \brief Minimum number of blocks to be always allocated in this pool, even if they stay empty.
1291 :
1292 : Set to 0 to have no preallocated blocks and allow the pool be completely empty.
1293 : */
1294 : size_t minBlockCount;
1295 : /** \brief Maximum number of blocks that can be allocated in this pool. Optional.
1296 :
1297 : Set to 0 to use default, which is `SIZE_MAX`, which means no limit.
1298 :
1299 : Set to same value as VmaPoolCreateInfo::minBlockCount to have fixed amount of memory allocated
1300 : throughout whole lifetime of this pool.
1301 : */
1302 : size_t maxBlockCount;
1303 : /** \brief A floating-point value between 0 and 1, indicating the priority of the allocations in this pool relative to other memory allocations.
1304 :
1305 : It is used only when #VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the #VmaAllocator object.
1306 : Otherwise, this variable is ignored.
1307 : */
1308 : float priority;
1309 : /** \brief Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
1310 :
1311 : Leave 0 (default) not to impose any additional alignment. If not 0, it must be a power of two.
1312 : It can be useful in cases where alignment returned by Vulkan by functions like `vkGetBufferMemoryRequirements` is not enough,
1313 : e.g. when doing interop with OpenGL.
1314 : */
1315 : VkDeviceSize minAllocationAlignment;
1316 : /** \brief Additional `pNext` chain to be attached to `VkMemoryAllocateInfo` used for every allocation made by this pool. Optional.
1317 :
1318 : Optional, can be null. If not null, it must point to a `pNext` chain of structures that can be attached to `VkMemoryAllocateInfo`.
1319 : It can be useful for special needs such as adding `VkExportMemoryAllocateInfoKHR`.
1320 : Structures pointed by this member must remain alive and unchanged for the whole lifetime of the custom pool.
1321 :
1322 : Please note that some structures, e.g. `VkMemoryPriorityAllocateInfoEXT`, `VkMemoryDedicatedAllocateInfoKHR`,
1323 : can be attached automatically by this library when using other, more convenient of its features.
1324 : */
1325 : void* VMA_NULLABLE pMemoryAllocateNext;
1326 : } VmaPoolCreateInfo;
1327 :
1328 : /** @} */
1329 :
1330 : /**
1331 : \addtogroup group_alloc
1332 : @{
1333 : */
1334 :
1335 : /// Parameters of #VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
1336 : typedef struct VmaAllocationInfo
1337 : {
1338 : /** \brief Memory type index that this allocation was allocated from.
1339 :
1340 : It never changes.
1341 : */
1342 : uint32_t memoryType;
1343 : /** \brief Handle to Vulkan memory object.
1344 :
1345 : Same memory object can be shared by multiple allocations.
1346 :
1347 : It can change after the allocation is moved during \ref defragmentation.
1348 : */
1349 : VkDeviceMemory VMA_NULLABLE_NON_DISPATCHABLE deviceMemory;
1350 : /** \brief Offset in `VkDeviceMemory` object to the beginning of this allocation, in bytes. `(deviceMemory, offset)` pair is unique to this allocation.
1351 :
1352 : You usually don't need to use this offset. If you create a buffer or an image together with the allocation using e.g. function
1353 : vmaCreateBuffer(), vmaCreateImage(), functions that operate on these resources refer to the beginning of the buffer or image,
1354 : not entire device memory block. Functions like vmaMapMemory(), vmaBindBufferMemory() also refer to the beginning of the allocation
1355 : and apply this offset automatically.
1356 :
1357 : It can change after the allocation is moved during \ref defragmentation.
1358 : */
1359 : VkDeviceSize offset;
1360 : /** \brief Size of this allocation, in bytes.
1361 :
1362 : It never changes.
1363 :
1364 : \note Allocation size returned in this variable may be greater than the size
1365 : requested for the resource e.g. as `VkBufferCreateInfo::size`. Whole size of the
1366 : allocation is accessible for operations on memory e.g. using a pointer after
1367 : mapping with vmaMapMemory(), but operations on the resource e.g. using
1368 : `vkCmdCopyBuffer` must be limited to the size of the resource.
1369 : */
1370 : VkDeviceSize size;
1371 : /** \brief Pointer to the beginning of this allocation as mapped data.
1372 :
1373 : If the allocation hasn't been mapped using vmaMapMemory() and hasn't been
1374 : created with #VMA_ALLOCATION_CREATE_MAPPED_BIT flag, this value is null.
1375 :
1376 : It can change after call to vmaMapMemory(), vmaUnmapMemory().
1377 : It can also change after the allocation is moved during \ref defragmentation.
1378 : */
1379 : void* VMA_NULLABLE pMappedData;
1380 : /** \brief Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vmaSetAllocationUserData().
1381 :
1382 : It can change after call to vmaSetAllocationUserData() for this allocation.
1383 : */
1384 : void* VMA_NULLABLE pUserData;
1385 : /** \brief Custom allocation name that was set with vmaSetAllocationName().
1386 :
1387 : It can change after call to vmaSetAllocationName() for this allocation.
1388 :
1389 : Another way to set custom name is to pass it in VmaAllocationCreateInfo::pUserData with
1390 : additional flag #VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT set [DEPRECATED].
1391 : */
1392 : const char* VMA_NULLABLE pName;
1393 : } VmaAllocationInfo;
1394 :
1395 : /** \brief Parameters for defragmentation.
1396 :
1397 : To be used with function vmaBeginDefragmentation().
1398 : */
1399 : typedef struct VmaDefragmentationInfo
1400 : {
1401 : /// \brief Use combination of #VmaDefragmentationFlagBits.
1402 : VmaDefragmentationFlags flags;
1403 : /** \brief Custom pool to be defragmented.
1404 :
1405 : If null then default pools will undergo defragmentation process.
1406 : */
1407 : VmaPool VMA_NULLABLE pool;
1408 : /** \brief Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
1409 :
1410 : `0` means no limit.
1411 : */
1412 : VkDeviceSize maxBytesPerPass;
1413 : /** \brief Maximum number of allocations that can be moved during single pass to a different place.
1414 :
1415 : `0` means no limit.
1416 : */
1417 : uint32_t maxAllocationsPerPass;
1418 : } VmaDefragmentationInfo;
1419 :
1420 : /// Single move of an allocation to be done for defragmentation.
1421 : typedef struct VmaDefragmentationMove
1422 : {
1423 : /// Operation to be performed on the allocation by vmaEndDefragmentationPass(). Default value is #VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
1424 : VmaDefragmentationMoveOperation operation;
1425 : /// Allocation that should be moved.
1426 : VmaAllocation VMA_NOT_NULL srcAllocation;
1427 : /** \brief Temporary allocation pointing to destination memory that will replace `srcAllocation`.
1428 :
1429 : \warning Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass,
1430 : to be used for binding new buffer/image to the destination memory using e.g. vmaBindBufferMemory().
1431 : vmaEndDefragmentationPass() will destroy it and make `srcAllocation` point to this memory.
1432 : */
1433 : VmaAllocation VMA_NOT_NULL dstTmpAllocation;
1434 : } VmaDefragmentationMove;
1435 :
1436 : /** \brief Parameters for incremental defragmentation steps.
1437 :
1438 : To be used with function vmaBeginDefragmentationPass().
1439 : */
1440 : typedef struct VmaDefragmentationPassMoveInfo
1441 : {
1442 : /// Number of elements in the `pMoves` array.
1443 : uint32_t moveCount;
1444 : /** \brief Array of moves to be performed by the user in the current defragmentation pass.
1445 :
1446 : Pointer to an array of `moveCount` elements, owned by VMA, created in vmaBeginDefragmentationPass(), destroyed in vmaEndDefragmentationPass().
1447 :
1448 : For each element, you should:
1449 :
1450 : 1. Create a new buffer/image in the place pointed by VmaDefragmentationMove::dstMemory + VmaDefragmentationMove::dstOffset.
1451 : 2. Copy data from the VmaDefragmentationMove::srcAllocation e.g. using `vkCmdCopyBuffer`, `vkCmdCopyImage`.
1452 : 3. Make sure these commands finished executing on the GPU.
1453 : 4. Destroy the old buffer/image.
1454 :
1455 : Only then you can finish defragmentation pass by calling vmaEndDefragmentationPass().
1456 : After this call, the allocation will point to the new place in memory.
1457 :
1458 : Alternatively, if you cannot move specific allocation, you can set VmaDefragmentationMove::operation to #VMA_DEFRAGMENTATION_MOVE_OPERATION_IGNORE.
1459 :
1460 : Alternatively, if you decide you want to completely remove the allocation:
1461 :
1462 : 1. Destroy its buffer/image.
1463 : 2. Set VmaDefragmentationMove::operation to #VMA_DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
1464 :
1465 : Then, after vmaEndDefragmentationPass() the allocation will be freed.
1466 : */
1467 : VmaDefragmentationMove* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(moveCount) pMoves;
1468 : } VmaDefragmentationPassMoveInfo;
1469 :
1470 : /// Statistics returned for defragmentation process in function vmaEndDefragmentation().
1471 : typedef struct VmaDefragmentationStats
1472 : {
1473 : /// Total number of bytes that have been copied while moving allocations to different places.
1474 : VkDeviceSize bytesMoved;
1475 : /// Total number of bytes that have been released to the system by freeing empty `VkDeviceMemory` objects.
1476 : VkDeviceSize bytesFreed;
1477 : /// Number of allocations that have been moved to different places.
1478 : uint32_t allocationsMoved;
1479 : /// Number of empty `VkDeviceMemory` objects that have been released to the system.
1480 : uint32_t deviceMemoryBlocksFreed;
1481 : } VmaDefragmentationStats;
1482 :
1483 : /** @} */
1484 :
1485 : /**
1486 : \addtogroup group_virtual
1487 : @{
1488 : */
1489 :
1490 : /// Parameters of created #VmaVirtualBlock object to be passed to vmaCreateVirtualBlock().
1491 : typedef struct VmaVirtualBlockCreateInfo
1492 : {
1493 : /** \brief Total size of the virtual block.
1494 :
1495 : Sizes can be expressed in bytes or any units you want as long as you are consistent in using them.
1496 : For example, if you allocate from some array of structures, 1 can mean single instance of entire structure.
1497 : */
1498 : VkDeviceSize size;
1499 :
1500 : /** \brief Use combination of #VmaVirtualBlockCreateFlagBits.
1501 : */
1502 : VmaVirtualBlockCreateFlags flags;
1503 :
1504 : /** \brief Custom CPU memory allocation callbacks. Optional.
1505 :
1506 : Optional, can be null. When specified, they will be used for all CPU-side memory allocations.
1507 : */
1508 : const VkAllocationCallbacks* VMA_NULLABLE pAllocationCallbacks;
1509 : } VmaVirtualBlockCreateInfo;
1510 :
1511 : /// Parameters of created virtual allocation to be passed to vmaVirtualAllocate().
1512 : typedef struct VmaVirtualAllocationCreateInfo
1513 : {
1514 : /** \brief Size of the allocation.
1515 :
1516 : Cannot be zero.
1517 : */
1518 : VkDeviceSize size;
1519 : /** \brief Required alignment of the allocation. Optional.
1520 :
1521 : Must be power of two. Special value 0 has the same meaning as 1 - means no special alignment is required, so allocation can start at any offset.
1522 : */
1523 : VkDeviceSize alignment;
1524 : /** \brief Use combination of #VmaVirtualAllocationCreateFlagBits.
1525 : */
1526 : VmaVirtualAllocationCreateFlags flags;
1527 : /** \brief Custom pointer to be associated with the allocation. Optional.
1528 :
1529 : It can be any value and can be used for user-defined purposes. It can be fetched or changed later.
1530 : */
1531 : void* VMA_NULLABLE pUserData;
1532 : } VmaVirtualAllocationCreateInfo;
1533 :
1534 : /// Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo().
1535 : typedef struct VmaVirtualAllocationInfo
1536 : {
1537 : /** \brief Offset of the allocation.
1538 :
1539 : Offset at which the allocation was made.
1540 : */
1541 : VkDeviceSize offset;
1542 : /** \brief Size of the allocation.
1543 :
1544 : Same value as passed in VmaVirtualAllocationCreateInfo::size.
1545 : */
1546 : VkDeviceSize size;
1547 : /** \brief Custom pointer associated with the allocation.
1548 :
1549 : Same value as passed in VmaVirtualAllocationCreateInfo::pUserData or to vmaSetVirtualAllocationUserData().
1550 : */
1551 : void* VMA_NULLABLE pUserData;
1552 : } VmaVirtualAllocationInfo;
1553 :
1554 : /** @} */
1555 :
1556 : #endif // _VMA_DATA_TYPES_DECLARATIONS
1557 :
1558 : #ifndef _VMA_FUNCTION_HEADERS
1559 :
1560 : /**
1561 : \addtogroup group_init
1562 : @{
1563 : */
1564 :
1565 : /// Creates #VmaAllocator object.
1566 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateAllocator(
1567 : const VmaAllocatorCreateInfo* VMA_NOT_NULL pCreateInfo,
1568 : VmaAllocator VMA_NULLABLE* VMA_NOT_NULL pAllocator);
1569 :
1570 : /// Destroys allocator object.
1571 : VMA_CALL_PRE void VMA_CALL_POST vmaDestroyAllocator(
1572 : VmaAllocator VMA_NULLABLE allocator);
1573 :
1574 : /** \brief Returns information about existing #VmaAllocator object - handle to Vulkan device etc.
1575 :
1576 : It might be useful if you want to keep just the #VmaAllocator handle and fetch other required handles to
1577 : `VkPhysicalDevice`, `VkDevice` etc. every time using this function.
1578 : */
1579 : VMA_CALL_PRE void VMA_CALL_POST vmaGetAllocatorInfo(
1580 : VmaAllocator VMA_NOT_NULL allocator,
1581 : VmaAllocatorInfo* VMA_NOT_NULL pAllocatorInfo);
1582 :
1583 : /**
1584 : PhysicalDeviceProperties are fetched from physicalDevice by the allocator.
1585 : You can access it here, without fetching it again on your own.
1586 : */
1587 : VMA_CALL_PRE void VMA_CALL_POST vmaGetPhysicalDeviceProperties(
1588 : VmaAllocator VMA_NOT_NULL allocator,
1589 : const VkPhysicalDeviceProperties* VMA_NULLABLE* VMA_NOT_NULL ppPhysicalDeviceProperties);
1590 :
1591 : /**
1592 : PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator.
1593 : You can access it here, without fetching it again on your own.
1594 : */
1595 : VMA_CALL_PRE void VMA_CALL_POST vmaGetMemoryProperties(
1596 : VmaAllocator VMA_NOT_NULL allocator,
1597 : const VkPhysicalDeviceMemoryProperties* VMA_NULLABLE* VMA_NOT_NULL ppPhysicalDeviceMemoryProperties);
1598 :
1599 : /**
1600 : \brief Given Memory Type Index, returns Property Flags of this memory type.
1601 :
1602 : This is just a convenience function. Same information can be obtained using
1603 : vmaGetMemoryProperties().
1604 : */
1605 : VMA_CALL_PRE void VMA_CALL_POST vmaGetMemoryTypeProperties(
1606 : VmaAllocator VMA_NOT_NULL allocator,
1607 : uint32_t memoryTypeIndex,
1608 : VkMemoryPropertyFlags* VMA_NOT_NULL pFlags);
1609 :
1610 : /** \brief Sets index of the current frame.
1611 : */
1612 : VMA_CALL_PRE void VMA_CALL_POST vmaSetCurrentFrameIndex(
1613 : VmaAllocator VMA_NOT_NULL allocator,
1614 : uint32_t frameIndex);
1615 :
1616 : /** @} */
1617 :
1618 : /**
1619 : \addtogroup group_stats
1620 : @{
1621 : */
1622 :
1623 : /** \brief Retrieves statistics from current state of the Allocator.
1624 :
1625 : This function is called "calculate" not "get" because it has to traverse all
1626 : internal data structures, so it may be quite slow. Use it for debugging purposes.
1627 : For faster but more brief statistics suitable to be called every frame or every allocation,
1628 : use vmaGetHeapBudgets().
1629 :
1630 : Note that when using allocator from multiple threads, returned information may immediately
1631 : become outdated.
1632 : */
1633 : VMA_CALL_PRE void VMA_CALL_POST vmaCalculateStatistics(
1634 : VmaAllocator VMA_NOT_NULL allocator,
1635 : VmaTotalStatistics* VMA_NOT_NULL pStats);
1636 :
1637 : /** \brief Retrieves information about current memory usage and budget for all memory heaps.
1638 :
1639 : \param allocator
1640 : \param[out] pBudgets Must point to array with number of elements at least equal to number of memory heaps in physical device used.
1641 :
1642 : This function is called "get" not "calculate" because it is very fast, suitable to be called
1643 : every frame or every allocation. For more detailed statistics use vmaCalculateStatistics().
1644 :
1645 : Note that when using allocator from multiple threads, returned information may immediately
1646 : become outdated.
1647 : */
1648 : VMA_CALL_PRE void VMA_CALL_POST vmaGetHeapBudgets(
1649 : VmaAllocator VMA_NOT_NULL allocator,
1650 : VmaBudget* VMA_NOT_NULL VMA_LEN_IF_NOT_NULL("VkPhysicalDeviceMemoryProperties::memoryHeapCount") pBudgets);
1651 :
1652 : /** @} */
1653 :
1654 : /**
1655 : \addtogroup group_alloc
1656 : @{
1657 : */
1658 :
1659 : /**
1660 : \brief Helps to find memoryTypeIndex, given memoryTypeBits and VmaAllocationCreateInfo.
1661 :
1662 : This algorithm tries to find a memory type that:
1663 :
1664 : - Is allowed by memoryTypeBits.
1665 : - Contains all the flags from pAllocationCreateInfo->requiredFlags.
1666 : - Matches intended usage.
1667 : - Has as many flags from pAllocationCreateInfo->preferredFlags as possible.
1668 :
1669 : \return Returns VK_ERROR_FEATURE_NOT_PRESENT if not found. Receiving such result
1670 : from this function or any other allocating function probably means that your
1671 : device doesn't support any memory type with requested features for the specific
1672 : type of resource you want to use it for. Please check parameters of your
1673 : resource, like image layout (OPTIMAL versus LINEAR) or mip level count.
1674 : */
1675 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaFindMemoryTypeIndex(
1676 : VmaAllocator VMA_NOT_NULL allocator,
1677 : uint32_t memoryTypeBits,
1678 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
1679 : uint32_t* VMA_NOT_NULL pMemoryTypeIndex);
1680 :
1681 : /**
1682 : \brief Helps to find memoryTypeIndex, given VkBufferCreateInfo and VmaAllocationCreateInfo.
1683 :
1684 : It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex.
1685 : It internally creates a temporary, dummy buffer that never has memory bound.
1686 : */
1687 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaFindMemoryTypeIndexForBufferInfo(
1688 : VmaAllocator VMA_NOT_NULL allocator,
1689 : const VkBufferCreateInfo* VMA_NOT_NULL pBufferCreateInfo,
1690 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
1691 : uint32_t* VMA_NOT_NULL pMemoryTypeIndex);
1692 :
1693 : /**
1694 : \brief Helps to find memoryTypeIndex, given VkImageCreateInfo and VmaAllocationCreateInfo.
1695 :
1696 : It can be useful e.g. to determine value to be used as VmaPoolCreateInfo::memoryTypeIndex.
1697 : It internally creates a temporary, dummy image that never has memory bound.
1698 : */
1699 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaFindMemoryTypeIndexForImageInfo(
1700 : VmaAllocator VMA_NOT_NULL allocator,
1701 : const VkImageCreateInfo* VMA_NOT_NULL pImageCreateInfo,
1702 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
1703 : uint32_t* VMA_NOT_NULL pMemoryTypeIndex);
1704 :
1705 : /** \brief Allocates Vulkan device memory and creates #VmaPool object.
1706 :
1707 : \param allocator Allocator object.
1708 : \param pCreateInfo Parameters of pool to create.
1709 : \param[out] pPool Handle to created pool.
1710 : */
1711 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreatePool(
1712 : VmaAllocator VMA_NOT_NULL allocator,
1713 : const VmaPoolCreateInfo* VMA_NOT_NULL pCreateInfo,
1714 : VmaPool VMA_NULLABLE* VMA_NOT_NULL pPool);
1715 :
1716 : /** \brief Destroys #VmaPool object and frees Vulkan device memory.
1717 : */
1718 : VMA_CALL_PRE void VMA_CALL_POST vmaDestroyPool(
1719 : VmaAllocator VMA_NOT_NULL allocator,
1720 : VmaPool VMA_NULLABLE pool);
1721 :
1722 : /** @} */
1723 :
1724 : /**
1725 : \addtogroup group_stats
1726 : @{
1727 : */
1728 :
1729 : /** \brief Retrieves statistics of existing #VmaPool object.
1730 :
1731 : \param allocator Allocator object.
1732 : \param pool Pool object.
1733 : \param[out] pPoolStats Statistics of specified pool.
1734 : */
1735 : VMA_CALL_PRE void VMA_CALL_POST vmaGetPoolStatistics(
1736 : VmaAllocator VMA_NOT_NULL allocator,
1737 : VmaPool VMA_NOT_NULL pool,
1738 : VmaStatistics* VMA_NOT_NULL pPoolStats);
1739 :
1740 : /** \brief Retrieves detailed statistics of existing #VmaPool object.
1741 :
1742 : \param allocator Allocator object.
1743 : \param pool Pool object.
1744 : \param[out] pPoolStats Statistics of specified pool.
1745 : */
1746 : VMA_CALL_PRE void VMA_CALL_POST vmaCalculatePoolStatistics(
1747 : VmaAllocator VMA_NOT_NULL allocator,
1748 : VmaPool VMA_NOT_NULL pool,
1749 : VmaDetailedStatistics* VMA_NOT_NULL pPoolStats);
1750 :
1751 : /** @} */
1752 :
1753 : /**
1754 : \addtogroup group_alloc
1755 : @{
1756 : */
1757 :
1758 : /** \brief Checks magic number in margins around all allocations in given memory pool in search for corruptions.
1759 :
1760 : Corruption detection is enabled only when `VMA_DEBUG_DETECT_CORRUPTION` macro is defined to nonzero,
1761 : `VMA_DEBUG_MARGIN` is defined to nonzero and the pool is created in memory type that is
1762 : `HOST_VISIBLE` and `HOST_COHERENT`. For more information, see [Corruption detection](@ref debugging_memory_usage_corruption_detection).
1763 :
1764 : Possible return values:
1765 :
1766 : - `VK_ERROR_FEATURE_NOT_PRESENT` - corruption detection is not enabled for specified pool.
1767 : - `VK_SUCCESS` - corruption detection has been performed and succeeded.
1768 : - `VK_ERROR_UNKNOWN` - corruption detection has been performed and found memory corruptions around one of the allocations.
1769 : `VMA_ASSERT` is also fired in that case.
1770 : - Other value: Error returned by Vulkan, e.g. memory mapping failure.
1771 : */
1772 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCheckPoolCorruption(
1773 : VmaAllocator VMA_NOT_NULL allocator,
1774 : VmaPool VMA_NOT_NULL pool);
1775 :
1776 : /** \brief Retrieves name of a custom pool.
1777 :
1778 : After the call `ppName` is either null or points to an internally-owned null-terminated string
1779 : containing name of the pool that was previously set. The pointer becomes invalid when the pool is
1780 : destroyed or its name is changed using vmaSetPoolName().
1781 : */
1782 : VMA_CALL_PRE void VMA_CALL_POST vmaGetPoolName(
1783 : VmaAllocator VMA_NOT_NULL allocator,
1784 : VmaPool VMA_NOT_NULL pool,
1785 : const char* VMA_NULLABLE* VMA_NOT_NULL ppName);
1786 :
1787 : /** \brief Sets name of a custom pool.
1788 :
1789 : `pName` can be either null or pointer to a null-terminated string with new name for the pool.
1790 : Function makes internal copy of the string, so it can be changed or freed immediately after this call.
1791 : */
1792 : VMA_CALL_PRE void VMA_CALL_POST vmaSetPoolName(
1793 : VmaAllocator VMA_NOT_NULL allocator,
1794 : VmaPool VMA_NOT_NULL pool,
1795 : const char* VMA_NULLABLE pName);
1796 :
1797 : /** \brief General purpose memory allocation.
1798 :
1799 : \param allocator
1800 : \param pVkMemoryRequirements
1801 : \param pCreateInfo
1802 : \param[out] pAllocation Handle to allocated memory.
1803 : \param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo().
1804 :
1805 : You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages().
1806 :
1807 : It is recommended to use vmaAllocateMemoryForBuffer(), vmaAllocateMemoryForImage(),
1808 : vmaCreateBuffer(), vmaCreateImage() instead whenever possible.
1809 : */
1810 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaAllocateMemory(
1811 : VmaAllocator VMA_NOT_NULL allocator,
1812 : const VkMemoryRequirements* VMA_NOT_NULL pVkMemoryRequirements,
1813 : const VmaAllocationCreateInfo* VMA_NOT_NULL pCreateInfo,
1814 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
1815 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
1816 :
1817 : /** \brief General purpose memory allocation for multiple allocation objects at once.
1818 :
1819 : \param allocator Allocator object.
1820 : \param pVkMemoryRequirements Memory requirements for each allocation.
1821 : \param pCreateInfo Creation parameters for each allocation.
1822 : \param allocationCount Number of allocations to make.
1823 : \param[out] pAllocations Pointer to array that will be filled with handles to created allocations.
1824 : \param[out] pAllocationInfo Optional. Pointer to array that will be filled with parameters of created allocations.
1825 :
1826 : You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages().
1827 :
1828 : Word "pages" is just a suggestion to use this function to allocate pieces of memory needed for sparse binding.
1829 : It is just a general purpose allocation function able to make multiple allocations at once.
1830 : It may be internally optimized to be more efficient than calling vmaAllocateMemory() `allocationCount` times.
1831 :
1832 : All allocations are made using same parameters. All of them are created out of the same memory pool and type.
1833 : If any allocation fails, all allocations already made within this function call are also freed, so that when
1834 : returned result is not `VK_SUCCESS`, `pAllocation` array is always entirely filled with `VK_NULL_HANDLE`.
1835 : */
1836 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaAllocateMemoryPages(
1837 : VmaAllocator VMA_NOT_NULL allocator,
1838 : const VkMemoryRequirements* VMA_NOT_NULL VMA_LEN_IF_NOT_NULL(allocationCount) pVkMemoryRequirements,
1839 : const VmaAllocationCreateInfo* VMA_NOT_NULL VMA_LEN_IF_NOT_NULL(allocationCount) pCreateInfo,
1840 : size_t allocationCount,
1841 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL VMA_LEN_IF_NOT_NULL(allocationCount) pAllocations,
1842 : VmaAllocationInfo* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) pAllocationInfo);
1843 :
1844 : /** \brief Allocates memory suitable for given `VkBuffer`.
1845 :
1846 : \param allocator
1847 : \param buffer
1848 : \param pCreateInfo
1849 : \param[out] pAllocation Handle to allocated memory.
1850 : \param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo().
1851 :
1852 : It only creates #VmaAllocation. To bind the memory to the buffer, use vmaBindBufferMemory().
1853 :
1854 : This is a special-purpose function. In most cases you should use vmaCreateBuffer().
1855 :
1856 : You must free the allocation using vmaFreeMemory() when no longer needed.
1857 : */
1858 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaAllocateMemoryForBuffer(
1859 : VmaAllocator VMA_NOT_NULL allocator,
1860 : VkBuffer VMA_NOT_NULL_NON_DISPATCHABLE buffer,
1861 : const VmaAllocationCreateInfo* VMA_NOT_NULL pCreateInfo,
1862 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
1863 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
1864 :
1865 : /** \brief Allocates memory suitable for given `VkImage`.
1866 :
1867 : \param allocator
1868 : \param image
1869 : \param pCreateInfo
1870 : \param[out] pAllocation Handle to allocated memory.
1871 : \param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo().
1872 :
1873 : It only creates #VmaAllocation. To bind the memory to the buffer, use vmaBindImageMemory().
1874 :
1875 : This is a special-purpose function. In most cases you should use vmaCreateImage().
1876 :
1877 : You must free the allocation using vmaFreeMemory() when no longer needed.
1878 : */
1879 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaAllocateMemoryForImage(
1880 : VmaAllocator VMA_NOT_NULL allocator,
1881 : VkImage VMA_NOT_NULL_NON_DISPATCHABLE image,
1882 : const VmaAllocationCreateInfo* VMA_NOT_NULL pCreateInfo,
1883 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
1884 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
1885 :
1886 : /** \brief Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(), or vmaAllocateMemoryForImage().
1887 :
1888 : Passing `VK_NULL_HANDLE` as `allocation` is valid. Such function call is just skipped.
1889 : */
1890 : VMA_CALL_PRE void VMA_CALL_POST vmaFreeMemory(
1891 : VmaAllocator VMA_NOT_NULL allocator,
1892 : const VmaAllocation VMA_NULLABLE allocation);
1893 :
1894 : /** \brief Frees memory and destroys multiple allocations.
1895 :
1896 : Word "pages" is just a suggestion to use this function to free pieces of memory used for sparse binding.
1897 : It is just a general purpose function to free memory and destroy allocations made using e.g. vmaAllocateMemory(),
1898 : vmaAllocateMemoryPages() and other functions.
1899 : It may be internally optimized to be more efficient than calling vmaFreeMemory() `allocationCount` times.
1900 :
1901 : Allocations in `pAllocations` array can come from any memory pools and types.
1902 : Passing `VK_NULL_HANDLE` as elements of `pAllocations` array is valid. Such entries are just skipped.
1903 : */
1904 : VMA_CALL_PRE void VMA_CALL_POST vmaFreeMemoryPages(
1905 : VmaAllocator VMA_NOT_NULL allocator,
1906 : size_t allocationCount,
1907 : const VmaAllocation VMA_NULLABLE* VMA_NOT_NULL VMA_LEN_IF_NOT_NULL(allocationCount) pAllocations);
1908 :
1909 : /** \brief Returns current information about specified allocation.
1910 :
1911 : Current paramteres of given allocation are returned in `pAllocationInfo`.
1912 :
1913 : Although this function doesn't lock any mutex, so it should be quite efficient,
1914 : you should avoid calling it too often.
1915 : You can retrieve same VmaAllocationInfo structure while creating your resource, from function
1916 : vmaCreateBuffer(), vmaCreateImage(). You can remember it if you are sure parameters don't change
1917 : (e.g. due to defragmentation).
1918 : */
1919 : VMA_CALL_PRE void VMA_CALL_POST vmaGetAllocationInfo(
1920 : VmaAllocator VMA_NOT_NULL allocator,
1921 : VmaAllocation VMA_NOT_NULL allocation,
1922 : VmaAllocationInfo* VMA_NOT_NULL pAllocationInfo);
1923 :
1924 : /** \brief Sets pUserData in given allocation to new value.
1925 :
1926 : The value of pointer `pUserData` is copied to allocation's `pUserData`.
1927 : It is opaque, so you can use it however you want - e.g.
1928 : as a pointer, ordinal number or some handle to you own data.
1929 : */
1930 : VMA_CALL_PRE void VMA_CALL_POST vmaSetAllocationUserData(
1931 : VmaAllocator VMA_NOT_NULL allocator,
1932 : VmaAllocation VMA_NOT_NULL allocation,
1933 : void* VMA_NULLABLE pUserData);
1934 :
1935 : /** \brief Sets pName in given allocation to new value.
1936 :
1937 : `pName` must be either null, or pointer to a null-terminated string. The function
1938 : makes local copy of the string and sets it as allocation's `pName`. String
1939 : passed as pName doesn't need to be valid for whole lifetime of the allocation -
1940 : you can free it after this call. String previously pointed by allocation's
1941 : `pName` is freed from memory.
1942 : */
1943 : VMA_CALL_PRE void VMA_CALL_POST vmaSetAllocationName(
1944 : VmaAllocator VMA_NOT_NULL allocator,
1945 : VmaAllocation VMA_NOT_NULL allocation,
1946 : const char* VMA_NULLABLE pName);
1947 :
1948 : /**
1949 : \brief Given an allocation, returns Property Flags of its memory type.
1950 :
1951 : This is just a convenience function. Same information can be obtained using
1952 : vmaGetAllocationInfo() + vmaGetMemoryProperties().
1953 : */
1954 : VMA_CALL_PRE void VMA_CALL_POST vmaGetAllocationMemoryProperties(
1955 : VmaAllocator VMA_NOT_NULL allocator,
1956 : VmaAllocation VMA_NOT_NULL allocation,
1957 : VkMemoryPropertyFlags* VMA_NOT_NULL pFlags);
1958 :
1959 : /** \brief Maps memory represented by given allocation and returns pointer to it.
1960 :
1961 : Maps memory represented by given allocation to make it accessible to CPU code.
1962 : When succeeded, `*ppData` contains pointer to first byte of this memory.
1963 :
1964 : \warning
1965 : If the allocation is part of a bigger `VkDeviceMemory` block, returned pointer is
1966 : correctly offsetted to the beginning of region assigned to this particular allocation.
1967 : Unlike the result of `vkMapMemory`, it points to the allocation, not to the beginning of the whole block.
1968 : You should not add VmaAllocationInfo::offset to it!
1969 :
1970 : Mapping is internally reference-counted and synchronized, so despite raw Vulkan
1971 : function `vkMapMemory()` cannot be used to map same block of `VkDeviceMemory`
1972 : multiple times simultaneously, it is safe to call this function on allocations
1973 : assigned to the same memory block. Actual Vulkan memory will be mapped on first
1974 : mapping and unmapped on last unmapping.
1975 :
1976 : If the function succeeded, you must call vmaUnmapMemory() to unmap the
1977 : allocation when mapping is no longer needed or before freeing the allocation, at
1978 : the latest.
1979 :
1980 : It also safe to call this function multiple times on the same allocation. You
1981 : must call vmaUnmapMemory() same number of times as you called vmaMapMemory().
1982 :
1983 : It is also safe to call this function on allocation created with
1984 : #VMA_ALLOCATION_CREATE_MAPPED_BIT flag. Its memory stays mapped all the time.
1985 : You must still call vmaUnmapMemory() same number of times as you called
1986 : vmaMapMemory(). You must not call vmaUnmapMemory() additional time to free the
1987 : "0-th" mapping made automatically due to #VMA_ALLOCATION_CREATE_MAPPED_BIT flag.
1988 :
1989 : This function fails when used on allocation made in memory type that is not
1990 : `HOST_VISIBLE`.
1991 :
1992 : This function doesn't automatically flush or invalidate caches.
1993 : If the allocation is made from a memory types that is not `HOST_COHERENT`,
1994 : you also need to use vmaInvalidateAllocation() / vmaFlushAllocation(), as required by Vulkan specification.
1995 : */
1996 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaMapMemory(
1997 : VmaAllocator VMA_NOT_NULL allocator,
1998 : VmaAllocation VMA_NOT_NULL allocation,
1999 : void* VMA_NULLABLE* VMA_NOT_NULL ppData);
2000 :
2001 : /** \brief Unmaps memory represented by given allocation, mapped previously using vmaMapMemory().
2002 :
2003 : For details, see description of vmaMapMemory().
2004 :
2005 : This function doesn't automatically flush or invalidate caches.
2006 : If the allocation is made from a memory types that is not `HOST_COHERENT`,
2007 : you also need to use vmaInvalidateAllocation() / vmaFlushAllocation(), as required by Vulkan specification.
2008 : */
2009 : VMA_CALL_PRE void VMA_CALL_POST vmaUnmapMemory(
2010 : VmaAllocator VMA_NOT_NULL allocator,
2011 : VmaAllocation VMA_NOT_NULL allocation);
2012 :
2013 : /** \brief Flushes memory of given allocation.
2014 :
2015 : Calls `vkFlushMappedMemoryRanges()` for memory associated with given range of given allocation.
2016 : It needs to be called after writing to a mapped memory for memory types that are not `HOST_COHERENT`.
2017 : Unmap operation doesn't do that automatically.
2018 :
2019 : - `offset` must be relative to the beginning of allocation.
2020 : - `size` can be `VK_WHOLE_SIZE`. It means all memory from `offset` the the end of given allocation.
2021 : - `offset` and `size` don't have to be aligned.
2022 : They are internally rounded down/up to multiply of `nonCoherentAtomSize`.
2023 : - If `size` is 0, this call is ignored.
2024 : - If memory type that the `allocation` belongs to is not `HOST_VISIBLE` or it is `HOST_COHERENT`,
2025 : this call is ignored.
2026 :
2027 : Warning! `offset` and `size` are relative to the contents of given `allocation`.
2028 : If you mean whole allocation, you can pass 0 and `VK_WHOLE_SIZE`, respectively.
2029 : Do not pass allocation's offset as `offset`!!!
2030 :
2031 : This function returns the `VkResult` from `vkFlushMappedMemoryRanges` if it is
2032 : called, otherwise `VK_SUCCESS`.
2033 : */
2034 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaFlushAllocation(
2035 : VmaAllocator VMA_NOT_NULL allocator,
2036 : VmaAllocation VMA_NOT_NULL allocation,
2037 : VkDeviceSize offset,
2038 : VkDeviceSize size);
2039 :
2040 : /** \brief Invalidates memory of given allocation.
2041 :
2042 : Calls `vkInvalidateMappedMemoryRanges()` for memory associated with given range of given allocation.
2043 : It needs to be called before reading from a mapped memory for memory types that are not `HOST_COHERENT`.
2044 : Map operation doesn't do that automatically.
2045 :
2046 : - `offset` must be relative to the beginning of allocation.
2047 : - `size` can be `VK_WHOLE_SIZE`. It means all memory from `offset` the the end of given allocation.
2048 : - `offset` and `size` don't have to be aligned.
2049 : They are internally rounded down/up to multiply of `nonCoherentAtomSize`.
2050 : - If `size` is 0, this call is ignored.
2051 : - If memory type that the `allocation` belongs to is not `HOST_VISIBLE` or it is `HOST_COHERENT`,
2052 : this call is ignored.
2053 :
2054 : Warning! `offset` and `size` are relative to the contents of given `allocation`.
2055 : If you mean whole allocation, you can pass 0 and `VK_WHOLE_SIZE`, respectively.
2056 : Do not pass allocation's offset as `offset`!!!
2057 :
2058 : This function returns the `VkResult` from `vkInvalidateMappedMemoryRanges` if
2059 : it is called, otherwise `VK_SUCCESS`.
2060 : */
2061 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaInvalidateAllocation(
2062 : VmaAllocator VMA_NOT_NULL allocator,
2063 : VmaAllocation VMA_NOT_NULL allocation,
2064 : VkDeviceSize offset,
2065 : VkDeviceSize size);
2066 :
2067 : /** \brief Flushes memory of given set of allocations.
2068 :
2069 : Calls `vkFlushMappedMemoryRanges()` for memory associated with given ranges of given allocations.
2070 : For more information, see documentation of vmaFlushAllocation().
2071 :
2072 : \param allocator
2073 : \param allocationCount
2074 : \param allocations
2075 : \param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
2076 : \param sizes If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means `VK_WHOLE_SIZE` for all allocations.
2077 :
2078 : This function returns the `VkResult` from `vkFlushMappedMemoryRanges` if it is
2079 : called, otherwise `VK_SUCCESS`.
2080 : */
2081 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaFlushAllocations(
2082 : VmaAllocator VMA_NOT_NULL allocator,
2083 : uint32_t allocationCount,
2084 : const VmaAllocation VMA_NOT_NULL* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) allocations,
2085 : const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) offsets,
2086 : const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) sizes);
2087 :
2088 : /** \brief Invalidates memory of given set of allocations.
2089 :
2090 : Calls `vkInvalidateMappedMemoryRanges()` for memory associated with given ranges of given allocations.
2091 : For more information, see documentation of vmaInvalidateAllocation().
2092 :
2093 : \param allocator
2094 : \param allocationCount
2095 : \param allocations
2096 : \param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
2097 : \param sizes If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means `VK_WHOLE_SIZE` for all allocations.
2098 :
2099 : This function returns the `VkResult` from `vkInvalidateMappedMemoryRanges` if it is
2100 : called, otherwise `VK_SUCCESS`.
2101 : */
2102 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaInvalidateAllocations(
2103 : VmaAllocator VMA_NOT_NULL allocator,
2104 : uint32_t allocationCount,
2105 : const VmaAllocation VMA_NOT_NULL* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) allocations,
2106 : const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) offsets,
2107 : const VkDeviceSize* VMA_NULLABLE VMA_LEN_IF_NOT_NULL(allocationCount) sizes);
2108 :
2109 : /** \brief Checks magic number in margins around all allocations in given memory types (in both default and custom pools) in search for corruptions.
2110 :
2111 : \param allocator
2112 : \param memoryTypeBits Bit mask, where each bit set means that a memory type with that index should be checked.
2113 :
2114 : Corruption detection is enabled only when `VMA_DEBUG_DETECT_CORRUPTION` macro is defined to nonzero,
2115 : `VMA_DEBUG_MARGIN` is defined to nonzero and only for memory types that are
2116 : `HOST_VISIBLE` and `HOST_COHERENT`. For more information, see [Corruption detection](@ref debugging_memory_usage_corruption_detection).
2117 :
2118 : Possible return values:
2119 :
2120 : - `VK_ERROR_FEATURE_NOT_PRESENT` - corruption detection is not enabled for any of specified memory types.
2121 : - `VK_SUCCESS` - corruption detection has been performed and succeeded.
2122 : - `VK_ERROR_UNKNOWN` - corruption detection has been performed and found memory corruptions around one of the allocations.
2123 : `VMA_ASSERT` is also fired in that case.
2124 : - Other value: Error returned by Vulkan, e.g. memory mapping failure.
2125 : */
2126 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCheckCorruption(
2127 : VmaAllocator VMA_NOT_NULL allocator,
2128 : uint32_t memoryTypeBits);
2129 :
2130 : /** \brief Begins defragmentation process.
2131 :
2132 : \param allocator Allocator object.
2133 : \param pInfo Structure filled with parameters of defragmentation.
2134 : \param[out] pContext Context object that must be passed to vmaEndDefragmentation() to finish defragmentation.
2135 : \returns
2136 : - `VK_SUCCESS` if defragmentation can begin.
2137 : - `VK_ERROR_FEATURE_NOT_PRESENT` if defragmentation is not supported.
2138 :
2139 : For more information about defragmentation, see documentation chapter:
2140 : [Defragmentation](@ref defragmentation).
2141 : */
2142 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBeginDefragmentation(
2143 : VmaAllocator VMA_NOT_NULL allocator,
2144 : const VmaDefragmentationInfo* VMA_NOT_NULL pInfo,
2145 : VmaDefragmentationContext VMA_NULLABLE* VMA_NOT_NULL pContext);
2146 :
2147 : /** \brief Ends defragmentation process.
2148 :
2149 : \param allocator Allocator object.
2150 : \param context Context object that has been created by vmaBeginDefragmentation().
2151 : \param[out] pStats Optional stats for the defragmentation. Can be null.
2152 :
2153 : Use this function to finish defragmentation started by vmaBeginDefragmentation().
2154 : */
2155 : VMA_CALL_PRE void VMA_CALL_POST vmaEndDefragmentation(
2156 : VmaAllocator VMA_NOT_NULL allocator,
2157 : VmaDefragmentationContext VMA_NOT_NULL context,
2158 : VmaDefragmentationStats* VMA_NULLABLE pStats);
2159 :
2160 : /** \brief Starts single defragmentation pass.
2161 :
2162 : \param allocator Allocator object.
2163 : \param context Context object that has been created by vmaBeginDefragmentation().
2164 : \param[out] pPassInfo Computed informations for current pass.
2165 : \returns
2166 : - `VK_SUCCESS` if no more moves are possible. Then you can omit call to vmaEndDefragmentationPass() and simply end whole defragmentation.
2167 : - `VK_INCOMPLETE` if there are pending moves returned in `pPassInfo`. You need to perform them, call vmaEndDefragmentationPass(),
2168 : and then preferably try another pass with vmaBeginDefragmentationPass().
2169 : */
2170 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBeginDefragmentationPass(
2171 : VmaAllocator VMA_NOT_NULL allocator,
2172 : VmaDefragmentationContext VMA_NOT_NULL context,
2173 : VmaDefragmentationPassMoveInfo* VMA_NOT_NULL pPassInfo);
2174 :
2175 : /** \brief Ends single defragmentation pass.
2176 :
2177 : \param allocator Allocator object.
2178 : \param context Context object that has been created by vmaBeginDefragmentation().
2179 : \param pPassInfo Computed informations for current pass filled by vmaBeginDefragmentationPass() and possibly modified by you.
2180 :
2181 : Returns `VK_SUCCESS` if no more moves are possible or `VK_INCOMPLETE` if more defragmentations are possible.
2182 :
2183 : Ends incremental defragmentation pass and commits all defragmentation moves from `pPassInfo`.
2184 : After this call:
2185 :
2186 : - Allocations at `pPassInfo[i].srcAllocation` that had `pPassInfo[i].operation ==` #VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY
2187 : (which is the default) will be pointing to the new destination place.
2188 : - Allocation at `pPassInfo[i].srcAllocation` that had `pPassInfo[i].operation ==` #VMA_DEFRAGMENTATION_MOVE_OPERATION_DESTROY
2189 : will be freed.
2190 :
2191 : If no more moves are possible you can end whole defragmentation.
2192 : */
2193 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaEndDefragmentationPass(
2194 : VmaAllocator VMA_NOT_NULL allocator,
2195 : VmaDefragmentationContext VMA_NOT_NULL context,
2196 : VmaDefragmentationPassMoveInfo* VMA_NOT_NULL pPassInfo);
2197 :
2198 : /** \brief Binds buffer to allocation.
2199 :
2200 : Binds specified buffer to region of memory represented by specified allocation.
2201 : Gets `VkDeviceMemory` handle and offset from the allocation.
2202 : If you want to create a buffer, allocate memory for it and bind them together separately,
2203 : you should use this function for binding instead of standard `vkBindBufferMemory()`,
2204 : because it ensures proper synchronization so that when a `VkDeviceMemory` object is used by multiple
2205 : allocations, calls to `vkBind*Memory()` or `vkMapMemory()` won't happen from multiple threads simultaneously
2206 : (which is illegal in Vulkan).
2207 :
2208 : It is recommended to use function vmaCreateBuffer() instead of this one.
2209 : */
2210 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBindBufferMemory(
2211 : VmaAllocator VMA_NOT_NULL allocator,
2212 : VmaAllocation VMA_NOT_NULL allocation,
2213 : VkBuffer VMA_NOT_NULL_NON_DISPATCHABLE buffer);
2214 :
2215 : /** \brief Binds buffer to allocation with additional parameters.
2216 :
2217 : \param allocator
2218 : \param allocation
2219 : \param allocationLocalOffset Additional offset to be added while binding, relative to the beginning of the `allocation`. Normally it should be 0.
2220 : \param buffer
2221 : \param pNext A chain of structures to be attached to `VkBindBufferMemoryInfoKHR` structure used internally. Normally it should be null.
2222 :
2223 : This function is similar to vmaBindBufferMemory(), but it provides additional parameters.
2224 :
2225 : If `pNext` is not null, #VmaAllocator object must have been created with #VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag
2226 : or with VmaAllocatorCreateInfo::vulkanApiVersion `>= VK_API_VERSION_1_1`. Otherwise the call fails.
2227 : */
2228 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBindBufferMemory2(
2229 : VmaAllocator VMA_NOT_NULL allocator,
2230 : VmaAllocation VMA_NOT_NULL allocation,
2231 : VkDeviceSize allocationLocalOffset,
2232 : VkBuffer VMA_NOT_NULL_NON_DISPATCHABLE buffer,
2233 : const void* VMA_NULLABLE pNext);
2234 :
2235 : /** \brief Binds image to allocation.
2236 :
2237 : Binds specified image to region of memory represented by specified allocation.
2238 : Gets `VkDeviceMemory` handle and offset from the allocation.
2239 : If you want to create an image, allocate memory for it and bind them together separately,
2240 : you should use this function for binding instead of standard `vkBindImageMemory()`,
2241 : because it ensures proper synchronization so that when a `VkDeviceMemory` object is used by multiple
2242 : allocations, calls to `vkBind*Memory()` or `vkMapMemory()` won't happen from multiple threads simultaneously
2243 : (which is illegal in Vulkan).
2244 :
2245 : It is recommended to use function vmaCreateImage() instead of this one.
2246 : */
2247 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBindImageMemory(
2248 : VmaAllocator VMA_NOT_NULL allocator,
2249 : VmaAllocation VMA_NOT_NULL allocation,
2250 : VkImage VMA_NOT_NULL_NON_DISPATCHABLE image);
2251 :
2252 : /** \brief Binds image to allocation with additional parameters.
2253 :
2254 : \param allocator
2255 : \param allocation
2256 : \param allocationLocalOffset Additional offset to be added while binding, relative to the beginning of the `allocation`. Normally it should be 0.
2257 : \param image
2258 : \param pNext A chain of structures to be attached to `VkBindImageMemoryInfoKHR` structure used internally. Normally it should be null.
2259 :
2260 : This function is similar to vmaBindImageMemory(), but it provides additional parameters.
2261 :
2262 : If `pNext` is not null, #VmaAllocator object must have been created with #VMA_ALLOCATOR_CREATE_KHR_BIND_MEMORY2_BIT flag
2263 : or with VmaAllocatorCreateInfo::vulkanApiVersion `>= VK_API_VERSION_1_1`. Otherwise the call fails.
2264 : */
2265 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaBindImageMemory2(
2266 : VmaAllocator VMA_NOT_NULL allocator,
2267 : VmaAllocation VMA_NOT_NULL allocation,
2268 : VkDeviceSize allocationLocalOffset,
2269 : VkImage VMA_NOT_NULL_NON_DISPATCHABLE image,
2270 : const void* VMA_NULLABLE pNext);
2271 :
2272 : /** \brief Creates a new `VkBuffer`, allocates and binds memory for it.
2273 :
2274 : \param allocator
2275 : \param pBufferCreateInfo
2276 : \param pAllocationCreateInfo
2277 : \param[out] pBuffer Buffer that was created.
2278 : \param[out] pAllocation Allocation that was created.
2279 : \param[out] pAllocationInfo Optional. Information about allocated memory. It can be later fetched using function vmaGetAllocationInfo().
2280 :
2281 : This function automatically:
2282 :
2283 : -# Creates buffer.
2284 : -# Allocates appropriate memory for it.
2285 : -# Binds the buffer with the memory.
2286 :
2287 : If any of these operations fail, buffer and allocation are not created,
2288 : returned value is negative error code, `*pBuffer` and `*pAllocation` are null.
2289 :
2290 : If the function succeeded, you must destroy both buffer and allocation when you
2291 : no longer need them using either convenience function vmaDestroyBuffer() or
2292 : separately, using `vkDestroyBuffer()` and vmaFreeMemory().
2293 :
2294 : If #VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT flag was used,
2295 : VK_KHR_dedicated_allocation extension is used internally to query driver whether
2296 : it requires or prefers the new buffer to have dedicated allocation. If yes,
2297 : and if dedicated allocation is possible
2298 : (#VMA_ALLOCATION_CREATE_NEVER_ALLOCATE_BIT is not used), it creates dedicated
2299 : allocation for this buffer, just like when using
2300 : #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.
2301 :
2302 : \note This function creates a new `VkBuffer`. Sub-allocation of parts of one large buffer,
2303 : although recommended as a good practice, is out of scope of this library and could be implemented
2304 : by the user as a higher-level logic on top of VMA.
2305 : */
2306 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateBuffer(
2307 : VmaAllocator VMA_NOT_NULL allocator,
2308 : const VkBufferCreateInfo* VMA_NOT_NULL pBufferCreateInfo,
2309 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
2310 : VkBuffer VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pBuffer,
2311 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
2312 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
2313 :
2314 : /** \brief Creates a buffer with additional minimum alignment.
2315 :
2316 : Similar to vmaCreateBuffer() but provides additional parameter `minAlignment` which allows to specify custom,
2317 : minimum alignment to be used when placing the buffer inside a larger memory block, which may be needed e.g.
2318 : for interop with OpenGL.
2319 : */
2320 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateBufferWithAlignment(
2321 : VmaAllocator VMA_NOT_NULL allocator,
2322 : const VkBufferCreateInfo* VMA_NOT_NULL pBufferCreateInfo,
2323 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
2324 : VkDeviceSize minAlignment,
2325 : VkBuffer VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pBuffer,
2326 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
2327 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
2328 :
2329 : /** \brief Creates a new `VkBuffer`, binds already created memory for it.
2330 :
2331 : \param allocator
2332 : \param allocation Allocation that provides memory to be used for binding new buffer to it.
2333 : \param pBufferCreateInfo
2334 : \param[out] pBuffer Buffer that was created.
2335 :
2336 : This function automatically:
2337 :
2338 : -# Creates buffer.
2339 : -# Binds the buffer with the supplied memory.
2340 :
2341 : If any of these operations fail, buffer is not created,
2342 : returned value is negative error code and `*pBuffer` is null.
2343 :
2344 : If the function succeeded, you must destroy the buffer when you
2345 : no longer need it using `vkDestroyBuffer()`. If you want to also destroy the corresponding
2346 : allocation you can use convenience function vmaDestroyBuffer().
2347 : */
2348 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateAliasingBuffer(
2349 : VmaAllocator VMA_NOT_NULL allocator,
2350 : VmaAllocation VMA_NOT_NULL allocation,
2351 : const VkBufferCreateInfo* VMA_NOT_NULL pBufferCreateInfo,
2352 : VkBuffer VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pBuffer);
2353 :
2354 : /** \brief Destroys Vulkan buffer and frees allocated memory.
2355 :
2356 : This is just a convenience function equivalent to:
2357 :
2358 : \code
2359 : vkDestroyBuffer(device, buffer, allocationCallbacks);
2360 : vmaFreeMemory(allocator, allocation);
2361 : \endcode
2362 :
2363 : It it safe to pass null as buffer and/or allocation.
2364 : */
2365 : VMA_CALL_PRE void VMA_CALL_POST vmaDestroyBuffer(
2366 : VmaAllocator VMA_NOT_NULL allocator,
2367 : VkBuffer VMA_NULLABLE_NON_DISPATCHABLE buffer,
2368 : VmaAllocation VMA_NULLABLE allocation);
2369 :
2370 : /// Function similar to vmaCreateBuffer().
2371 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateImage(
2372 : VmaAllocator VMA_NOT_NULL allocator,
2373 : const VkImageCreateInfo* VMA_NOT_NULL pImageCreateInfo,
2374 : const VmaAllocationCreateInfo* VMA_NOT_NULL pAllocationCreateInfo,
2375 : VkImage VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pImage,
2376 : VmaAllocation VMA_NULLABLE* VMA_NOT_NULL pAllocation,
2377 : VmaAllocationInfo* VMA_NULLABLE pAllocationInfo);
2378 :
2379 : /// Function similar to vmaCreateAliasingBuffer().
2380 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateAliasingImage(
2381 : VmaAllocator VMA_NOT_NULL allocator,
2382 : VmaAllocation VMA_NOT_NULL allocation,
2383 : const VkImageCreateInfo* VMA_NOT_NULL pImageCreateInfo,
2384 : VkImage VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pImage);
2385 :
2386 : /** \brief Destroys Vulkan image and frees allocated memory.
2387 :
2388 : This is just a convenience function equivalent to:
2389 :
2390 : \code
2391 : vkDestroyImage(device, image, allocationCallbacks);
2392 : vmaFreeMemory(allocator, allocation);
2393 : \endcode
2394 :
2395 : It it safe to pass null as image and/or allocation.
2396 : */
2397 : VMA_CALL_PRE void VMA_CALL_POST vmaDestroyImage(
2398 : VmaAllocator VMA_NOT_NULL allocator,
2399 : VkImage VMA_NULLABLE_NON_DISPATCHABLE image,
2400 : VmaAllocation VMA_NULLABLE allocation);
2401 :
2402 : /** @} */
2403 :
2404 : /**
2405 : \addtogroup group_virtual
2406 : @{
2407 : */
2408 :
2409 : /** \brief Creates new #VmaVirtualBlock object.
2410 :
2411 : \param pCreateInfo Parameters for creation.
2412 : \param[out] pVirtualBlock Returned virtual block object or `VMA_NULL` if creation failed.
2413 : */
2414 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateVirtualBlock(
2415 : const VmaVirtualBlockCreateInfo* VMA_NOT_NULL pCreateInfo,
2416 : VmaVirtualBlock VMA_NULLABLE* VMA_NOT_NULL pVirtualBlock);
2417 :
2418 : /** \brief Destroys #VmaVirtualBlock object.
2419 :
2420 : Please note that you should consciously handle virtual allocations that could remain unfreed in the block.
2421 : You should either free them individually using vmaVirtualFree() or call vmaClearVirtualBlock()
2422 : if you are sure this is what you want. If you do neither, an assert is called.
2423 :
2424 : If you keep pointers to some additional metadata associated with your virtual allocations in their `pUserData`,
2425 : don't forget to free them.
2426 : */
2427 : VMA_CALL_PRE void VMA_CALL_POST vmaDestroyVirtualBlock(
2428 : VmaVirtualBlock VMA_NULLABLE virtualBlock);
2429 :
2430 : /** \brief Returns true of the #VmaVirtualBlock is empty - contains 0 virtual allocations and has all its space available for new allocations.
2431 : */
2432 : VMA_CALL_PRE VkBool32 VMA_CALL_POST vmaIsVirtualBlockEmpty(
2433 : VmaVirtualBlock VMA_NOT_NULL virtualBlock);
2434 :
2435 : /** \brief Returns information about a specific virtual allocation within a virtual block, like its size and `pUserData` pointer.
2436 : */
2437 : VMA_CALL_PRE void VMA_CALL_POST vmaGetVirtualAllocationInfo(
2438 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2439 : VmaVirtualAllocation VMA_NOT_NULL_NON_DISPATCHABLE allocation, VmaVirtualAllocationInfo* VMA_NOT_NULL pVirtualAllocInfo);
2440 :
2441 : /** \brief Allocates new virtual allocation inside given #VmaVirtualBlock.
2442 :
2443 : If the allocation fails due to not enough free space available, `VK_ERROR_OUT_OF_DEVICE_MEMORY` is returned
2444 : (despite the function doesn't ever allocate actual GPU memory).
2445 : `pAllocation` is then set to `VK_NULL_HANDLE` and `pOffset`, if not null, it set to `UINT64_MAX`.
2446 :
2447 : \param virtualBlock Virtual block
2448 : \param pCreateInfo Parameters for the allocation
2449 : \param[out] pAllocation Returned handle of the new allocation
2450 : \param[out] pOffset Returned offset of the new allocation. Optional, can be null.
2451 : */
2452 : VMA_CALL_PRE VkResult VMA_CALL_POST vmaVirtualAllocate(
2453 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2454 : const VmaVirtualAllocationCreateInfo* VMA_NOT_NULL pCreateInfo,
2455 : VmaVirtualAllocation VMA_NULLABLE_NON_DISPATCHABLE* VMA_NOT_NULL pAllocation,
2456 : VkDeviceSize* VMA_NULLABLE pOffset);
2457 :
2458 : /** \brief Frees virtual allocation inside given #VmaVirtualBlock.
2459 :
2460 : It is correct to call this function with `allocation == VK_NULL_HANDLE` - it does nothing.
2461 : */
2462 : VMA_CALL_PRE void VMA_CALL_POST vmaVirtualFree(
2463 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2464 : VmaVirtualAllocation VMA_NULLABLE_NON_DISPATCHABLE allocation);
2465 :
2466 : /** \brief Frees all virtual allocations inside given #VmaVirtualBlock.
2467 :
2468 : You must either call this function or free each virtual allocation individually with vmaVirtualFree()
2469 : before destroying a virtual block. Otherwise, an assert is called.
2470 :
2471 : If you keep pointer to some additional metadata associated with your virtual allocation in its `pUserData`,
2472 : don't forget to free it as well.
2473 : */
2474 : VMA_CALL_PRE void VMA_CALL_POST vmaClearVirtualBlock(
2475 : VmaVirtualBlock VMA_NOT_NULL virtualBlock);
2476 :
2477 : /** \brief Changes custom pointer associated with given virtual allocation.
2478 : */
2479 : VMA_CALL_PRE void VMA_CALL_POST vmaSetVirtualAllocationUserData(
2480 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2481 : VmaVirtualAllocation VMA_NOT_NULL_NON_DISPATCHABLE allocation,
2482 : void* VMA_NULLABLE pUserData);
2483 :
2484 : /** \brief Calculates and returns statistics about virtual allocations and memory usage in given #VmaVirtualBlock.
2485 :
2486 : This function is fast to call. For more detailed statistics, see vmaCalculateVirtualBlockStatistics().
2487 : */
2488 : VMA_CALL_PRE void VMA_CALL_POST vmaGetVirtualBlockStatistics(
2489 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2490 : VmaStatistics* VMA_NOT_NULL pStats);
2491 :
2492 : /** \brief Calculates and returns detailed statistics about virtual allocations and memory usage in given #VmaVirtualBlock.
2493 :
2494 : This function is slow to call. Use for debugging purposes.
2495 : For less detailed statistics, see vmaGetVirtualBlockStatistics().
2496 : */
2497 : VMA_CALL_PRE void VMA_CALL_POST vmaCalculateVirtualBlockStatistics(
2498 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2499 : VmaDetailedStatistics* VMA_NOT_NULL pStats);
2500 :
2501 : /** @} */
2502 :
2503 : #if VMA_STATS_STRING_ENABLED
2504 : /**
2505 : \addtogroup group_stats
2506 : @{
2507 : */
2508 :
2509 : /** \brief Builds and returns a null-terminated string in JSON format with information about given #VmaVirtualBlock.
2510 : \param virtualBlock Virtual block.
2511 : \param[out] ppStatsString Returned string.
2512 : \param detailedMap Pass `VK_FALSE` to only obtain statistics as returned by vmaCalculateVirtualBlockStatistics(). Pass `VK_TRUE` to also obtain full list of allocations and free spaces.
2513 :
2514 : Returned string must be freed using vmaFreeVirtualBlockStatsString().
2515 : */
2516 : VMA_CALL_PRE void VMA_CALL_POST vmaBuildVirtualBlockStatsString(
2517 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2518 : char* VMA_NULLABLE* VMA_NOT_NULL ppStatsString,
2519 : VkBool32 detailedMap);
2520 :
2521 : /// Frees a string returned by vmaBuildVirtualBlockStatsString().
2522 : VMA_CALL_PRE void VMA_CALL_POST vmaFreeVirtualBlockStatsString(
2523 : VmaVirtualBlock VMA_NOT_NULL virtualBlock,
2524 : char* VMA_NULLABLE pStatsString);
2525 :
2526 : /** \brief Builds and returns statistics as a null-terminated string in JSON format.
2527 : \param allocator
2528 : \param[out] ppStatsString Must be freed using vmaFreeStatsString() function.
2529 : \param detailedMap
2530 : */
2531 : VMA_CALL_PRE void VMA_CALL_POST vmaBuildStatsString(
2532 : VmaAllocator VMA_NOT_NULL allocator,
2533 : char* VMA_NULLABLE* VMA_NOT_NULL ppStatsString,
2534 : VkBool32 detailedMap);
2535 :
2536 : VMA_CALL_PRE void VMA_CALL_POST vmaFreeStatsString(
2537 : VmaAllocator VMA_NOT_NULL allocator,
2538 : char* VMA_NULLABLE pStatsString);
2539 :
2540 : /** @} */
2541 :
2542 : #endif // VMA_STATS_STRING_ENABLED
2543 :
2544 : #endif // _VMA_FUNCTION_HEADERS
2545 :
2546 : #ifdef __cplusplus
2547 : }
2548 : #endif
2549 :
2550 : #endif // AMD_VULKAN_MEMORY_ALLOCATOR_H
2551 :
2552 : ////////////////////////////////////////////////////////////////////////////////
2553 : ////////////////////////////////////////////////////////////////////////////////
2554 : //
2555 : // IMPLEMENTATION
2556 : //
2557 : ////////////////////////////////////////////////////////////////////////////////
2558 : ////////////////////////////////////////////////////////////////////////////////
2559 :
2560 : // For Visual Studio IntelliSense.
2561 : #if defined(__cplusplus) && defined(__INTELLISENSE__)
2562 : #define VMA_IMPLEMENTATION
2563 : #endif
2564 :
2565 : #ifdef VMA_IMPLEMENTATION
2566 : #undef VMA_IMPLEMENTATION
2567 :
2568 : #include <cstdint>
2569 : #include <cstdlib>
2570 : #include <cstring>
2571 : #include <utility>
2572 : #include <type_traits>
2573 :
2574 : #ifdef _MSC_VER
2575 : #include <intrin.h> // For functions like __popcnt, _BitScanForward etc.
2576 : #endif
2577 : #if __cplusplus >= 202002L || _MSVC_LANG >= 202002L // C++20
2578 : #include <bit> // For std::popcount
2579 : #endif
2580 :
2581 : /*******************************************************************************
2582 : CONFIGURATION SECTION
2583 :
2584 : Define some of these macros before each #include of this header or change them
2585 : here if you need other then default behavior depending on your environment.
2586 : */
2587 : #ifndef _VMA_CONFIGURATION
2588 :
2589 : /*
2590 : Define this macro to 1 to make the library fetch pointers to Vulkan functions
2591 : internally, like:
2592 :
2593 : vulkanFunctions.vkAllocateMemory = &vkAllocateMemory;
2594 : */
2595 : #if !defined(VMA_STATIC_VULKAN_FUNCTIONS) && !defined(VK_NO_PROTOTYPES)
2596 : #define VMA_STATIC_VULKAN_FUNCTIONS 1
2597 : #endif
2598 :
2599 : /*
2600 : Define this macro to 1 to make the library fetch pointers to Vulkan functions
2601 : internally, like:
2602 :
2603 : vulkanFunctions.vkAllocateMemory = (PFN_vkAllocateMemory)vkGetDeviceProcAddr(device, "vkAllocateMemory");
2604 :
2605 : To use this feature in new versions of VMA you now have to pass
2606 : VmaVulkanFunctions::vkGetInstanceProcAddr and vkGetDeviceProcAddr as
2607 : VmaAllocatorCreateInfo::pVulkanFunctions. Other members can be null.
2608 : */
2609 : #if !defined(VMA_DYNAMIC_VULKAN_FUNCTIONS)
2610 : #define VMA_DYNAMIC_VULKAN_FUNCTIONS 1
2611 : #endif
2612 :
2613 : #ifndef VMA_USE_STL_SHARED_MUTEX
2614 : // Compiler conforms to C++17.
2615 : #if __cplusplus >= 201703L
2616 : #define VMA_USE_STL_SHARED_MUTEX 1
2617 : // Visual studio defines __cplusplus properly only when passed additional parameter: /Zc:__cplusplus
2618 : // Otherwise it is always 199711L, despite shared_mutex works since Visual Studio 2015 Update 2.
2619 : #elif defined(_MSC_FULL_VER) && _MSC_FULL_VER >= 190023918 && __cplusplus == 199711L && _MSVC_LANG >= 201703L
2620 : #define VMA_USE_STL_SHARED_MUTEX 1
2621 : #else
2622 : #define VMA_USE_STL_SHARED_MUTEX 0
2623 : #endif
2624 : #endif
2625 :
2626 : /*
2627 : Define this macro to include custom header files without having to edit this file directly, e.g.:
2628 :
2629 : // Inside of "my_vma_configuration_user_includes.h":
2630 :
2631 : #include "my_custom_assert.h" // for MY_CUSTOM_ASSERT
2632 : #include "my_custom_min.h" // for my_custom_min
2633 : #include <algorithm>
2634 : #include <mutex>
2635 :
2636 : // Inside a different file, which includes "vk_mem_alloc.h":
2637 :
2638 : #define VMA_CONFIGURATION_USER_INCLUDES_H "my_vma_configuration_user_includes.h"
2639 : #define VMA_ASSERT(expr) MY_CUSTOM_ASSERT(expr)
2640 : #define VMA_MIN(v1, v2) (my_custom_min(v1, v2))
2641 : #include "vk_mem_alloc.h"
2642 : ...
2643 :
2644 : The following headers are used in this CONFIGURATION section only, so feel free to
2645 : remove them if not needed.
2646 : */
2647 : #if !defined(VMA_CONFIGURATION_USER_INCLUDES_H)
2648 : #include <cassert> // for assert
2649 : #include <algorithm> // for min, max
2650 : #include <mutex>
2651 : #else
2652 : #include VMA_CONFIGURATION_USER_INCLUDES_H
2653 : #endif
2654 :
2655 : #ifndef VMA_NULL
2656 : // Value used as null pointer. Define it to e.g.: nullptr, NULL, 0, (void*)0.
2657 : #define VMA_NULL nullptr
2658 : #endif
2659 :
2660 : #if defined(__ANDROID_API__) && (__ANDROID_API__ < 16)
2661 : #include <cstdlib>
2662 : static void* vma_aligned_alloc(size_t alignment, size_t size)
2663 : {
2664 : // alignment must be >= sizeof(void*)
2665 : if(alignment < sizeof(void*))
2666 : {
2667 : alignment = sizeof(void*);
2668 : }
2669 :
2670 : return memalign(alignment, size);
2671 : }
2672 : #elif defined(__APPLE__) || defined(__ANDROID__) || (defined(__linux__) && defined(__GLIBCXX__) && !defined(_GLIBCXX_HAVE_ALIGNED_ALLOC))
2673 : #include <cstdlib>
2674 :
2675 : #if defined(__APPLE__)
2676 : #include <AvailabilityMacros.h>
2677 : #endif
2678 :
2679 : static void* vma_aligned_alloc(size_t alignment, size_t size)
2680 : {
2681 : // Unfortunately, aligned_alloc causes VMA to crash due to it returning null pointers. (At least under 11.4)
2682 : // Therefore, for now disable this specific exception until a proper solution is found.
2683 : //#if defined(__APPLE__) && (defined(MAC_OS_X_VERSION_10_16) || defined(__IPHONE_14_0))
2684 : //#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_16 || __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_14_0
2685 : // // For C++14, usr/include/malloc/_malloc.h declares aligned_alloc()) only
2686 : // // with the MacOSX11.0 SDK in Xcode 12 (which is what adds
2687 : // // MAC_OS_X_VERSION_10_16), even though the function is marked
2688 : // // availabe for 10.15. That is why the preprocessor checks for 10.16 but
2689 : // // the __builtin_available checks for 10.15.
2690 : // // People who use C++17 could call aligned_alloc with the 10.15 SDK already.
2691 : // if (__builtin_available(macOS 10.15, iOS 13, *))
2692 : // return aligned_alloc(alignment, size);
2693 : //#endif
2694 : //#endif
2695 :
2696 : // alignment must be >= sizeof(void*)
2697 : if(alignment < sizeof(void*))
2698 : {
2699 : alignment = sizeof(void*);
2700 : }
2701 :
2702 : void *pointer;
2703 : if(posix_memalign(&pointer, alignment, size) == 0)
2704 : return pointer;
2705 : return VMA_NULL;
2706 : }
2707 : #elif defined(_WIN32)
2708 : static void* vma_aligned_alloc(size_t alignment, size_t size)
2709 : {
2710 : return _aligned_malloc(size, alignment);
2711 : }
2712 : #else
2713 0 : static void* vma_aligned_alloc(size_t alignment, size_t size)
2714 : {
2715 0 : return aligned_alloc(alignment, size);
2716 : }
2717 : #endif
2718 :
2719 : #if defined(_WIN32)
2720 : static void vma_aligned_free(void* ptr)
2721 : {
2722 : _aligned_free(ptr);
2723 : }
2724 : #else
2725 0 : static void vma_aligned_free(void* VMA_NULLABLE ptr)
2726 : {
2727 0 : free(ptr);
2728 0 : }
2729 : #endif
2730 :
2731 : // If your compiler is not compatible with C++11 and definition of
2732 : // aligned_alloc() function is missing, uncommeting following line may help:
2733 :
2734 : //#include <malloc.h>
2735 :
2736 : // Normal assert to check for programmer's errors, especially in Debug configuration.
2737 : #ifndef VMA_ASSERT
2738 : #ifdef NDEBUG
2739 : #define VMA_ASSERT(expr)
2740 : #else
2741 : #define VMA_ASSERT(expr) assert(expr)
2742 : #endif
2743 : #endif
2744 :
2745 : // Assert that will be called very often, like inside data structures e.g. operator[].
2746 : // Making it non-empty can make program slow.
2747 : #ifndef VMA_HEAVY_ASSERT
2748 : #ifdef NDEBUG
2749 : #define VMA_HEAVY_ASSERT(expr)
2750 : #else
2751 : #define VMA_HEAVY_ASSERT(expr) //VMA_ASSERT(expr)
2752 : #endif
2753 : #endif
2754 :
2755 : #ifndef VMA_ALIGN_OF
2756 : #define VMA_ALIGN_OF(type) (__alignof(type))
2757 : #endif
2758 :
2759 : #ifndef VMA_SYSTEM_ALIGNED_MALLOC
2760 : #define VMA_SYSTEM_ALIGNED_MALLOC(size, alignment) vma_aligned_alloc((alignment), (size))
2761 : #endif
2762 :
2763 : #ifndef VMA_SYSTEM_ALIGNED_FREE
2764 : // VMA_SYSTEM_FREE is the old name, but might have been defined by the user
2765 : #if defined(VMA_SYSTEM_FREE)
2766 : #define VMA_SYSTEM_ALIGNED_FREE(ptr) VMA_SYSTEM_FREE(ptr)
2767 : #else
2768 : #define VMA_SYSTEM_ALIGNED_FREE(ptr) vma_aligned_free(ptr)
2769 : #endif
2770 : #endif
2771 :
2772 : #ifndef VMA_COUNT_BITS_SET
2773 : // Returns number of bits set to 1 in (v)
2774 : #define VMA_COUNT_BITS_SET(v) VmaCountBitsSet(v)
2775 : #endif
2776 :
2777 : #ifndef VMA_BITSCAN_LSB
2778 : // Scans integer for index of first nonzero value from the Least Significant Bit (LSB). If mask is 0 then returns UINT8_MAX
2779 : #define VMA_BITSCAN_LSB(mask) VmaBitScanLSB(mask)
2780 : #endif
2781 :
2782 : #ifndef VMA_BITSCAN_MSB
2783 : // Scans integer for index of first nonzero value from the Most Significant Bit (MSB). If mask is 0 then returns UINT8_MAX
2784 : #define VMA_BITSCAN_MSB(mask) VmaBitScanMSB(mask)
2785 : #endif
2786 :
2787 : #ifndef VMA_MIN
2788 : #define VMA_MIN(v1, v2) ((std::min)((v1), (v2)))
2789 : #endif
2790 :
2791 : #ifndef VMA_MAX
2792 : #define VMA_MAX(v1, v2) ((std::max)((v1), (v2)))
2793 : #endif
2794 :
2795 : #ifndef VMA_SWAP
2796 : #define VMA_SWAP(v1, v2) std::swap((v1), (v2))
2797 : #endif
2798 :
2799 : #ifndef VMA_SORT
2800 : #define VMA_SORT(beg, end, cmp) std::sort(beg, end, cmp)
2801 : #endif
2802 :
2803 : #ifndef VMA_DEBUG_LOG
2804 : #define VMA_DEBUG_LOG(format, ...)
2805 : /*
2806 : #define VMA_DEBUG_LOG(format, ...) do { \
2807 : printf(format, __VA_ARGS__); \
2808 : printf("\n"); \
2809 : } while(false)
2810 : */
2811 : #endif
2812 :
2813 : // Define this macro to 1 to enable functions: vmaBuildStatsString, vmaFreeStatsString.
2814 : #if VMA_STATS_STRING_ENABLED
2815 : static inline void VmaUint32ToStr(char* VMA_NOT_NULL outStr, size_t strLen, uint32_t num)
2816 : {
2817 : snprintf(outStr, strLen, "%u", static_cast<unsigned int>(num));
2818 : }
2819 : static inline void VmaUint64ToStr(char* VMA_NOT_NULL outStr, size_t strLen, uint64_t num)
2820 : {
2821 : snprintf(outStr, strLen, "%llu", static_cast<unsigned long long>(num));
2822 : }
2823 0 : static inline void VmaPtrToStr(char* VMA_NOT_NULL outStr, size_t strLen, const void* ptr)
2824 : {
2825 0 : snprintf(outStr, strLen, "%p", ptr);
2826 0 : }
2827 : #endif
2828 :
2829 : #ifndef VMA_MUTEX
2830 0 : class VmaMutex
2831 : {
2832 : public:
2833 0 : void Lock() { m_Mutex.lock(); }
2834 0 : void Unlock() { m_Mutex.unlock(); }
2835 : bool TryLock() { return m_Mutex.try_lock(); }
2836 : private:
2837 : std::mutex m_Mutex;
2838 : };
2839 : #define VMA_MUTEX VmaMutex
2840 : #endif
2841 :
2842 : // Read-write mutex, where "read" is shared access, "write" is exclusive access.
2843 : #ifndef VMA_RW_MUTEX
2844 : #if VMA_USE_STL_SHARED_MUTEX
2845 : // Use std::shared_mutex from C++17.
2846 : #include <shared_mutex>
2847 0 : class VmaRWMutex
2848 : {
2849 : public:
2850 0 : void LockRead() { m_Mutex.lock_shared(); }
2851 0 : void UnlockRead() { m_Mutex.unlock_shared(); }
2852 : bool TryLockRead() { return m_Mutex.try_lock_shared(); }
2853 0 : void LockWrite() { m_Mutex.lock(); }
2854 0 : void UnlockWrite() { m_Mutex.unlock(); }
2855 : bool TryLockWrite() { return m_Mutex.try_lock(); }
2856 : private:
2857 : std::shared_mutex m_Mutex;
2858 : };
2859 : #define VMA_RW_MUTEX VmaRWMutex
2860 : #elif defined(_WIN32) && defined(WINVER) && WINVER >= 0x0600
2861 : // Use SRWLOCK from WinAPI.
2862 : // Minimum supported client = Windows Vista, server = Windows Server 2008.
2863 : class VmaRWMutex
2864 : {
2865 : public:
2866 : VmaRWMutex() { InitializeSRWLock(&m_Lock); }
2867 : void LockRead() { AcquireSRWLockShared(&m_Lock); }
2868 : void UnlockRead() { ReleaseSRWLockShared(&m_Lock); }
2869 : bool TryLockRead() { return TryAcquireSRWLockShared(&m_Lock) != FALSE; }
2870 : void LockWrite() { AcquireSRWLockExclusive(&m_Lock); }
2871 : void UnlockWrite() { ReleaseSRWLockExclusive(&m_Lock); }
2872 : bool TryLockWrite() { return TryAcquireSRWLockExclusive(&m_Lock) != FALSE; }
2873 : private:
2874 : SRWLOCK m_Lock;
2875 : };
2876 : #define VMA_RW_MUTEX VmaRWMutex
2877 : #else
2878 : // Less efficient fallback: Use normal mutex.
2879 : class VmaRWMutex
2880 : {
2881 : public:
2882 : void LockRead() { m_Mutex.Lock(); }
2883 : void UnlockRead() { m_Mutex.Unlock(); }
2884 : bool TryLockRead() { return m_Mutex.TryLock(); }
2885 : void LockWrite() { m_Mutex.Lock(); }
2886 : void UnlockWrite() { m_Mutex.Unlock(); }
2887 : bool TryLockWrite() { return m_Mutex.TryLock(); }
2888 : private:
2889 : VMA_MUTEX m_Mutex;
2890 : };
2891 : #define VMA_RW_MUTEX VmaRWMutex
2892 : #endif // #if VMA_USE_STL_SHARED_MUTEX
2893 : #endif // #ifndef VMA_RW_MUTEX
2894 :
2895 : /*
2896 : If providing your own implementation, you need to implement a subset of std::atomic.
2897 : */
2898 : #ifndef VMA_ATOMIC_UINT32
2899 : #include <atomic>
2900 : #define VMA_ATOMIC_UINT32 std::atomic<uint32_t>
2901 : #endif
2902 :
2903 : #ifndef VMA_ATOMIC_UINT64
2904 : #include <atomic>
2905 : #define VMA_ATOMIC_UINT64 std::atomic<uint64_t>
2906 : #endif
2907 :
2908 : #ifndef VMA_DEBUG_ALWAYS_DEDICATED_MEMORY
2909 : /**
2910 : Every allocation will have its own memory block.
2911 : Define to 1 for debugging purposes only.
2912 : */
2913 : #define VMA_DEBUG_ALWAYS_DEDICATED_MEMORY (0)
2914 : #endif
2915 :
2916 : #ifndef VMA_MIN_ALIGNMENT
2917 : /**
2918 : Minimum alignment of all allocations, in bytes.
2919 : Set to more than 1 for debugging purposes. Must be power of two.
2920 : */
2921 : #ifdef VMA_DEBUG_ALIGNMENT // Old name
2922 : #define VMA_MIN_ALIGNMENT VMA_DEBUG_ALIGNMENT
2923 : #else
2924 : #define VMA_MIN_ALIGNMENT (1)
2925 : #endif
2926 : #endif
2927 :
2928 : #ifndef VMA_DEBUG_MARGIN
2929 : /**
2930 : Minimum margin after every allocation, in bytes.
2931 : Set nonzero for debugging purposes only.
2932 : */
2933 : #define VMA_DEBUG_MARGIN (0)
2934 : #endif
2935 :
2936 : #ifndef VMA_DEBUG_INITIALIZE_ALLOCATIONS
2937 : /**
2938 : Define this macro to 1 to automatically fill new allocations and destroyed
2939 : allocations with some bit pattern.
2940 : */
2941 : #define VMA_DEBUG_INITIALIZE_ALLOCATIONS (0)
2942 : #endif
2943 :
2944 : #ifndef VMA_DEBUG_DETECT_CORRUPTION
2945 : /**
2946 : Define this macro to 1 together with non-zero value of VMA_DEBUG_MARGIN to
2947 : enable writing magic value to the margin after every allocation and
2948 : validating it, so that memory corruptions (out-of-bounds writes) are detected.
2949 : */
2950 : #define VMA_DEBUG_DETECT_CORRUPTION (0)
2951 : #endif
2952 :
2953 : #ifndef VMA_DEBUG_GLOBAL_MUTEX
2954 : /**
2955 : Set this to 1 for debugging purposes only, to enable single mutex protecting all
2956 : entry calls to the library. Can be useful for debugging multithreading issues.
2957 : */
2958 : #define VMA_DEBUG_GLOBAL_MUTEX (0)
2959 : #endif
2960 :
2961 : #ifndef VMA_DEBUG_MIN_BUFFER_IMAGE_GRANULARITY
2962 : /**
2963 : Minimum value for VkPhysicalDeviceLimits::bufferImageGranularity.
2964 : Set to more than 1 for debugging purposes only. Must be power of two.
2965 : */
2966 : #define VMA_DEBUG_MIN_BUFFER_IMAGE_GRANULARITY (1)
2967 : #endif
2968 :
2969 : #ifndef VMA_DEBUG_DONT_EXCEED_MAX_MEMORY_ALLOCATION_COUNT
2970 : /*
2971 : Set this to 1 to make VMA never exceed VkPhysicalDeviceLimits::maxMemoryAllocationCount
2972 : and return error instead of leaving up to Vulkan implementation what to do in such cases.
2973 : */
2974 : #define VMA_DEBUG_DONT_EXCEED_MAX_MEMORY_ALLOCATION_COUNT (0)
2975 : #endif
2976 :
2977 : #ifndef VMA_SMALL_HEAP_MAX_SIZE
2978 : /// Maximum size of a memory heap in Vulkan to consider it "small".
2979 : #define VMA_SMALL_HEAP_MAX_SIZE (1024ull * 1024 * 1024)
2980 : #endif
2981 :
2982 : #ifndef VMA_DEFAULT_LARGE_HEAP_BLOCK_SIZE
2983 : /// Default size of a block allocated as single VkDeviceMemory from a "large" heap.
2984 : #define VMA_DEFAULT_LARGE_HEAP_BLOCK_SIZE (256ull * 1024 * 1024)
2985 : #endif
2986 :
2987 : /*
2988 : Mapping hysteresis is a logic that launches when vmaMapMemory/vmaUnmapMemory is called
2989 : or a persistently mapped allocation is created and destroyed several times in a row.
2990 : It keeps additional +1 mapping of a device memory block to prevent calling actual
2991 : vkMapMemory/vkUnmapMemory too many times, which may improve performance and help
2992 : tools like RenderDOc.
2993 : */
2994 : #ifndef VMA_MAPPING_HYSTERESIS_ENABLED
2995 : #define VMA_MAPPING_HYSTERESIS_ENABLED 1
2996 : #endif
2997 :
2998 : #ifndef VMA_CLASS_NO_COPY
2999 : #define VMA_CLASS_NO_COPY(className) \
3000 : private: \
3001 : className(const className&) = delete; \
3002 : className& operator=(const className&) = delete;
3003 : #endif
3004 :
3005 : #define VMA_VALIDATE(cond) do { if(!(cond)) { \
3006 : VMA_ASSERT(0 && "Validation failed: " #cond); \
3007 : return false; \
3008 : } } while(false)
3009 :
3010 : /*******************************************************************************
3011 : END OF CONFIGURATION
3012 : */
3013 : #endif // _VMA_CONFIGURATION
3014 :
3015 :
3016 : static const uint8_t VMA_ALLOCATION_FILL_PATTERN_CREATED = 0xDC;
3017 : static const uint8_t VMA_ALLOCATION_FILL_PATTERN_DESTROYED = 0xEF;
3018 : // Decimal 2139416166, float NaN, little-endian binary 66 E6 84 7F.
3019 : static const uint32_t VMA_CORRUPTION_DETECTION_MAGIC_VALUE = 0x7F84E666;
3020 :
3021 : // Copy of some Vulkan definitions so we don't need to check their existence just to handle few constants.
3022 : static const uint32_t VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD_COPY = 0x00000040;
3023 : static const uint32_t VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD_COPY = 0x00000080;
3024 : static const uint32_t VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_COPY = 0x00020000;
3025 : static const uint32_t VK_IMAGE_CREATE_DISJOINT_BIT_COPY = 0x00000200;
3026 : static const int32_t VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT_COPY = 1000158000;
3027 : static const uint32_t VMA_ALLOCATION_INTERNAL_STRATEGY_MIN_OFFSET = 0x10000000u;
3028 : static const uint32_t VMA_ALLOCATION_TRY_COUNT = 32;
3029 : static const uint32_t VMA_VENDOR_ID_AMD = 4098;
3030 :
3031 : // This one is tricky. Vulkan specification defines this code as available since
3032 : // Vulkan 1.0, but doesn't actually define it in Vulkan SDK earlier than 1.2.131.
3033 : // See pull request #207.
3034 : #define VK_ERROR_UNKNOWN_COPY ((VkResult)-13)
3035 :
3036 :
3037 : #if VMA_STATS_STRING_ENABLED
3038 : // Correspond to values of enum VmaSuballocationType.
3039 : static const char* VMA_SUBALLOCATION_TYPE_NAMES[] =
3040 : {
3041 : "FREE",
3042 : "UNKNOWN",
3043 : "BUFFER",
3044 : "IMAGE_UNKNOWN",
3045 : "IMAGE_LINEAR",
3046 : "IMAGE_OPTIMAL",
3047 : };
3048 : #endif
3049 :
3050 : static VkAllocationCallbacks VmaEmptyAllocationCallbacks =
3051 : { VMA_NULL, VMA_NULL, VMA_NULL, VMA_NULL, VMA_NULL, VMA_NULL };
3052 :
3053 :
3054 : #ifndef _VMA_ENUM_DECLARATIONS
3055 :
3056 : enum VmaSuballocationType
3057 : {
3058 : VMA_SUBALLOCATION_TYPE_FREE = 0,
3059 : VMA_SUBALLOCATION_TYPE_UNKNOWN = 1,
3060 : VMA_SUBALLOCATION_TYPE_BUFFER = 2,
3061 : VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN = 3,
3062 : VMA_SUBALLOCATION_TYPE_IMAGE_LINEAR = 4,
3063 : VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL = 5,
3064 : VMA_SUBALLOCATION_TYPE_MAX_ENUM = 0x7FFFFFFF
3065 : };
3066 :
3067 : enum VMA_CACHE_OPERATION
3068 : {
3069 : VMA_CACHE_FLUSH,
3070 : VMA_CACHE_INVALIDATE
3071 : };
3072 :
3073 : enum class VmaAllocationRequestType
3074 : {
3075 : Normal,
3076 : TLSF,
3077 : // Used by "Linear" algorithm.
3078 : UpperAddress,
3079 : EndOf1st,
3080 : EndOf2nd,
3081 : };
3082 :
3083 : #endif // _VMA_ENUM_DECLARATIONS
3084 :
3085 : #ifndef _VMA_FORWARD_DECLARATIONS
3086 : // Opaque handle used by allocation algorithms to identify single allocation in any conforming way.
3087 : VK_DEFINE_NON_DISPATCHABLE_HANDLE(VmaAllocHandle);
3088 :
3089 : struct VmaMutexLock;
3090 : struct VmaMutexLockRead;
3091 : struct VmaMutexLockWrite;
3092 :
3093 : template<typename T>
3094 : struct AtomicTransactionalIncrement;
3095 :
3096 : template<typename T>
3097 : struct VmaStlAllocator;
3098 :
3099 : template<typename T, typename AllocatorT>
3100 : class VmaVector;
3101 :
3102 : template<typename T, typename AllocatorT, size_t N>
3103 : class VmaSmallVector;
3104 :
3105 : template<typename T>
3106 : class VmaPoolAllocator;
3107 :
3108 : template<typename T>
3109 : struct VmaListItem;
3110 :
3111 : template<typename T>
3112 : class VmaRawList;
3113 :
3114 : template<typename T, typename AllocatorT>
3115 : class VmaList;
3116 :
3117 : template<typename ItemTypeTraits>
3118 : class VmaIntrusiveLinkedList;
3119 :
3120 : // Unused in this version
3121 : #if 0
3122 : template<typename T1, typename T2>
3123 : struct VmaPair;
3124 : template<typename FirstT, typename SecondT>
3125 : struct VmaPairFirstLess;
3126 :
3127 : template<typename KeyT, typename ValueT>
3128 : class VmaMap;
3129 : #endif
3130 :
3131 : #if VMA_STATS_STRING_ENABLED
3132 : class VmaStringBuilder;
3133 : class VmaJsonWriter;
3134 : #endif
3135 :
3136 : class VmaDeviceMemoryBlock;
3137 :
3138 : struct VmaDedicatedAllocationListItemTraits;
3139 : class VmaDedicatedAllocationList;
3140 :
3141 : struct VmaSuballocation;
3142 : struct VmaSuballocationOffsetLess;
3143 : struct VmaSuballocationOffsetGreater;
3144 : struct VmaSuballocationItemSizeLess;
3145 :
3146 : typedef VmaList<VmaSuballocation, VmaStlAllocator<VmaSuballocation>> VmaSuballocationList;
3147 :
3148 : struct VmaAllocationRequest;
3149 :
3150 : class VmaBlockMetadata;
3151 : class VmaBlockMetadata_Linear;
3152 : class VmaBlockMetadata_TLSF;
3153 :
3154 : class VmaBlockVector;
3155 :
3156 : struct VmaPoolListItemTraits;
3157 :
3158 : struct VmaCurrentBudgetData;
3159 :
3160 : class VmaAllocationObjectAllocator;
3161 :
3162 : #endif // _VMA_FORWARD_DECLARATIONS
3163 :
3164 :
3165 : #ifndef _VMA_FUNCTIONS
3166 :
3167 : /*
3168 : Returns number of bits set to 1 in (v).
3169 :
3170 : On specific platforms and compilers you can use instrinsics like:
3171 :
3172 : Visual Studio:
3173 : return __popcnt(v);
3174 : GCC, Clang:
3175 : return static_cast<uint32_t>(__builtin_popcount(v));
3176 :
3177 : Define macro VMA_COUNT_BITS_SET to provide your optimized implementation.
3178 : But you need to check in runtime whether user's CPU supports these, as some old processors don't.
3179 : */
3180 0 : static inline uint32_t VmaCountBitsSet(uint32_t v)
3181 : {
3182 : #if __cplusplus >= 202002L || _MSVC_LANG >= 202002L // C++20
3183 : return std::popcount(v);
3184 : #else
3185 0 : uint32_t c = v - ((v >> 1) & 0x55555555);
3186 0 : c = ((c >> 2) & 0x33333333) + (c & 0x33333333);
3187 0 : c = ((c >> 4) + c) & 0x0F0F0F0F;
3188 0 : c = ((c >> 8) + c) & 0x00FF00FF;
3189 0 : c = ((c >> 16) + c) & 0x0000FFFF;
3190 0 : return c;
3191 : #endif
3192 : }
3193 :
3194 : static inline uint8_t VmaBitScanLSB(uint64_t mask)
3195 : {
3196 : #if defined(_MSC_VER) && defined(_WIN64)
3197 : unsigned long pos;
3198 : if (_BitScanForward64(&pos, mask))
3199 : return static_cast<uint8_t>(pos);
3200 : return UINT8_MAX;
3201 : #elif defined __GNUC__ || defined __clang__
3202 : return static_cast<uint8_t>(__builtin_ffsll(mask)) - 1U;
3203 : #else
3204 : uint8_t pos = 0;
3205 : uint64_t bit = 1;
3206 : do
3207 : {
3208 : if (mask & bit)
3209 : return pos;
3210 : bit <<= 1;
3211 : } while (pos++ < 63);
3212 : return UINT8_MAX;
3213 : #endif
3214 : }
3215 :
3216 0 : static inline uint8_t VmaBitScanLSB(uint32_t mask)
3217 : {
3218 : #ifdef _MSC_VER
3219 : unsigned long pos;
3220 : if (_BitScanForward(&pos, mask))
3221 : return static_cast<uint8_t>(pos);
3222 : return UINT8_MAX;
3223 : #elif defined __GNUC__ || defined __clang__
3224 0 : return static_cast<uint8_t>(__builtin_ffs(mask)) - 1U;
3225 : #else
3226 : uint8_t pos = 0;
3227 : uint32_t bit = 1;
3228 : do
3229 : {
3230 : if (mask & bit)
3231 : return pos;
3232 : bit <<= 1;
3233 : } while (pos++ < 31);
3234 : return UINT8_MAX;
3235 : #endif
3236 : }
3237 :
3238 0 : static inline uint8_t VmaBitScanMSB(uint64_t mask)
3239 : {
3240 : #if defined(_MSC_VER) && defined(_WIN64)
3241 : unsigned long pos;
3242 : if (_BitScanReverse64(&pos, mask))
3243 : return static_cast<uint8_t>(pos);
3244 : #elif defined __GNUC__ || defined __clang__
3245 0 : if (mask)
3246 0 : return 63 - static_cast<uint8_t>(__builtin_clzll(mask));
3247 : #else
3248 : uint8_t pos = 63;
3249 : uint64_t bit = 1ULL << 63;
3250 : do
3251 : {
3252 : if (mask & bit)
3253 : return pos;
3254 : bit >>= 1;
3255 : } while (pos-- > 0);
3256 : #endif
3257 0 : return UINT8_MAX;
3258 : }
3259 :
3260 : static inline uint8_t VmaBitScanMSB(uint32_t mask)
3261 : {
3262 : #ifdef _MSC_VER
3263 : unsigned long pos;
3264 : if (_BitScanReverse(&pos, mask))
3265 : return static_cast<uint8_t>(pos);
3266 : #elif defined __GNUC__ || defined __clang__
3267 : if (mask)
3268 : return 31 - static_cast<uint8_t>(__builtin_clz(mask));
3269 : #else
3270 : uint8_t pos = 31;
3271 : uint32_t bit = 1UL << 31;
3272 : do
3273 : {
3274 : if (mask & bit)
3275 : return pos;
3276 : bit >>= 1;
3277 : } while (pos-- > 0);
3278 : #endif
3279 : return UINT8_MAX;
3280 : }
3281 :
3282 : /*
3283 : Returns true if given number is a power of two.
3284 : T must be unsigned integer number or signed integer but always nonnegative.
3285 : For 0 returns true.
3286 : */
3287 : template <typename T>
3288 0 : inline bool VmaIsPow2(T x)
3289 : {
3290 0 : return (x & (x - 1)) == 0;
3291 : }
3292 :
3293 : // Aligns given value up to nearest multiply of align value. For example: VmaAlignUp(11, 8) = 16.
3294 : // Use types like uint32_t, uint64_t as T.
3295 : template <typename T>
3296 0 : static inline T VmaAlignUp(T val, T alignment)
3297 : {
3298 0 : VMA_HEAVY_ASSERT(VmaIsPow2(alignment));
3299 0 : return (val + alignment - 1) & ~(alignment - 1);
3300 : }
3301 :
3302 : // Aligns given value down to nearest multiply of align value. For example: VmaAlignUp(11, 8) = 8.
3303 : // Use types like uint32_t, uint64_t as T.
3304 : template <typename T>
3305 0 : static inline T VmaAlignDown(T val, T alignment)
3306 : {
3307 0 : VMA_HEAVY_ASSERT(VmaIsPow2(alignment));
3308 0 : return val & ~(alignment - 1);
3309 : }
3310 :
3311 : // Division with mathematical rounding to nearest number.
3312 : template <typename T>
3313 : static inline T VmaRoundDiv(T x, T y)
3314 : {
3315 : return (x + (y / (T)2)) / y;
3316 : }
3317 :
3318 : // Divide by 'y' and round up to nearest integer.
3319 : template <typename T>
3320 0 : static inline T VmaDivideRoundingUp(T x, T y)
3321 : {
3322 0 : return (x + y - (T)1) / y;
3323 : }
3324 :
3325 : // Returns smallest power of 2 greater or equal to v.
3326 : static inline uint32_t VmaNextPow2(uint32_t v)
3327 : {
3328 : v--;
3329 : v |= v >> 1;
3330 : v |= v >> 2;
3331 : v |= v >> 4;
3332 : v |= v >> 8;
3333 : v |= v >> 16;
3334 : v++;
3335 : return v;
3336 : }
3337 :
3338 : static inline uint64_t VmaNextPow2(uint64_t v)
3339 : {
3340 : v--;
3341 : v |= v >> 1;
3342 : v |= v >> 2;
3343 : v |= v >> 4;
3344 : v |= v >> 8;
3345 : v |= v >> 16;
3346 : v |= v >> 32;
3347 : v++;
3348 : return v;
3349 : }
3350 :
3351 : // Returns largest power of 2 less or equal to v.
3352 : static inline uint32_t VmaPrevPow2(uint32_t v)
3353 : {
3354 : v |= v >> 1;
3355 : v |= v >> 2;
3356 : v |= v >> 4;
3357 : v |= v >> 8;
3358 : v |= v >> 16;
3359 : v = v ^ (v >> 1);
3360 : return v;
3361 : }
3362 :
3363 : static inline uint64_t VmaPrevPow2(uint64_t v)
3364 : {
3365 : v |= v >> 1;
3366 : v |= v >> 2;
3367 : v |= v >> 4;
3368 : v |= v >> 8;
3369 : v |= v >> 16;
3370 : v |= v >> 32;
3371 : v = v ^ (v >> 1);
3372 : return v;
3373 : }
3374 :
3375 : static inline bool VmaStrIsEmpty(const char* pStr)
3376 : {
3377 : return pStr == VMA_NULL || *pStr == '\0';
3378 : }
3379 :
3380 : /*
3381 : Returns true if two memory blocks occupy overlapping pages.
3382 : ResourceA must be in less memory offset than ResourceB.
3383 :
3384 : Algorithm is based on "Vulkan 1.0.39 - A Specification (with all registered Vulkan extensions)"
3385 : chapter 11.6 "Resource Memory Association", paragraph "Buffer-Image Granularity".
3386 : */
3387 0 : static inline bool VmaBlocksOnSamePage(
3388 : VkDeviceSize resourceAOffset,
3389 : VkDeviceSize resourceASize,
3390 : VkDeviceSize resourceBOffset,
3391 : VkDeviceSize pageSize)
3392 : {
3393 0 : VMA_ASSERT(resourceAOffset + resourceASize <= resourceBOffset && resourceASize > 0 && pageSize > 0);
3394 0 : VkDeviceSize resourceAEnd = resourceAOffset + resourceASize - 1;
3395 0 : VkDeviceSize resourceAEndPage = resourceAEnd & ~(pageSize - 1);
3396 0 : VkDeviceSize resourceBStart = resourceBOffset;
3397 0 : VkDeviceSize resourceBStartPage = resourceBStart & ~(pageSize - 1);
3398 0 : return resourceAEndPage == resourceBStartPage;
3399 : }
3400 :
3401 : /*
3402 : Returns true if given suballocation types could conflict and must respect
3403 : VkPhysicalDeviceLimits::bufferImageGranularity. They conflict if one is buffer
3404 : or linear image and another one is optimal image. If type is unknown, behave
3405 : conservatively.
3406 : */
3407 0 : static inline bool VmaIsBufferImageGranularityConflict(
3408 : VmaSuballocationType suballocType1,
3409 : VmaSuballocationType suballocType2)
3410 : {
3411 0 : if (suballocType1 > suballocType2)
3412 : {
3413 0 : VMA_SWAP(suballocType1, suballocType2);
3414 : }
3415 :
3416 0 : switch (suballocType1)
3417 : {
3418 0 : case VMA_SUBALLOCATION_TYPE_FREE:
3419 0 : return false;
3420 0 : case VMA_SUBALLOCATION_TYPE_UNKNOWN:
3421 0 : return true;
3422 0 : case VMA_SUBALLOCATION_TYPE_BUFFER:
3423 : return
3424 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN ||
3425 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL;
3426 0 : case VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN:
3427 : return
3428 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN ||
3429 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_LINEAR ||
3430 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL;
3431 0 : case VMA_SUBALLOCATION_TYPE_IMAGE_LINEAR:
3432 : return
3433 0 : suballocType2 == VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL;
3434 0 : case VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL:
3435 0 : return false;
3436 0 : default:
3437 0 : VMA_ASSERT(0);
3438 0 : return true;
3439 : }
3440 : }
3441 :
3442 0 : static void VmaWriteMagicValue(void* pData, VkDeviceSize offset)
3443 : {
3444 : #if VMA_DEBUG_MARGIN > 0 && VMA_DEBUG_DETECT_CORRUPTION
3445 : uint32_t* pDst = (uint32_t*)((char*)pData + offset);
3446 : const size_t numberCount = VMA_DEBUG_MARGIN / sizeof(uint32_t);
3447 : for (size_t i = 0; i < numberCount; ++i, ++pDst)
3448 : {
3449 : *pDst = VMA_CORRUPTION_DETECTION_MAGIC_VALUE;
3450 : }
3451 : #else
3452 : // no-op
3453 : #endif
3454 0 : }
3455 :
3456 0 : static bool VmaValidateMagicValue(const void* pData, VkDeviceSize offset)
3457 : {
3458 : #if VMA_DEBUG_MARGIN > 0 && VMA_DEBUG_DETECT_CORRUPTION
3459 : const uint32_t* pSrc = (const uint32_t*)((const char*)pData + offset);
3460 : const size_t numberCount = VMA_DEBUG_MARGIN / sizeof(uint32_t);
3461 : for (size_t i = 0; i < numberCount; ++i, ++pSrc)
3462 : {
3463 : if (*pSrc != VMA_CORRUPTION_DETECTION_MAGIC_VALUE)
3464 : {
3465 : return false;
3466 : }
3467 : }
3468 : #endif
3469 0 : return true;
3470 : }
3471 :
3472 : /*
3473 : Fills structure with parameters of an example buffer to be used for transfers
3474 : during GPU memory defragmentation.
3475 : */
3476 0 : static void VmaFillGpuDefragmentationBufferCreateInfo(VkBufferCreateInfo& outBufCreateInfo)
3477 : {
3478 0 : memset(&outBufCreateInfo, 0, sizeof(outBufCreateInfo));
3479 0 : outBufCreateInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
3480 0 : outBufCreateInfo.usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT;
3481 0 : outBufCreateInfo.size = (VkDeviceSize)VMA_DEFAULT_LARGE_HEAP_BLOCK_SIZE; // Example size.
3482 0 : }
3483 :
3484 :
3485 : /*
3486 : Performs binary search and returns iterator to first element that is greater or
3487 : equal to (key), according to comparison (cmp).
3488 :
3489 : Cmp should return true if first argument is less than second argument.
3490 :
3491 : Returned value is the found element, if present in the collection or place where
3492 : new element with value (key) should be inserted.
3493 : */
3494 : template <typename CmpLess, typename IterT, typename KeyT>
3495 0 : static IterT VmaBinaryFindFirstNotLess(IterT beg, IterT end, const KeyT& key, const CmpLess& cmp)
3496 : {
3497 0 : size_t down = 0, up = (end - beg);
3498 0 : while (down < up)
3499 : {
3500 0 : const size_t mid = down + (up - down) / 2; // Overflow-safe midpoint calculation
3501 0 : if (cmp(*(beg + mid), key))
3502 : {
3503 0 : down = mid + 1;
3504 : }
3505 : else
3506 : {
3507 0 : up = mid;
3508 : }
3509 : }
3510 0 : return beg + down;
3511 : }
3512 :
3513 : template<typename CmpLess, typename IterT, typename KeyT>
3514 0 : IterT VmaBinaryFindSorted(const IterT& beg, const IterT& end, const KeyT& value, const CmpLess& cmp)
3515 : {
3516 0 : IterT it = VmaBinaryFindFirstNotLess<CmpLess, IterT, KeyT>(
3517 : beg, end, value, cmp);
3518 0 : if (it == end ||
3519 0 : (!cmp(*it, value) && !cmp(value, *it)))
3520 : {
3521 0 : return it;
3522 : }
3523 0 : return end;
3524 : }
3525 :
3526 : /*
3527 : Returns true if all pointers in the array are not-null and unique.
3528 : Warning! O(n^2) complexity. Use only inside VMA_HEAVY_ASSERT.
3529 : T must be pointer type, e.g. VmaAllocation, VmaPool.
3530 : */
3531 : template<typename T>
3532 : static bool VmaValidatePointerArray(uint32_t count, const T* arr)
3533 : {
3534 : for (uint32_t i = 0; i < count; ++i)
3535 : {
3536 : const T iPtr = arr[i];
3537 : if (iPtr == VMA_NULL)
3538 : {
3539 : return false;
3540 : }
3541 : for (uint32_t j = i + 1; j < count; ++j)
3542 : {
3543 : if (iPtr == arr[j])
3544 : {
3545 : return false;
3546 : }
3547 : }
3548 : }
3549 : return true;
3550 : }
3551 :
3552 : template<typename MainT, typename NewT>
3553 : static inline void VmaPnextChainPushFront(MainT* mainStruct, NewT* newStruct)
3554 : {
3555 : newStruct->pNext = mainStruct->pNext;
3556 : mainStruct->pNext = newStruct;
3557 : }
3558 :
3559 : // This is the main algorithm that guides the selection of a memory type best for an allocation -
3560 : // converts usage to required/preferred/not preferred flags.
3561 0 : static bool FindMemoryPreferences(
3562 : bool isIntegratedGPU,
3563 : const VmaAllocationCreateInfo& allocCreateInfo,
3564 : VkFlags bufImgUsage, // VkBufferCreateInfo::usage or VkImageCreateInfo::usage. UINT32_MAX if unknown.
3565 : VkMemoryPropertyFlags& outRequiredFlags,
3566 : VkMemoryPropertyFlags& outPreferredFlags,
3567 : VkMemoryPropertyFlags& outNotPreferredFlags)
3568 : {
3569 0 : outRequiredFlags = allocCreateInfo.requiredFlags;
3570 0 : outPreferredFlags = allocCreateInfo.preferredFlags;
3571 0 : outNotPreferredFlags = 0;
3572 :
3573 0 : switch(allocCreateInfo.usage)
3574 : {
3575 0 : case VMA_MEMORY_USAGE_UNKNOWN:
3576 0 : break;
3577 0 : case VMA_MEMORY_USAGE_GPU_ONLY:
3578 0 : if(!isIntegratedGPU || (outPreferredFlags & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT) == 0)
3579 : {
3580 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3581 : }
3582 0 : break;
3583 0 : case VMA_MEMORY_USAGE_CPU_ONLY:
3584 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT;
3585 0 : break;
3586 0 : case VMA_MEMORY_USAGE_CPU_TO_GPU:
3587 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
3588 0 : if(!isIntegratedGPU || (outPreferredFlags & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT) == 0)
3589 : {
3590 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3591 : }
3592 0 : break;
3593 0 : case VMA_MEMORY_USAGE_GPU_TO_CPU:
3594 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
3595 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_HOST_CACHED_BIT;
3596 0 : break;
3597 0 : case VMA_MEMORY_USAGE_CPU_COPY:
3598 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3599 0 : break;
3600 0 : case VMA_MEMORY_USAGE_GPU_LAZILY_ALLOCATED:
3601 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT;
3602 0 : break;
3603 0 : case VMA_MEMORY_USAGE_AUTO:
3604 : case VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE:
3605 : case VMA_MEMORY_USAGE_AUTO_PREFER_HOST:
3606 : {
3607 0 : if(bufImgUsage == UINT32_MAX)
3608 : {
3609 0 : VMA_ASSERT(0 && "VMA_MEMORY_USAGE_AUTO* values can only be used with functions like vmaCreateBuffer, vmaCreateImage so that the details of the created resource are known.");
3610 0 : return false;
3611 : }
3612 : // This relies on values of VK_IMAGE_USAGE_TRANSFER* being the same VK_BUFFER_IMAGE_TRANSFER*.
3613 0 : const bool deviceAccess = (bufImgUsage & ~(VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_TRANSFER_SRC_BIT)) != 0;
3614 0 : const bool hostAccessSequentialWrite = (allocCreateInfo.flags & VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT) != 0;
3615 0 : const bool hostAccessRandom = (allocCreateInfo.flags & VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT) != 0;
3616 0 : const bool hostAccessAllowTransferInstead = (allocCreateInfo.flags & VMA_ALLOCATION_CREATE_HOST_ACCESS_ALLOW_TRANSFER_INSTEAD_BIT) != 0;
3617 0 : const bool preferDevice = allocCreateInfo.usage == VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE;
3618 0 : const bool preferHost = allocCreateInfo.usage == VMA_MEMORY_USAGE_AUTO_PREFER_HOST;
3619 :
3620 : // CPU random access - e.g. a buffer written to or transferred from GPU to read back on CPU.
3621 0 : if(hostAccessRandom)
3622 : {
3623 0 : if(!isIntegratedGPU && deviceAccess && hostAccessAllowTransferInstead && !preferHost)
3624 : {
3625 : // Nice if it will end up in HOST_VISIBLE, but more importantly prefer DEVICE_LOCAL.
3626 : // Omitting HOST_VISIBLE here is intentional.
3627 : // In case there is DEVICE_LOCAL | HOST_VISIBLE | HOST_CACHED, it will pick that one.
3628 : // Otherwise, this will give same weight to DEVICE_LOCAL as HOST_VISIBLE | HOST_CACHED and select the former if occurs first on the list.
3629 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | VK_MEMORY_PROPERTY_HOST_CACHED_BIT;
3630 : }
3631 : else
3632 : {
3633 : // Always CPU memory, cached.
3634 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_CACHED_BIT;
3635 : }
3636 : }
3637 : // CPU sequential write - may be CPU or host-visible GPU memory, uncached and write-combined.
3638 0 : else if(hostAccessSequentialWrite)
3639 : {
3640 : // Want uncached and write-combined.
3641 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_HOST_CACHED_BIT;
3642 :
3643 0 : if(!isIntegratedGPU && deviceAccess && hostAccessAllowTransferInstead && !preferHost)
3644 : {
3645 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
3646 : }
3647 : else
3648 : {
3649 0 : outRequiredFlags |= VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT;
3650 : // Direct GPU access, CPU sequential write (e.g. a dynamic uniform buffer updated every frame)
3651 0 : if(deviceAccess)
3652 : {
3653 : // Could go to CPU memory or GPU BAR/unified. Up to the user to decide. If no preference, choose GPU memory.
3654 0 : if(preferHost)
3655 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3656 : else
3657 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3658 : }
3659 : // GPU no direct access, CPU sequential write (e.g. an upload buffer to be transferred to the GPU)
3660 : else
3661 : {
3662 : // Could go to CPU memory or GPU BAR/unified. Up to the user to decide. If no preference, choose CPU memory.
3663 0 : if(preferDevice)
3664 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3665 : else
3666 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3667 : }
3668 : }
3669 : }
3670 : // No CPU access
3671 : else
3672 : {
3673 : // GPU access, no CPU access (e.g. a color attachment image) - prefer GPU memory
3674 0 : if(deviceAccess)
3675 : {
3676 : // ...unless there is a clear preference from the user not to do so.
3677 0 : if(preferHost)
3678 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3679 : else
3680 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3681 : }
3682 : // No direct GPU access, no CPU access, just transfers.
3683 : // It may be staging copy intended for e.g. preserving image for next frame (then better GPU memory) or
3684 : // a "swap file" copy to free some GPU memory (then better CPU memory).
3685 : // Up to the user to decide. If no preferece, assume the former and choose GPU memory.
3686 0 : if(preferHost)
3687 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3688 : else
3689 0 : outPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
3690 : }
3691 0 : break;
3692 : }
3693 0 : default:
3694 0 : VMA_ASSERT(0);
3695 : }
3696 :
3697 : // Avoid DEVICE_COHERENT unless explicitly requested.
3698 0 : if(((allocCreateInfo.requiredFlags | allocCreateInfo.preferredFlags) &
3699 : (VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD_COPY | VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD_COPY)) == 0)
3700 : {
3701 0 : outNotPreferredFlags |= VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD_COPY;
3702 : }
3703 :
3704 0 : return true;
3705 : }
3706 :
3707 : ////////////////////////////////////////////////////////////////////////////////
3708 : // Memory allocation
3709 :
3710 0 : static void* VmaMalloc(const VkAllocationCallbacks* pAllocationCallbacks, size_t size, size_t alignment)
3711 : {
3712 0 : void* result = VMA_NULL;
3713 0 : if ((pAllocationCallbacks != VMA_NULL) &&
3714 0 : (pAllocationCallbacks->pfnAllocation != VMA_NULL))
3715 : {
3716 0 : result = (*pAllocationCallbacks->pfnAllocation)(
3717 0 : pAllocationCallbacks->pUserData,
3718 : size,
3719 : alignment,
3720 : VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
3721 : }
3722 : else
3723 : {
3724 0 : result = VMA_SYSTEM_ALIGNED_MALLOC(size, alignment);
3725 : }
3726 0 : VMA_ASSERT(result != VMA_NULL && "CPU memory allocation failed.");
3727 0 : return result;
3728 : }
3729 :
3730 0 : static void VmaFree(const VkAllocationCallbacks* pAllocationCallbacks, void* ptr)
3731 : {
3732 0 : if ((pAllocationCallbacks != VMA_NULL) &&
3733 0 : (pAllocationCallbacks->pfnFree != VMA_NULL))
3734 : {
3735 0 : (*pAllocationCallbacks->pfnFree)(pAllocationCallbacks->pUserData, ptr);
3736 : }
3737 : else
3738 : {
3739 0 : VMA_SYSTEM_ALIGNED_FREE(ptr);
3740 : }
3741 0 : }
3742 :
3743 : template<typename T>
3744 0 : static T* VmaAllocate(const VkAllocationCallbacks* pAllocationCallbacks)
3745 : {
3746 0 : return (T*)VmaMalloc(pAllocationCallbacks, sizeof(T), VMA_ALIGN_OF(T));
3747 : }
3748 :
3749 : template<typename T>
3750 0 : static T* VmaAllocateArray(const VkAllocationCallbacks* pAllocationCallbacks, size_t count)
3751 : {
3752 0 : return (T*)VmaMalloc(pAllocationCallbacks, sizeof(T) * count, VMA_ALIGN_OF(T));
3753 : }
3754 :
3755 : #define vma_new(allocator, type) new(VmaAllocate<type>(allocator))(type)
3756 :
3757 : #define vma_new_array(allocator, type, count) new(VmaAllocateArray<type>((allocator), (count)))(type)
3758 :
3759 : template<typename T>
3760 0 : static void vma_delete(const VkAllocationCallbacks* pAllocationCallbacks, T* ptr)
3761 : {
3762 0 : ptr->~T();
3763 0 : VmaFree(pAllocationCallbacks, ptr);
3764 0 : }
3765 :
3766 : template<typename T>
3767 0 : static void vma_delete_array(const VkAllocationCallbacks* pAllocationCallbacks, T* ptr, size_t count)
3768 : {
3769 0 : if (ptr != VMA_NULL)
3770 : {
3771 0 : for (size_t i = count; i--; )
3772 : {
3773 0 : ptr[i].~T();
3774 : }
3775 0 : VmaFree(pAllocationCallbacks, ptr);
3776 : }
3777 0 : }
3778 :
3779 0 : static char* VmaCreateStringCopy(const VkAllocationCallbacks* allocs, const char* srcStr)
3780 : {
3781 0 : if (srcStr != VMA_NULL)
3782 : {
3783 0 : const size_t len = strlen(srcStr);
3784 0 : char* const result = vma_new_array(allocs, char, len + 1);
3785 0 : memcpy(result, srcStr, len + 1);
3786 0 : return result;
3787 : }
3788 0 : return VMA_NULL;
3789 : }
3790 :
3791 : #if VMA_STATS_STRING_ENABLED
3792 0 : static char* VmaCreateStringCopy(const VkAllocationCallbacks* allocs, const char* srcStr, size_t strLen)
3793 : {
3794 0 : if (srcStr != VMA_NULL)
3795 : {
3796 0 : char* const result = vma_new_array(allocs, char, strLen + 1);
3797 0 : memcpy(result, srcStr, strLen);
3798 0 : result[strLen] = '\0';
3799 0 : return result;
3800 : }
3801 0 : return VMA_NULL;
3802 : }
3803 : #endif // VMA_STATS_STRING_ENABLED
3804 :
3805 0 : static void VmaFreeString(const VkAllocationCallbacks* allocs, char* str)
3806 : {
3807 0 : if (str != VMA_NULL)
3808 : {
3809 0 : const size_t len = strlen(str);
3810 0 : vma_delete_array(allocs, str, len + 1);
3811 : }
3812 0 : }
3813 :
3814 : template<typename CmpLess, typename VectorT>
3815 : size_t VmaVectorInsertSorted(VectorT& vector, const typename VectorT::value_type& value)
3816 : {
3817 : const size_t indexToInsert = VmaBinaryFindFirstNotLess(
3818 : vector.data(),
3819 : vector.data() + vector.size(),
3820 : value,
3821 : CmpLess()) - vector.data();
3822 : VmaVectorInsert(vector, indexToInsert, value);
3823 : return indexToInsert;
3824 : }
3825 :
3826 : template<typename CmpLess, typename VectorT>
3827 : bool VmaVectorRemoveSorted(VectorT& vector, const typename VectorT::value_type& value)
3828 : {
3829 : CmpLess comparator;
3830 : typename VectorT::iterator it = VmaBinaryFindFirstNotLess(
3831 : vector.begin(),
3832 : vector.end(),
3833 : value,
3834 : comparator);
3835 : if ((it != vector.end()) && !comparator(*it, value) && !comparator(value, *it))
3836 : {
3837 : size_t indexToRemove = it - vector.begin();
3838 : VmaVectorRemove(vector, indexToRemove);
3839 : return true;
3840 : }
3841 : return false;
3842 : }
3843 : #endif // _VMA_FUNCTIONS
3844 :
3845 : #ifndef _VMA_STATISTICS_FUNCTIONS
3846 :
3847 0 : static void VmaClearStatistics(VmaStatistics& outStats)
3848 : {
3849 0 : outStats.blockCount = 0;
3850 0 : outStats.allocationCount = 0;
3851 0 : outStats.blockBytes = 0;
3852 0 : outStats.allocationBytes = 0;
3853 0 : }
3854 :
3855 0 : static void VmaAddStatistics(VmaStatistics& inoutStats, const VmaStatistics& src)
3856 : {
3857 0 : inoutStats.blockCount += src.blockCount;
3858 0 : inoutStats.allocationCount += src.allocationCount;
3859 0 : inoutStats.blockBytes += src.blockBytes;
3860 0 : inoutStats.allocationBytes += src.allocationBytes;
3861 0 : }
3862 :
3863 0 : static void VmaClearDetailedStatistics(VmaDetailedStatistics& outStats)
3864 : {
3865 0 : VmaClearStatistics(outStats.statistics);
3866 0 : outStats.unusedRangeCount = 0;
3867 0 : outStats.allocationSizeMin = VK_WHOLE_SIZE;
3868 0 : outStats.allocationSizeMax = 0;
3869 0 : outStats.unusedRangeSizeMin = VK_WHOLE_SIZE;
3870 0 : outStats.unusedRangeSizeMax = 0;
3871 0 : }
3872 :
3873 0 : static void VmaAddDetailedStatisticsAllocation(VmaDetailedStatistics& inoutStats, VkDeviceSize size)
3874 : {
3875 0 : inoutStats.statistics.allocationCount++;
3876 0 : inoutStats.statistics.allocationBytes += size;
3877 0 : inoutStats.allocationSizeMin = VMA_MIN(inoutStats.allocationSizeMin, size);
3878 0 : inoutStats.allocationSizeMax = VMA_MAX(inoutStats.allocationSizeMax, size);
3879 0 : }
3880 :
3881 0 : static void VmaAddDetailedStatisticsUnusedRange(VmaDetailedStatistics& inoutStats, VkDeviceSize size)
3882 : {
3883 0 : inoutStats.unusedRangeCount++;
3884 0 : inoutStats.unusedRangeSizeMin = VMA_MIN(inoutStats.unusedRangeSizeMin, size);
3885 0 : inoutStats.unusedRangeSizeMax = VMA_MAX(inoutStats.unusedRangeSizeMax, size);
3886 0 : }
3887 :
3888 0 : static void VmaAddDetailedStatistics(VmaDetailedStatistics& inoutStats, const VmaDetailedStatistics& src)
3889 : {
3890 0 : VmaAddStatistics(inoutStats.statistics, src.statistics);
3891 0 : inoutStats.unusedRangeCount += src.unusedRangeCount;
3892 0 : inoutStats.allocationSizeMin = VMA_MIN(inoutStats.allocationSizeMin, src.allocationSizeMin);
3893 0 : inoutStats.allocationSizeMax = VMA_MAX(inoutStats.allocationSizeMax, src.allocationSizeMax);
3894 0 : inoutStats.unusedRangeSizeMin = VMA_MIN(inoutStats.unusedRangeSizeMin, src.unusedRangeSizeMin);
3895 0 : inoutStats.unusedRangeSizeMax = VMA_MAX(inoutStats.unusedRangeSizeMax, src.unusedRangeSizeMax);
3896 0 : }
3897 :
3898 : #endif // _VMA_STATISTICS_FUNCTIONS
3899 :
3900 : #ifndef _VMA_MUTEX_LOCK
3901 : // Helper RAII class to lock a mutex in constructor and unlock it in destructor (at the end of scope).
3902 : struct VmaMutexLock
3903 : {
3904 : VMA_CLASS_NO_COPY(VmaMutexLock)
3905 : public:
3906 0 : VmaMutexLock(VMA_MUTEX& mutex, bool useMutex = true) :
3907 0 : m_pMutex(useMutex ? &mutex : VMA_NULL)
3908 : {
3909 0 : if (m_pMutex) { m_pMutex->Lock(); }
3910 0 : }
3911 0 : ~VmaMutexLock() { if (m_pMutex) { m_pMutex->Unlock(); } }
3912 :
3913 : private:
3914 : VMA_MUTEX* m_pMutex;
3915 : };
3916 :
3917 : // Helper RAII class to lock a RW mutex in constructor and unlock it in destructor (at the end of scope), for reading.
3918 : struct VmaMutexLockRead
3919 : {
3920 : VMA_CLASS_NO_COPY(VmaMutexLockRead)
3921 : public:
3922 0 : VmaMutexLockRead(VMA_RW_MUTEX& mutex, bool useMutex) :
3923 0 : m_pMutex(useMutex ? &mutex : VMA_NULL)
3924 : {
3925 0 : if (m_pMutex) { m_pMutex->LockRead(); }
3926 0 : }
3927 0 : ~VmaMutexLockRead() { if (m_pMutex) { m_pMutex->UnlockRead(); } }
3928 :
3929 : private:
3930 : VMA_RW_MUTEX* m_pMutex;
3931 : };
3932 :
3933 : // Helper RAII class to lock a RW mutex in constructor and unlock it in destructor (at the end of scope), for writing.
3934 : struct VmaMutexLockWrite
3935 : {
3936 : VMA_CLASS_NO_COPY(VmaMutexLockWrite)
3937 : public:
3938 0 : VmaMutexLockWrite(VMA_RW_MUTEX& mutex, bool useMutex)
3939 0 : : m_pMutex(useMutex ? &mutex : VMA_NULL)
3940 : {
3941 0 : if (m_pMutex) { m_pMutex->LockWrite(); }
3942 0 : }
3943 0 : ~VmaMutexLockWrite() { if (m_pMutex) { m_pMutex->UnlockWrite(); } }
3944 :
3945 : private:
3946 : VMA_RW_MUTEX* m_pMutex;
3947 : };
3948 :
3949 : #if VMA_DEBUG_GLOBAL_MUTEX
3950 : static VMA_MUTEX gDebugGlobalMutex;
3951 : #define VMA_DEBUG_GLOBAL_MUTEX_LOCK VmaMutexLock debugGlobalMutexLock(gDebugGlobalMutex, true);
3952 : #else
3953 : #define VMA_DEBUG_GLOBAL_MUTEX_LOCK
3954 : #endif
3955 : #endif // _VMA_MUTEX_LOCK
3956 :
3957 : #ifndef _VMA_ATOMIC_TRANSACTIONAL_INCREMENT
3958 : // An object that increments given atomic but decrements it back in the destructor unless Commit() is called.
3959 : template<typename T>
3960 : struct AtomicTransactionalIncrement
3961 : {
3962 : public:
3963 : typedef std::atomic<T> AtomicT;
3964 :
3965 0 : ~AtomicTransactionalIncrement()
3966 : {
3967 0 : if(m_Atomic)
3968 0 : --(*m_Atomic);
3969 0 : }
3970 :
3971 0 : void Commit() { m_Atomic = nullptr; }
3972 0 : T Increment(AtomicT* atomic)
3973 : {
3974 0 : m_Atomic = atomic;
3975 0 : return m_Atomic->fetch_add(1);
3976 : }
3977 :
3978 : private:
3979 : AtomicT* m_Atomic = nullptr;
3980 : };
3981 : #endif // _VMA_ATOMIC_TRANSACTIONAL_INCREMENT
3982 :
3983 : #ifndef _VMA_STL_ALLOCATOR
3984 : // STL-compatible allocator.
3985 : template<typename T>
3986 : struct VmaStlAllocator
3987 : {
3988 : const VkAllocationCallbacks* const m_pCallbacks;
3989 : typedef T value_type;
3990 :
3991 0 : VmaStlAllocator(const VkAllocationCallbacks* pCallbacks) : m_pCallbacks(pCallbacks) {}
3992 : template<typename U>
3993 : VmaStlAllocator(const VmaStlAllocator<U>& src) : m_pCallbacks(src.m_pCallbacks) {}
3994 : VmaStlAllocator(const VmaStlAllocator&) = default;
3995 : VmaStlAllocator& operator=(const VmaStlAllocator&) = delete;
3996 :
3997 : T* allocate(size_t n) { return VmaAllocateArray<T>(m_pCallbacks, n); }
3998 : void deallocate(T* p, size_t n) { VmaFree(m_pCallbacks, p); }
3999 :
4000 : template<typename U>
4001 : bool operator==(const VmaStlAllocator<U>& rhs) const
4002 : {
4003 : return m_pCallbacks == rhs.m_pCallbacks;
4004 : }
4005 : template<typename U>
4006 : bool operator!=(const VmaStlAllocator<U>& rhs) const
4007 : {
4008 : return m_pCallbacks != rhs.m_pCallbacks;
4009 : }
4010 : };
4011 : #endif // _VMA_STL_ALLOCATOR
4012 :
4013 : #ifndef _VMA_VECTOR
4014 : /* Class with interface compatible with subset of std::vector.
4015 : T must be POD because constructors and destructors are not called and memcpy is
4016 : used for these objects. */
4017 : template<typename T, typename AllocatorT>
4018 : class VmaVector
4019 : {
4020 : public:
4021 : typedef T value_type;
4022 : typedef T* iterator;
4023 : typedef const T* const_iterator;
4024 :
4025 : VmaVector(const AllocatorT& allocator);
4026 : VmaVector(size_t count, const AllocatorT& allocator);
4027 : // This version of the constructor is here for compatibility with pre-C++14 std::vector.
4028 : // value is unused.
4029 : VmaVector(size_t count, const T& value, const AllocatorT& allocator) : VmaVector(count, allocator) {}
4030 : VmaVector(const VmaVector<T, AllocatorT>& src);
4031 : VmaVector& operator=(const VmaVector& rhs);
4032 0 : ~VmaVector() { VmaFree(m_Allocator.m_pCallbacks, m_pArray); }
4033 :
4034 0 : bool empty() const { return m_Count == 0; }
4035 0 : size_t size() const { return m_Count; }
4036 0 : T* data() { return m_pArray; }
4037 : T& front() { VMA_HEAVY_ASSERT(m_Count > 0); return m_pArray[0]; }
4038 0 : T& back() { VMA_HEAVY_ASSERT(m_Count > 0); return m_pArray[m_Count - 1]; }
4039 0 : const T* data() const { return m_pArray; }
4040 : const T& front() const { VMA_HEAVY_ASSERT(m_Count > 0); return m_pArray[0]; }
4041 0 : const T& back() const { VMA_HEAVY_ASSERT(m_Count > 0); return m_pArray[m_Count - 1]; }
4042 :
4043 0 : iterator begin() { return m_pArray; }
4044 0 : iterator end() { return m_pArray + m_Count; }
4045 0 : const_iterator cbegin() const { return m_pArray; }
4046 0 : const_iterator cend() const { return m_pArray + m_Count; }
4047 0 : const_iterator begin() const { return cbegin(); }
4048 0 : const_iterator end() const { return cend(); }
4049 :
4050 : void pop_front() { VMA_HEAVY_ASSERT(m_Count > 0); remove(0); }
4051 0 : void pop_back() { VMA_HEAVY_ASSERT(m_Count > 0); resize(size() - 1); }
4052 : void push_front(const T& src) { insert(0, src); }
4053 :
4054 : void push_back(const T& src);
4055 : void reserve(size_t newCapacity, bool freeMemory = false);
4056 : void resize(size_t newCount);
4057 0 : void clear() { resize(0); }
4058 : void shrink_to_fit();
4059 : void insert(size_t index, const T& src);
4060 : void remove(size_t index);
4061 :
4062 0 : T& operator[](size_t index) { VMA_HEAVY_ASSERT(index < m_Count); return m_pArray[index]; }
4063 0 : const T& operator[](size_t index) const { VMA_HEAVY_ASSERT(index < m_Count); return m_pArray[index]; }
4064 :
4065 : private:
4066 : AllocatorT m_Allocator;
4067 : T* m_pArray;
4068 : size_t m_Count;
4069 : size_t m_Capacity;
4070 : };
4071 :
4072 : #ifndef _VMA_VECTOR_FUNCTIONS
4073 : template<typename T, typename AllocatorT>
4074 0 : VmaVector<T, AllocatorT>::VmaVector(const AllocatorT& allocator)
4075 : : m_Allocator(allocator),
4076 : m_pArray(VMA_NULL),
4077 : m_Count(0),
4078 0 : m_Capacity(0) {}
4079 :
4080 : template<typename T, typename AllocatorT>
4081 0 : VmaVector<T, AllocatorT>::VmaVector(size_t count, const AllocatorT& allocator)
4082 : : m_Allocator(allocator),
4083 0 : m_pArray(count ? (T*)VmaAllocateArray<T>(allocator.m_pCallbacks, count) : VMA_NULL),
4084 : m_Count(count),
4085 0 : m_Capacity(count) {}
4086 :
4087 : template<typename T, typename AllocatorT>
4088 : VmaVector<T, AllocatorT>::VmaVector(const VmaVector& src)
4089 : : m_Allocator(src.m_Allocator),
4090 : m_pArray(src.m_Count ? (T*)VmaAllocateArray<T>(src.m_Allocator.m_pCallbacks, src.m_Count) : VMA_NULL),
4091 : m_Count(src.m_Count),
4092 : m_Capacity(src.m_Count)
4093 : {
4094 : if (m_Count != 0)
4095 : {
4096 : memcpy(m_pArray, src.m_pArray, m_Count * sizeof(T));
4097 : }
4098 : }
4099 :
4100 : template<typename T, typename AllocatorT>
4101 : VmaVector<T, AllocatorT>& VmaVector<T, AllocatorT>::operator=(const VmaVector& rhs)
4102 : {
4103 : if (&rhs != this)
4104 : {
4105 : resize(rhs.m_Count);
4106 : if (m_Count != 0)
4107 : {
4108 : memcpy(m_pArray, rhs.m_pArray, m_Count * sizeof(T));
4109 : }
4110 : }
4111 : return *this;
4112 : }
4113 :
4114 : template<typename T, typename AllocatorT>
4115 0 : void VmaVector<T, AllocatorT>::push_back(const T& src)
4116 : {
4117 0 : const size_t newIndex = size();
4118 0 : resize(newIndex + 1);
4119 0 : m_pArray[newIndex] = src;
4120 0 : }
4121 :
4122 : template<typename T, typename AllocatorT>
4123 : void VmaVector<T, AllocatorT>::reserve(size_t newCapacity, bool freeMemory)
4124 : {
4125 : newCapacity = VMA_MAX(newCapacity, m_Count);
4126 :
4127 : if ((newCapacity < m_Capacity) && !freeMemory)
4128 : {
4129 : newCapacity = m_Capacity;
4130 : }
4131 :
4132 : if (newCapacity != m_Capacity)
4133 : {
4134 : T* const newArray = newCapacity ? VmaAllocateArray<T>(m_Allocator, newCapacity) : VMA_NULL;
4135 : if (m_Count != 0)
4136 : {
4137 : memcpy(newArray, m_pArray, m_Count * sizeof(T));
4138 : }
4139 : VmaFree(m_Allocator.m_pCallbacks, m_pArray);
4140 : m_Capacity = newCapacity;
4141 : m_pArray = newArray;
4142 : }
4143 : }
4144 :
4145 : template<typename T, typename AllocatorT>
4146 0 : void VmaVector<T, AllocatorT>::resize(size_t newCount)
4147 : {
4148 0 : size_t newCapacity = m_Capacity;
4149 0 : if (newCount > m_Capacity)
4150 : {
4151 0 : newCapacity = VMA_MAX(newCount, VMA_MAX(m_Capacity * 3 / 2, (size_t)8));
4152 : }
4153 :
4154 0 : if (newCapacity != m_Capacity)
4155 : {
4156 0 : T* const newArray = newCapacity ? VmaAllocateArray<T>(m_Allocator.m_pCallbacks, newCapacity) : VMA_NULL;
4157 0 : const size_t elementsToCopy = VMA_MIN(m_Count, newCount);
4158 0 : if (elementsToCopy != 0)
4159 : {
4160 0 : memcpy(newArray, m_pArray, elementsToCopy * sizeof(T));
4161 : }
4162 0 : VmaFree(m_Allocator.m_pCallbacks, m_pArray);
4163 0 : m_Capacity = newCapacity;
4164 0 : m_pArray = newArray;
4165 : }
4166 :
4167 0 : m_Count = newCount;
4168 0 : }
4169 :
4170 : template<typename T, typename AllocatorT>
4171 0 : void VmaVector<T, AllocatorT>::shrink_to_fit()
4172 : {
4173 0 : if (m_Capacity > m_Count)
4174 : {
4175 0 : T* newArray = VMA_NULL;
4176 0 : if (m_Count > 0)
4177 : {
4178 0 : newArray = VmaAllocateArray<T>(m_Allocator.m_pCallbacks, m_Count);
4179 0 : memcpy(newArray, m_pArray, m_Count * sizeof(T));
4180 : }
4181 0 : VmaFree(m_Allocator.m_pCallbacks, m_pArray);
4182 0 : m_Capacity = m_Count;
4183 0 : m_pArray = newArray;
4184 : }
4185 0 : }
4186 :
4187 : template<typename T, typename AllocatorT>
4188 : void VmaVector<T, AllocatorT>::insert(size_t index, const T& src)
4189 : {
4190 : VMA_HEAVY_ASSERT(index <= m_Count);
4191 : const size_t oldCount = size();
4192 : resize(oldCount + 1);
4193 : if (index < oldCount)
4194 : {
4195 : memmove(m_pArray + (index + 1), m_pArray + index, (oldCount - index) * sizeof(T));
4196 : }
4197 : m_pArray[index] = src;
4198 : }
4199 :
4200 : template<typename T, typename AllocatorT>
4201 0 : void VmaVector<T, AllocatorT>::remove(size_t index)
4202 : {
4203 0 : VMA_HEAVY_ASSERT(index < m_Count);
4204 0 : const size_t oldCount = size();
4205 0 : if (index < oldCount - 1)
4206 : {
4207 0 : memmove(m_pArray + index, m_pArray + (index + 1), (oldCount - index - 1) * sizeof(T));
4208 : }
4209 0 : resize(oldCount - 1);
4210 0 : }
4211 : #endif // _VMA_VECTOR_FUNCTIONS
4212 :
4213 : template<typename T, typename allocatorT>
4214 : static void VmaVectorInsert(VmaVector<T, allocatorT>& vec, size_t index, const T& item)
4215 : {
4216 : vec.insert(index, item);
4217 : }
4218 :
4219 : template<typename T, typename allocatorT>
4220 0 : static void VmaVectorRemove(VmaVector<T, allocatorT>& vec, size_t index)
4221 : {
4222 0 : vec.remove(index);
4223 0 : }
4224 : #endif // _VMA_VECTOR
4225 :
4226 : #ifndef _VMA_SMALL_VECTOR
4227 : /*
4228 : This is a vector (a variable-sized array), optimized for the case when the array is small.
4229 :
4230 : It contains some number of elements in-place, which allows it to avoid heap allocation
4231 : when the actual number of elements is below that threshold. This allows normal "small"
4232 : cases to be fast without losing generality for large inputs.
4233 : */
4234 : template<typename T, typename AllocatorT, size_t N>
4235 : class VmaSmallVector
4236 : {
4237 : public:
4238 : typedef T value_type;
4239 : typedef T* iterator;
4240 :
4241 : VmaSmallVector(const AllocatorT& allocator);
4242 : VmaSmallVector(size_t count, const AllocatorT& allocator);
4243 : template<typename SrcT, typename SrcAllocatorT, size_t SrcN>
4244 : VmaSmallVector(const VmaSmallVector<SrcT, SrcAllocatorT, SrcN>&) = delete;
4245 : template<typename SrcT, typename SrcAllocatorT, size_t SrcN>
4246 : VmaSmallVector<T, AllocatorT, N>& operator=(const VmaSmallVector<SrcT, SrcAllocatorT, SrcN>&) = delete;
4247 0 : ~VmaSmallVector() = default;
4248 :
4249 0 : bool empty() const { return m_Count == 0; }
4250 0 : size_t size() const { return m_Count; }
4251 0 : T* data() { return m_Count > N ? m_DynamicArray.data() : m_StaticArray; }
4252 : T& front() { VMA_HEAVY_ASSERT(m_Count > 0); return data()[0]; }
4253 : T& back() { VMA_HEAVY_ASSERT(m_Count > 0); return data()[m_Count - 1]; }
4254 : const T* data() const { return m_Count > N ? m_DynamicArray.data() : m_StaticArray; }
4255 : const T& front() const { VMA_HEAVY_ASSERT(m_Count > 0); return data()[0]; }
4256 : const T& back() const { VMA_HEAVY_ASSERT(m_Count > 0); return data()[m_Count - 1]; }
4257 :
4258 : iterator begin() { return data(); }
4259 : iterator end() { return data() + m_Count; }
4260 :
4261 : void pop_front() { VMA_HEAVY_ASSERT(m_Count > 0); remove(0); }
4262 : void pop_back() { VMA_HEAVY_ASSERT(m_Count > 0); resize(size() - 1); }
4263 : void push_front(const T& src) { insert(0, src); }
4264 :
4265 : void push_back(const T& src);
4266 : void resize(size_t newCount, bool freeMemory = false);
4267 : void clear(bool freeMemory = false);
4268 : void insert(size_t index, const T& src);
4269 : void remove(size_t index);
4270 :
4271 : T& operator[](size_t index) { VMA_HEAVY_ASSERT(index < m_Count); return data()[index]; }
4272 : const T& operator[](size_t index) const { VMA_HEAVY_ASSERT(index < m_Count); return data()[index]; }
4273 :
4274 : private:
4275 : size_t m_Count;
4276 : T m_StaticArray[N]; // Used when m_Size <= N
4277 : VmaVector<T, AllocatorT> m_DynamicArray; // Used when m_Size > N
4278 : };
4279 :
4280 : #ifndef _VMA_SMALL_VECTOR_FUNCTIONS
4281 : template<typename T, typename AllocatorT, size_t N>
4282 0 : VmaSmallVector<T, AllocatorT, N>::VmaSmallVector(const AllocatorT& allocator)
4283 : : m_Count(0),
4284 0 : m_DynamicArray(allocator) {}
4285 :
4286 : template<typename T, typename AllocatorT, size_t N>
4287 : VmaSmallVector<T, AllocatorT, N>::VmaSmallVector(size_t count, const AllocatorT& allocator)
4288 : : m_Count(count),
4289 : m_DynamicArray(count > N ? count : 0, allocator) {}
4290 :
4291 : template<typename T, typename AllocatorT, size_t N>
4292 0 : void VmaSmallVector<T, AllocatorT, N>::push_back(const T& src)
4293 : {
4294 0 : const size_t newIndex = size();
4295 0 : resize(newIndex + 1);
4296 0 : data()[newIndex] = src;
4297 0 : }
4298 :
4299 : template<typename T, typename AllocatorT, size_t N>
4300 0 : void VmaSmallVector<T, AllocatorT, N>::resize(size_t newCount, bool freeMemory)
4301 : {
4302 0 : if (newCount > N && m_Count > N)
4303 : {
4304 : // Any direction, staying in m_DynamicArray
4305 0 : m_DynamicArray.resize(newCount);
4306 0 : if (freeMemory)
4307 : {
4308 0 : m_DynamicArray.shrink_to_fit();
4309 : }
4310 : }
4311 0 : else if (newCount > N && m_Count <= N)
4312 : {
4313 : // Growing, moving from m_StaticArray to m_DynamicArray
4314 0 : m_DynamicArray.resize(newCount);
4315 0 : if (m_Count > 0)
4316 : {
4317 0 : memcpy(m_DynamicArray.data(), m_StaticArray, m_Count * sizeof(T));
4318 : }
4319 : }
4320 0 : else if (newCount <= N && m_Count > N)
4321 : {
4322 : // Shrinking, moving from m_DynamicArray to m_StaticArray
4323 0 : if (newCount > 0)
4324 : {
4325 0 : memcpy(m_StaticArray, m_DynamicArray.data(), newCount * sizeof(T));
4326 : }
4327 0 : m_DynamicArray.resize(0);
4328 0 : if (freeMemory)
4329 : {
4330 0 : m_DynamicArray.shrink_to_fit();
4331 : }
4332 : }
4333 : else
4334 : {
4335 : // Any direction, staying in m_StaticArray - nothing to do here
4336 : }
4337 0 : m_Count = newCount;
4338 0 : }
4339 :
4340 : template<typename T, typename AllocatorT, size_t N>
4341 : void VmaSmallVector<T, AllocatorT, N>::clear(bool freeMemory)
4342 : {
4343 : m_DynamicArray.clear();
4344 : if (freeMemory)
4345 : {
4346 : m_DynamicArray.shrink_to_fit();
4347 : }
4348 : m_Count = 0;
4349 : }
4350 :
4351 : template<typename T, typename AllocatorT, size_t N>
4352 : void VmaSmallVector<T, AllocatorT, N>::insert(size_t index, const T& src)
4353 : {
4354 : VMA_HEAVY_ASSERT(index <= m_Count);
4355 : const size_t oldCount = size();
4356 : resize(oldCount + 1);
4357 : T* const dataPtr = data();
4358 : if (index < oldCount)
4359 : {
4360 : // I know, this could be more optimal for case where memmove can be memcpy directly from m_StaticArray to m_DynamicArray.
4361 : memmove(dataPtr + (index + 1), dataPtr + index, (oldCount - index) * sizeof(T));
4362 : }
4363 : dataPtr[index] = src;
4364 : }
4365 :
4366 : template<typename T, typename AllocatorT, size_t N>
4367 : void VmaSmallVector<T, AllocatorT, N>::remove(size_t index)
4368 : {
4369 : VMA_HEAVY_ASSERT(index < m_Count);
4370 : const size_t oldCount = size();
4371 : if (index < oldCount - 1)
4372 : {
4373 : // I know, this could be more optimal for case where memmove can be memcpy directly from m_DynamicArray to m_StaticArray.
4374 : T* const dataPtr = data();
4375 : memmove(dataPtr + index, dataPtr + (index + 1), (oldCount - index - 1) * sizeof(T));
4376 : }
4377 : resize(oldCount - 1);
4378 : }
4379 : #endif // _VMA_SMALL_VECTOR_FUNCTIONS
4380 : #endif // _VMA_SMALL_VECTOR
4381 :
4382 : #ifndef _VMA_POOL_ALLOCATOR
4383 : /*
4384 : Allocator for objects of type T using a list of arrays (pools) to speed up
4385 : allocation. Number of elements that can be allocated is not bounded because
4386 : allocator can create multiple blocks.
4387 : */
4388 : template<typename T>
4389 : class VmaPoolAllocator
4390 : {
4391 : VMA_CLASS_NO_COPY(VmaPoolAllocator)
4392 : public:
4393 : VmaPoolAllocator(const VkAllocationCallbacks* pAllocationCallbacks, uint32_t firstBlockCapacity);
4394 : ~VmaPoolAllocator();
4395 : template<typename... Types> T* Alloc(Types&&... args);
4396 : void Free(T* ptr);
4397 :
4398 : private:
4399 : union Item
4400 : {
4401 : uint32_t NextFreeIndex;
4402 : alignas(T) char Value[sizeof(T)];
4403 : };
4404 : struct ItemBlock
4405 : {
4406 : Item* pItems;
4407 : uint32_t Capacity;
4408 : uint32_t FirstFreeIndex;
4409 : };
4410 :
4411 : const VkAllocationCallbacks* m_pAllocationCallbacks;
4412 : const uint32_t m_FirstBlockCapacity;
4413 : VmaVector<ItemBlock, VmaStlAllocator<ItemBlock>> m_ItemBlocks;
4414 :
4415 : ItemBlock& CreateNewBlock();
4416 : };
4417 :
4418 : #ifndef _VMA_POOL_ALLOCATOR_FUNCTIONS
4419 : template<typename T>
4420 0 : VmaPoolAllocator<T>::VmaPoolAllocator(const VkAllocationCallbacks* pAllocationCallbacks, uint32_t firstBlockCapacity)
4421 : : m_pAllocationCallbacks(pAllocationCallbacks),
4422 : m_FirstBlockCapacity(firstBlockCapacity),
4423 0 : m_ItemBlocks(VmaStlAllocator<ItemBlock>(pAllocationCallbacks))
4424 : {
4425 0 : VMA_ASSERT(m_FirstBlockCapacity > 1);
4426 0 : }
4427 :
4428 : template<typename T>
4429 0 : VmaPoolAllocator<T>::~VmaPoolAllocator()
4430 : {
4431 0 : for (size_t i = m_ItemBlocks.size(); i--;)
4432 0 : vma_delete_array(m_pAllocationCallbacks, m_ItemBlocks[i].pItems, m_ItemBlocks[i].Capacity);
4433 0 : m_ItemBlocks.clear();
4434 0 : }
4435 :
4436 : template<typename T>
4437 0 : template<typename... Types> T* VmaPoolAllocator<T>::Alloc(Types&&... args)
4438 : {
4439 0 : for (size_t i = m_ItemBlocks.size(); i--; )
4440 : {
4441 0 : ItemBlock& block = m_ItemBlocks[i];
4442 : // This block has some free items: Use first one.
4443 0 : if (block.FirstFreeIndex != UINT32_MAX)
4444 : {
4445 0 : Item* const pItem = &block.pItems[block.FirstFreeIndex];
4446 0 : block.FirstFreeIndex = pItem->NextFreeIndex;
4447 0 : T* result = (T*)&pItem->Value;
4448 0 : new(result)T(std::forward<Types>(args)...); // Explicit constructor call.
4449 0 : return result;
4450 : }
4451 : }
4452 :
4453 : // No block has free item: Create new one and use it.
4454 0 : ItemBlock& newBlock = CreateNewBlock();
4455 0 : Item* const pItem = &newBlock.pItems[0];
4456 0 : newBlock.FirstFreeIndex = pItem->NextFreeIndex;
4457 0 : T* result = (T*)&pItem->Value;
4458 0 : new(result) T(std::forward<Types>(args)...); // Explicit constructor call.
4459 0 : return result;
4460 : }
4461 :
4462 : template<typename T>
4463 0 : void VmaPoolAllocator<T>::Free(T* ptr)
4464 : {
4465 : // Search all memory blocks to find ptr.
4466 0 : for (size_t i = m_ItemBlocks.size(); i--; )
4467 : {
4468 0 : ItemBlock& block = m_ItemBlocks[i];
4469 :
4470 : // Casting to union.
4471 : Item* pItemPtr;
4472 0 : memcpy(&pItemPtr, &ptr, sizeof(pItemPtr));
4473 :
4474 : // Check if pItemPtr is in address range of this block.
4475 0 : if ((pItemPtr >= block.pItems) && (pItemPtr < block.pItems + block.Capacity))
4476 : {
4477 0 : ptr->~T(); // Explicit destructor call.
4478 0 : const uint32_t index = static_cast<uint32_t>(pItemPtr - block.pItems);
4479 0 : pItemPtr->NextFreeIndex = block.FirstFreeIndex;
4480 0 : block.FirstFreeIndex = index;
4481 0 : return;
4482 : }
4483 : }
4484 0 : VMA_ASSERT(0 && "Pointer doesn't belong to this memory pool.");
4485 : }
4486 :
4487 : template<typename T>
4488 0 : typename VmaPoolAllocator<T>::ItemBlock& VmaPoolAllocator<T>::CreateNewBlock()
4489 : {
4490 0 : const uint32_t newBlockCapacity = m_ItemBlocks.empty() ?
4491 0 : m_FirstBlockCapacity : m_ItemBlocks.back().Capacity * 3 / 2;
4492 :
4493 0 : const ItemBlock newBlock =
4494 : {
4495 0 : vma_new_array(m_pAllocationCallbacks, Item, newBlockCapacity),
4496 : newBlockCapacity,
4497 : 0
4498 : };
4499 :
4500 0 : m_ItemBlocks.push_back(newBlock);
4501 :
4502 : // Setup singly-linked list of all free items in this block.
4503 0 : for (uint32_t i = 0; i < newBlockCapacity - 1; ++i)
4504 0 : newBlock.pItems[i].NextFreeIndex = i + 1;
4505 0 : newBlock.pItems[newBlockCapacity - 1].NextFreeIndex = UINT32_MAX;
4506 0 : return m_ItemBlocks.back();
4507 : }
4508 : #endif // _VMA_POOL_ALLOCATOR_FUNCTIONS
4509 : #endif // _VMA_POOL_ALLOCATOR
4510 :
4511 : #ifndef _VMA_RAW_LIST
4512 : template<typename T>
4513 : struct VmaListItem
4514 : {
4515 : VmaListItem* pPrev;
4516 : VmaListItem* pNext;
4517 : T Value;
4518 : };
4519 :
4520 : // Doubly linked list.
4521 : template<typename T>
4522 : class VmaRawList
4523 : {
4524 : VMA_CLASS_NO_COPY(VmaRawList)
4525 : public:
4526 : typedef VmaListItem<T> ItemType;
4527 :
4528 : VmaRawList(const VkAllocationCallbacks* pAllocationCallbacks);
4529 : // Intentionally not calling Clear, because that would be unnecessary
4530 : // computations to return all items to m_ItemAllocator as free.
4531 : ~VmaRawList() = default;
4532 :
4533 : size_t GetCount() const { return m_Count; }
4534 : bool IsEmpty() const { return m_Count == 0; }
4535 :
4536 : ItemType* Front() { return m_pFront; }
4537 : ItemType* Back() { return m_pBack; }
4538 : const ItemType* Front() const { return m_pFront; }
4539 : const ItemType* Back() const { return m_pBack; }
4540 :
4541 : ItemType* PushFront();
4542 : ItemType* PushBack();
4543 : ItemType* PushFront(const T& value);
4544 : ItemType* PushBack(const T& value);
4545 : void PopFront();
4546 : void PopBack();
4547 :
4548 : // Item can be null - it means PushBack.
4549 : ItemType* InsertBefore(ItemType* pItem);
4550 : // Item can be null - it means PushFront.
4551 : ItemType* InsertAfter(ItemType* pItem);
4552 : ItemType* InsertBefore(ItemType* pItem, const T& value);
4553 : ItemType* InsertAfter(ItemType* pItem, const T& value);
4554 :
4555 : void Clear();
4556 : void Remove(ItemType* pItem);
4557 :
4558 : private:
4559 : const VkAllocationCallbacks* const m_pAllocationCallbacks;
4560 : VmaPoolAllocator<ItemType> m_ItemAllocator;
4561 : ItemType* m_pFront;
4562 : ItemType* m_pBack;
4563 : size_t m_Count;
4564 : };
4565 :
4566 : #ifndef _VMA_RAW_LIST_FUNCTIONS
4567 : template<typename T>
4568 : VmaRawList<T>::VmaRawList(const VkAllocationCallbacks* pAllocationCallbacks)
4569 : : m_pAllocationCallbacks(pAllocationCallbacks),
4570 : m_ItemAllocator(pAllocationCallbacks, 128),
4571 : m_pFront(VMA_NULL),
4572 : m_pBack(VMA_NULL),
4573 : m_Count(0) {}
4574 :
4575 : template<typename T>
4576 : VmaListItem<T>* VmaRawList<T>::PushFront()
4577 : {
4578 : ItemType* const pNewItem = m_ItemAllocator.Alloc();
4579 : pNewItem->pPrev = VMA_NULL;
4580 : if (IsEmpty())
4581 : {
4582 : pNewItem->pNext = VMA_NULL;
4583 : m_pFront = pNewItem;
4584 : m_pBack = pNewItem;
4585 : m_Count = 1;
4586 : }
4587 : else
4588 : {
4589 : pNewItem->pNext = m_pFront;
4590 : m_pFront->pPrev = pNewItem;
4591 : m_pFront = pNewItem;
4592 : ++m_Count;
4593 : }
4594 : return pNewItem;
4595 : }
4596 :
4597 : template<typename T>
4598 : VmaListItem<T>* VmaRawList<T>::PushBack()
4599 : {
4600 : ItemType* const pNewItem = m_ItemAllocator.Alloc();
4601 : pNewItem->pNext = VMA_NULL;
4602 : if(IsEmpty())
4603 : {
4604 : pNewItem->pPrev = VMA_NULL;
4605 : m_pFront = pNewItem;
4606 : m_pBack = pNewItem;
4607 : m_Count = 1;
4608 : }
4609 : else
4610 : {
4611 : pNewItem->pPrev = m_pBack;
4612 : m_pBack->pNext = pNewItem;
4613 : m_pBack = pNewItem;
4614 : ++m_Count;
4615 : }
4616 : return pNewItem;
4617 : }
4618 :
4619 : template<typename T>
4620 : VmaListItem<T>* VmaRawList<T>::PushFront(const T& value)
4621 : {
4622 : ItemType* const pNewItem = PushFront();
4623 : pNewItem->Value = value;
4624 : return pNewItem;
4625 : }
4626 :
4627 : template<typename T>
4628 : VmaListItem<T>* VmaRawList<T>::PushBack(const T& value)
4629 : {
4630 : ItemType* const pNewItem = PushBack();
4631 : pNewItem->Value = value;
4632 : return pNewItem;
4633 : }
4634 :
4635 : template<typename T>
4636 : void VmaRawList<T>::PopFront()
4637 : {
4638 : VMA_HEAVY_ASSERT(m_Count > 0);
4639 : ItemType* const pFrontItem = m_pFront;
4640 : ItemType* const pNextItem = pFrontItem->pNext;
4641 : if (pNextItem != VMA_NULL)
4642 : {
4643 : pNextItem->pPrev = VMA_NULL;
4644 : }
4645 : m_pFront = pNextItem;
4646 : m_ItemAllocator.Free(pFrontItem);
4647 : --m_Count;
4648 : }
4649 :
4650 : template<typename T>
4651 : void VmaRawList<T>::PopBack()
4652 : {
4653 : VMA_HEAVY_ASSERT(m_Count > 0);
4654 : ItemType* const pBackItem = m_pBack;
4655 : ItemType* const pPrevItem = pBackItem->pPrev;
4656 : if(pPrevItem != VMA_NULL)
4657 : {
4658 : pPrevItem->pNext = VMA_NULL;
4659 : }
4660 : m_pBack = pPrevItem;
4661 : m_ItemAllocator.Free(pBackItem);
4662 : --m_Count;
4663 : }
4664 :
4665 : template<typename T>
4666 : void VmaRawList<T>::Clear()
4667 : {
4668 : if (IsEmpty() == false)
4669 : {
4670 : ItemType* pItem = m_pBack;
4671 : while (pItem != VMA_NULL)
4672 : {
4673 : ItemType* const pPrevItem = pItem->pPrev;
4674 : m_ItemAllocator.Free(pItem);
4675 : pItem = pPrevItem;
4676 : }
4677 : m_pFront = VMA_NULL;
4678 : m_pBack = VMA_NULL;
4679 : m_Count = 0;
4680 : }
4681 : }
4682 :
4683 : template<typename T>
4684 : void VmaRawList<T>::Remove(ItemType* pItem)
4685 : {
4686 : VMA_HEAVY_ASSERT(pItem != VMA_NULL);
4687 : VMA_HEAVY_ASSERT(m_Count > 0);
4688 :
4689 : if(pItem->pPrev != VMA_NULL)
4690 : {
4691 : pItem->pPrev->pNext = pItem->pNext;
4692 : }
4693 : else
4694 : {
4695 : VMA_HEAVY_ASSERT(m_pFront == pItem);
4696 : m_pFront = pItem->pNext;
4697 : }
4698 :
4699 : if(pItem->pNext != VMA_NULL)
4700 : {
4701 : pItem->pNext->pPrev = pItem->pPrev;
4702 : }
4703 : else
4704 : {
4705 : VMA_HEAVY_ASSERT(m_pBack == pItem);
4706 : m_pBack = pItem->pPrev;
4707 : }
4708 :
4709 : m_ItemAllocator.Free(pItem);
4710 : --m_Count;
4711 : }
4712 :
4713 : template<typename T>
4714 : VmaListItem<T>* VmaRawList<T>::InsertBefore(ItemType* pItem)
4715 : {
4716 : if(pItem != VMA_NULL)
4717 : {
4718 : ItemType* const prevItem = pItem->pPrev;
4719 : ItemType* const newItem = m_ItemAllocator.Alloc();
4720 : newItem->pPrev = prevItem;
4721 : newItem->pNext = pItem;
4722 : pItem->pPrev = newItem;
4723 : if(prevItem != VMA_NULL)
4724 : {
4725 : prevItem->pNext = newItem;
4726 : }
4727 : else
4728 : {
4729 : VMA_HEAVY_ASSERT(m_pFront == pItem);
4730 : m_pFront = newItem;
4731 : }
4732 : ++m_Count;
4733 : return newItem;
4734 : }
4735 : else
4736 : return PushBack();
4737 : }
4738 :
4739 : template<typename T>
4740 : VmaListItem<T>* VmaRawList<T>::InsertAfter(ItemType* pItem)
4741 : {
4742 : if(pItem != VMA_NULL)
4743 : {
4744 : ItemType* const nextItem = pItem->pNext;
4745 : ItemType* const newItem = m_ItemAllocator.Alloc();
4746 : newItem->pNext = nextItem;
4747 : newItem->pPrev = pItem;
4748 : pItem->pNext = newItem;
4749 : if(nextItem != VMA_NULL)
4750 : {
4751 : nextItem->pPrev = newItem;
4752 : }
4753 : else
4754 : {
4755 : VMA_HEAVY_ASSERT(m_pBack == pItem);
4756 : m_pBack = newItem;
4757 : }
4758 : ++m_Count;
4759 : return newItem;
4760 : }
4761 : else
4762 : return PushFront();
4763 : }
4764 :
4765 : template<typename T>
4766 : VmaListItem<T>* VmaRawList<T>::InsertBefore(ItemType* pItem, const T& value)
4767 : {
4768 : ItemType* const newItem = InsertBefore(pItem);
4769 : newItem->Value = value;
4770 : return newItem;
4771 : }
4772 :
4773 : template<typename T>
4774 : VmaListItem<T>* VmaRawList<T>::InsertAfter(ItemType* pItem, const T& value)
4775 : {
4776 : ItemType* const newItem = InsertAfter(pItem);
4777 : newItem->Value = value;
4778 : return newItem;
4779 : }
4780 : #endif // _VMA_RAW_LIST_FUNCTIONS
4781 : #endif // _VMA_RAW_LIST
4782 :
4783 : #ifndef _VMA_LIST
4784 : template<typename T, typename AllocatorT>
4785 : class VmaList
4786 : {
4787 : VMA_CLASS_NO_COPY(VmaList)
4788 : public:
4789 : class reverse_iterator;
4790 : class const_iterator;
4791 : class const_reverse_iterator;
4792 :
4793 : class iterator
4794 : {
4795 : friend class const_iterator;
4796 : friend class VmaList<T, AllocatorT>;
4797 : public:
4798 0 : iterator() : m_pList(VMA_NULL), m_pItem(VMA_NULL) {}
4799 : iterator(const reverse_iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4800 :
4801 : T& operator*() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return m_pItem->Value; }
4802 : T* operator->() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return &m_pItem->Value; }
4803 :
4804 : bool operator==(const iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem == rhs.m_pItem; }
4805 : bool operator!=(const iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem != rhs.m_pItem; }
4806 :
4807 : iterator operator++(int) { iterator result = *this; ++*this; return result; }
4808 : iterator operator--(int) { iterator result = *this; --*this; return result; }
4809 :
4810 : iterator& operator++() { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); m_pItem = m_pItem->pNext; return *this; }
4811 : iterator& operator--();
4812 :
4813 : private:
4814 : VmaRawList<T>* m_pList;
4815 : VmaListItem<T>* m_pItem;
4816 :
4817 : iterator(VmaRawList<T>* pList, VmaListItem<T>* pItem) : m_pList(pList), m_pItem(pItem) {}
4818 : };
4819 : class reverse_iterator
4820 : {
4821 : friend class const_reverse_iterator;
4822 : friend class VmaList<T, AllocatorT>;
4823 : public:
4824 : reverse_iterator() : m_pList(VMA_NULL), m_pItem(VMA_NULL) {}
4825 : reverse_iterator(const iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4826 :
4827 : T& operator*() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return m_pItem->Value; }
4828 : T* operator->() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return &m_pItem->Value; }
4829 :
4830 : bool operator==(const reverse_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem == rhs.m_pItem; }
4831 : bool operator!=(const reverse_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem != rhs.m_pItem; }
4832 :
4833 : reverse_iterator operator++(int) { reverse_iterator result = *this; ++* this; return result; }
4834 : reverse_iterator operator--(int) { reverse_iterator result = *this; --* this; return result; }
4835 :
4836 : reverse_iterator& operator++() { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); m_pItem = m_pItem->pPrev; return *this; }
4837 : reverse_iterator& operator--();
4838 :
4839 : private:
4840 : VmaRawList<T>* m_pList;
4841 : VmaListItem<T>* m_pItem;
4842 :
4843 : reverse_iterator(VmaRawList<T>* pList, VmaListItem<T>* pItem) : m_pList(pList), m_pItem(pItem) {}
4844 : };
4845 : class const_iterator
4846 : {
4847 : friend class VmaList<T, AllocatorT>;
4848 : public:
4849 : const_iterator() : m_pList(VMA_NULL), m_pItem(VMA_NULL) {}
4850 : const_iterator(const iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4851 : const_iterator(const reverse_iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4852 :
4853 : iterator drop_const() { return { const_cast<VmaRawList<T>*>(m_pList), const_cast<VmaListItem<T>*>(m_pItem) }; }
4854 :
4855 : const T& operator*() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return m_pItem->Value; }
4856 : const T* operator->() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return &m_pItem->Value; }
4857 :
4858 : bool operator==(const const_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem == rhs.m_pItem; }
4859 : bool operator!=(const const_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem != rhs.m_pItem; }
4860 :
4861 : const_iterator operator++(int) { const_iterator result = *this; ++* this; return result; }
4862 : const_iterator operator--(int) { const_iterator result = *this; --* this; return result; }
4863 :
4864 : const_iterator& operator++() { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); m_pItem = m_pItem->pNext; return *this; }
4865 : const_iterator& operator--();
4866 :
4867 : private:
4868 : const VmaRawList<T>* m_pList;
4869 : const VmaListItem<T>* m_pItem;
4870 :
4871 : const_iterator(const VmaRawList<T>* pList, const VmaListItem<T>* pItem) : m_pList(pList), m_pItem(pItem) {}
4872 : };
4873 : class const_reverse_iterator
4874 : {
4875 : friend class VmaList<T, AllocatorT>;
4876 : public:
4877 : const_reverse_iterator() : m_pList(VMA_NULL), m_pItem(VMA_NULL) {}
4878 : const_reverse_iterator(const reverse_iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4879 : const_reverse_iterator(const iterator& src) : m_pList(src.m_pList), m_pItem(src.m_pItem) {}
4880 :
4881 : reverse_iterator drop_const() { return { const_cast<VmaRawList<T>*>(m_pList), const_cast<VmaListItem<T>*>(m_pItem) }; }
4882 :
4883 : const T& operator*() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return m_pItem->Value; }
4884 : const T* operator->() const { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); return &m_pItem->Value; }
4885 :
4886 : bool operator==(const const_reverse_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem == rhs.m_pItem; }
4887 : bool operator!=(const const_reverse_iterator& rhs) const { VMA_HEAVY_ASSERT(m_pList == rhs.m_pList); return m_pItem != rhs.m_pItem; }
4888 :
4889 : const_reverse_iterator operator++(int) { const_reverse_iterator result = *this; ++* this; return result; }
4890 : const_reverse_iterator operator--(int) { const_reverse_iterator result = *this; --* this; return result; }
4891 :
4892 : const_reverse_iterator& operator++() { VMA_HEAVY_ASSERT(m_pItem != VMA_NULL); m_pItem = m_pItem->pPrev; return *this; }
4893 : const_reverse_iterator& operator--();
4894 :
4895 : private:
4896 : const VmaRawList<T>* m_pList;
4897 : const VmaListItem<T>* m_pItem;
4898 :
4899 : const_reverse_iterator(const VmaRawList<T>* pList, const VmaListItem<T>* pItem) : m_pList(pList), m_pItem(pItem) {}
4900 : };
4901 :
4902 : VmaList(const AllocatorT& allocator) : m_RawList(allocator.m_pCallbacks) {}
4903 :
4904 : bool empty() const { return m_RawList.IsEmpty(); }
4905 : size_t size() const { return m_RawList.GetCount(); }
4906 :
4907 : iterator begin() { return iterator(&m_RawList, m_RawList.Front()); }
4908 : iterator end() { return iterator(&m_RawList, VMA_NULL); }
4909 :
4910 : const_iterator cbegin() const { return const_iterator(&m_RawList, m_RawList.Front()); }
4911 : const_iterator cend() const { return const_iterator(&m_RawList, VMA_NULL); }
4912 :
4913 : const_iterator begin() const { return cbegin(); }
4914 : const_iterator end() const { return cend(); }
4915 :
4916 : reverse_iterator rbegin() { return reverse_iterator(&m_RawList, m_RawList.Back()); }
4917 : reverse_iterator rend() { return reverse_iterator(&m_RawList, VMA_NULL); }
4918 :
4919 : const_reverse_iterator crbegin() const { return const_reverse_iterator(&m_RawList, m_RawList.Back()); }
4920 : const_reverse_iterator crend() const { return const_reverse_iterator(&m_RawList, VMA_NULL); }
4921 :
4922 : const_reverse_iterator rbegin() const { return crbegin(); }
4923 : const_reverse_iterator rend() const { return crend(); }
4924 :
4925 : void push_back(const T& value) { m_RawList.PushBack(value); }
4926 : iterator insert(iterator it, const T& value) { return iterator(&m_RawList, m_RawList.InsertBefore(it.m_pItem, value)); }
4927 :
4928 : void clear() { m_RawList.Clear(); }
4929 : void erase(iterator it) { m_RawList.Remove(it.m_pItem); }
4930 :
4931 : private:
4932 : VmaRawList<T> m_RawList;
4933 : };
4934 :
4935 : #ifndef _VMA_LIST_FUNCTIONS
4936 : template<typename T, typename AllocatorT>
4937 : typename VmaList<T, AllocatorT>::iterator& VmaList<T, AllocatorT>::iterator::operator--()
4938 : {
4939 : if (m_pItem != VMA_NULL)
4940 : {
4941 : m_pItem = m_pItem->pPrev;
4942 : }
4943 : else
4944 : {
4945 : VMA_HEAVY_ASSERT(!m_pList->IsEmpty());
4946 : m_pItem = m_pList->Back();
4947 : }
4948 : return *this;
4949 : }
4950 :
4951 : template<typename T, typename AllocatorT>
4952 : typename VmaList<T, AllocatorT>::reverse_iterator& VmaList<T, AllocatorT>::reverse_iterator::operator--()
4953 : {
4954 : if (m_pItem != VMA_NULL)
4955 : {
4956 : m_pItem = m_pItem->pNext;
4957 : }
4958 : else
4959 : {
4960 : VMA_HEAVY_ASSERT(!m_pList->IsEmpty());
4961 : m_pItem = m_pList->Front();
4962 : }
4963 : return *this;
4964 : }
4965 :
4966 : template<typename T, typename AllocatorT>
4967 : typename VmaList<T, AllocatorT>::const_iterator& VmaList<T, AllocatorT>::const_iterator::operator--()
4968 : {
4969 : if (m_pItem != VMA_NULL)
4970 : {
4971 : m_pItem = m_pItem->pPrev;
4972 : }
4973 : else
4974 : {
4975 : VMA_HEAVY_ASSERT(!m_pList->IsEmpty());
4976 : m_pItem = m_pList->Back();
4977 : }
4978 : return *this;
4979 : }
4980 :
4981 : template<typename T, typename AllocatorT>
4982 : typename VmaList<T, AllocatorT>::const_reverse_iterator& VmaList<T, AllocatorT>::const_reverse_iterator::operator--()
4983 : {
4984 : if (m_pItem != VMA_NULL)
4985 : {
4986 : m_pItem = m_pItem->pNext;
4987 : }
4988 : else
4989 : {
4990 : VMA_HEAVY_ASSERT(!m_pList->IsEmpty());
4991 : m_pItem = m_pList->Back();
4992 : }
4993 : return *this;
4994 : }
4995 : #endif // _VMA_LIST_FUNCTIONS
4996 : #endif // _VMA_LIST
4997 :
4998 : #ifndef _VMA_INTRUSIVE_LINKED_LIST
4999 : /*
5000 : Expected interface of ItemTypeTraits:
5001 : struct MyItemTypeTraits
5002 : {
5003 : typedef MyItem ItemType;
5004 : static ItemType* GetPrev(const ItemType* item) { return item->myPrevPtr; }
5005 : static ItemType* GetNext(const ItemType* item) { return item->myNextPtr; }
5006 : static ItemType*& AccessPrev(ItemType* item) { return item->myPrevPtr; }
5007 : static ItemType*& AccessNext(ItemType* item) { return item->myNextPtr; }
5008 : };
5009 : */
5010 : template<typename ItemTypeTraits>
5011 : class VmaIntrusiveLinkedList
5012 : {
5013 : public:
5014 : typedef typename ItemTypeTraits::ItemType ItemType;
5015 : static ItemType* GetPrev(const ItemType* item) { return ItemTypeTraits::GetPrev(item); }
5016 0 : static ItemType* GetNext(const ItemType* item) { return ItemTypeTraits::GetNext(item); }
5017 :
5018 : // Movable, not copyable.
5019 0 : VmaIntrusiveLinkedList() = default;
5020 : VmaIntrusiveLinkedList(VmaIntrusiveLinkedList && src);
5021 : VmaIntrusiveLinkedList(const VmaIntrusiveLinkedList&) = delete;
5022 : VmaIntrusiveLinkedList& operator=(VmaIntrusiveLinkedList&& src);
5023 : VmaIntrusiveLinkedList& operator=(const VmaIntrusiveLinkedList&) = delete;
5024 0 : ~VmaIntrusiveLinkedList() { VMA_HEAVY_ASSERT(IsEmpty()); }
5025 :
5026 0 : size_t GetCount() const { return m_Count; }
5027 0 : bool IsEmpty() const { return m_Count == 0; }
5028 0 : ItemType* Front() { return m_Front; }
5029 : ItemType* Back() { return m_Back; }
5030 : const ItemType* Front() const { return m_Front; }
5031 : const ItemType* Back() const { return m_Back; }
5032 :
5033 : void PushBack(ItemType* item);
5034 : void PushFront(ItemType* item);
5035 : ItemType* PopBack();
5036 : ItemType* PopFront();
5037 :
5038 : // MyItem can be null - it means PushBack.
5039 : void InsertBefore(ItemType* existingItem, ItemType* newItem);
5040 : // MyItem can be null - it means PushFront.
5041 : void InsertAfter(ItemType* existingItem, ItemType* newItem);
5042 : void Remove(ItemType* item);
5043 : void RemoveAll();
5044 :
5045 : private:
5046 : ItemType* m_Front = VMA_NULL;
5047 : ItemType* m_Back = VMA_NULL;
5048 : size_t m_Count = 0;
5049 : };
5050 :
5051 : #ifndef _VMA_INTRUSIVE_LINKED_LIST_FUNCTIONS
5052 : template<typename ItemTypeTraits>
5053 : VmaIntrusiveLinkedList<ItemTypeTraits>::VmaIntrusiveLinkedList(VmaIntrusiveLinkedList&& src)
5054 : : m_Front(src.m_Front), m_Back(src.m_Back), m_Count(src.m_Count)
5055 : {
5056 : src.m_Front = src.m_Back = VMA_NULL;
5057 : src.m_Count = 0;
5058 : }
5059 :
5060 : template<typename ItemTypeTraits>
5061 : VmaIntrusiveLinkedList<ItemTypeTraits>& VmaIntrusiveLinkedList<ItemTypeTraits>::operator=(VmaIntrusiveLinkedList&& src)
5062 : {
5063 : if (&src != this)
5064 : {
5065 : VMA_HEAVY_ASSERT(IsEmpty());
5066 : m_Front = src.m_Front;
5067 : m_Back = src.m_Back;
5068 : m_Count = src.m_Count;
5069 : src.m_Front = src.m_Back = VMA_NULL;
5070 : src.m_Count = 0;
5071 : }
5072 : return *this;
5073 : }
5074 :
5075 : template<typename ItemTypeTraits>
5076 0 : void VmaIntrusiveLinkedList<ItemTypeTraits>::PushBack(ItemType* item)
5077 : {
5078 0 : VMA_HEAVY_ASSERT(ItemTypeTraits::GetPrev(item) == VMA_NULL && ItemTypeTraits::GetNext(item) == VMA_NULL);
5079 0 : if (IsEmpty())
5080 : {
5081 0 : m_Front = item;
5082 0 : m_Back = item;
5083 0 : m_Count = 1;
5084 : }
5085 : else
5086 : {
5087 0 : ItemTypeTraits::AccessPrev(item) = m_Back;
5088 0 : ItemTypeTraits::AccessNext(m_Back) = item;
5089 0 : m_Back = item;
5090 0 : ++m_Count;
5091 : }
5092 0 : }
5093 :
5094 : template<typename ItemTypeTraits>
5095 : void VmaIntrusiveLinkedList<ItemTypeTraits>::PushFront(ItemType* item)
5096 : {
5097 : VMA_HEAVY_ASSERT(ItemTypeTraits::GetPrev(item) == VMA_NULL && ItemTypeTraits::GetNext(item) == VMA_NULL);
5098 : if (IsEmpty())
5099 : {
5100 : m_Front = item;
5101 : m_Back = item;
5102 : m_Count = 1;
5103 : }
5104 : else
5105 : {
5106 : ItemTypeTraits::AccessNext(item) = m_Front;
5107 : ItemTypeTraits::AccessPrev(m_Front) = item;
5108 : m_Front = item;
5109 : ++m_Count;
5110 : }
5111 : }
5112 :
5113 : template<typename ItemTypeTraits>
5114 : typename VmaIntrusiveLinkedList<ItemTypeTraits>::ItemType* VmaIntrusiveLinkedList<ItemTypeTraits>::PopBack()
5115 : {
5116 : VMA_HEAVY_ASSERT(m_Count > 0);
5117 : ItemType* const backItem = m_Back;
5118 : ItemType* const prevItem = ItemTypeTraits::GetPrev(backItem);
5119 : if (prevItem != VMA_NULL)
5120 : {
5121 : ItemTypeTraits::AccessNext(prevItem) = VMA_NULL;
5122 : }
5123 : m_Back = prevItem;
5124 : --m_Count;
5125 : ItemTypeTraits::AccessPrev(backItem) = VMA_NULL;
5126 : ItemTypeTraits::AccessNext(backItem) = VMA_NULL;
5127 : return backItem;
5128 : }
5129 :
5130 : template<typename ItemTypeTraits>
5131 : typename VmaIntrusiveLinkedList<ItemTypeTraits>::ItemType* VmaIntrusiveLinkedList<ItemTypeTraits>::PopFront()
5132 : {
5133 : VMA_HEAVY_ASSERT(m_Count > 0);
5134 : ItemType* const frontItem = m_Front;
5135 : ItemType* const nextItem = ItemTypeTraits::GetNext(frontItem);
5136 : if (nextItem != VMA_NULL)
5137 : {
5138 : ItemTypeTraits::AccessPrev(nextItem) = VMA_NULL;
5139 : }
5140 : m_Front = nextItem;
5141 : --m_Count;
5142 : ItemTypeTraits::AccessPrev(frontItem) = VMA_NULL;
5143 : ItemTypeTraits::AccessNext(frontItem) = VMA_NULL;
5144 : return frontItem;
5145 : }
5146 :
5147 : template<typename ItemTypeTraits>
5148 : void VmaIntrusiveLinkedList<ItemTypeTraits>::InsertBefore(ItemType* existingItem, ItemType* newItem)
5149 : {
5150 : VMA_HEAVY_ASSERT(newItem != VMA_NULL && ItemTypeTraits::GetPrev(newItem) == VMA_NULL && ItemTypeTraits::GetNext(newItem) == VMA_NULL);
5151 : if (existingItem != VMA_NULL)
5152 : {
5153 : ItemType* const prevItem = ItemTypeTraits::GetPrev(existingItem);
5154 : ItemTypeTraits::AccessPrev(newItem) = prevItem;
5155 : ItemTypeTraits::AccessNext(newItem) = existingItem;
5156 : ItemTypeTraits::AccessPrev(existingItem) = newItem;
5157 : if (prevItem != VMA_NULL)
5158 : {
5159 : ItemTypeTraits::AccessNext(prevItem) = newItem;
5160 : }
5161 : else
5162 : {
5163 : VMA_HEAVY_ASSERT(m_Front == existingItem);
5164 : m_Front = newItem;
5165 : }
5166 : ++m_Count;
5167 : }
5168 : else
5169 : PushBack(newItem);
5170 : }
5171 :
5172 : template<typename ItemTypeTraits>
5173 : void VmaIntrusiveLinkedList<ItemTypeTraits>::InsertAfter(ItemType* existingItem, ItemType* newItem)
5174 : {
5175 : VMA_HEAVY_ASSERT(newItem != VMA_NULL && ItemTypeTraits::GetPrev(newItem) == VMA_NULL && ItemTypeTraits::GetNext(newItem) == VMA_NULL);
5176 : if (existingItem != VMA_NULL)
5177 : {
5178 : ItemType* const nextItem = ItemTypeTraits::GetNext(existingItem);
5179 : ItemTypeTraits::AccessNext(newItem) = nextItem;
5180 : ItemTypeTraits::AccessPrev(newItem) = existingItem;
5181 : ItemTypeTraits::AccessNext(existingItem) = newItem;
5182 : if (nextItem != VMA_NULL)
5183 : {
5184 : ItemTypeTraits::AccessPrev(nextItem) = newItem;
5185 : }
5186 : else
5187 : {
5188 : VMA_HEAVY_ASSERT(m_Back == existingItem);
5189 : m_Back = newItem;
5190 : }
5191 : ++m_Count;
5192 : }
5193 : else
5194 : return PushFront(newItem);
5195 : }
5196 :
5197 : template<typename ItemTypeTraits>
5198 0 : void VmaIntrusiveLinkedList<ItemTypeTraits>::Remove(ItemType* item)
5199 : {
5200 0 : VMA_HEAVY_ASSERT(item != VMA_NULL && m_Count > 0);
5201 0 : if (ItemTypeTraits::GetPrev(item) != VMA_NULL)
5202 : {
5203 0 : ItemTypeTraits::AccessNext(ItemTypeTraits::AccessPrev(item)) = ItemTypeTraits::GetNext(item);
5204 : }
5205 : else
5206 : {
5207 0 : VMA_HEAVY_ASSERT(m_Front == item);
5208 0 : m_Front = ItemTypeTraits::GetNext(item);
5209 : }
5210 :
5211 0 : if (ItemTypeTraits::GetNext(item) != VMA_NULL)
5212 : {
5213 0 : ItemTypeTraits::AccessPrev(ItemTypeTraits::AccessNext(item)) = ItemTypeTraits::GetPrev(item);
5214 : }
5215 : else
5216 : {
5217 0 : VMA_HEAVY_ASSERT(m_Back == item);
5218 0 : m_Back = ItemTypeTraits::GetPrev(item);
5219 : }
5220 0 : ItemTypeTraits::AccessPrev(item) = VMA_NULL;
5221 0 : ItemTypeTraits::AccessNext(item) = VMA_NULL;
5222 0 : --m_Count;
5223 0 : }
5224 :
5225 : template<typename ItemTypeTraits>
5226 : void VmaIntrusiveLinkedList<ItemTypeTraits>::RemoveAll()
5227 : {
5228 : if (!IsEmpty())
5229 : {
5230 : ItemType* item = m_Back;
5231 : while (item != VMA_NULL)
5232 : {
5233 : ItemType* const prevItem = ItemTypeTraits::AccessPrev(item);
5234 : ItemTypeTraits::AccessPrev(item) = VMA_NULL;
5235 : ItemTypeTraits::AccessNext(item) = VMA_NULL;
5236 : item = prevItem;
5237 : }
5238 : m_Front = VMA_NULL;
5239 : m_Back = VMA_NULL;
5240 : m_Count = 0;
5241 : }
5242 : }
5243 : #endif // _VMA_INTRUSIVE_LINKED_LIST_FUNCTIONS
5244 : #endif // _VMA_INTRUSIVE_LINKED_LIST
5245 :
5246 : // Unused in this version.
5247 : #if 0
5248 :
5249 : #ifndef _VMA_PAIR
5250 : template<typename T1, typename T2>
5251 : struct VmaPair
5252 : {
5253 : T1 first;
5254 : T2 second;
5255 :
5256 : VmaPair() : first(), second() {}
5257 : VmaPair(const T1& firstSrc, const T2& secondSrc) : first(firstSrc), second(secondSrc) {}
5258 : };
5259 :
5260 : template<typename FirstT, typename SecondT>
5261 : struct VmaPairFirstLess
5262 : {
5263 : bool operator()(const VmaPair<FirstT, SecondT>& lhs, const VmaPair<FirstT, SecondT>& rhs) const
5264 : {
5265 : return lhs.first < rhs.first;
5266 : }
5267 : bool operator()(const VmaPair<FirstT, SecondT>& lhs, const FirstT& rhsFirst) const
5268 : {
5269 : return lhs.first < rhsFirst;
5270 : }
5271 : };
5272 : #endif // _VMA_PAIR
5273 :
5274 : #ifndef _VMA_MAP
5275 : /* Class compatible with subset of interface of std::unordered_map.
5276 : KeyT, ValueT must be POD because they will be stored in VmaVector.
5277 : */
5278 : template<typename KeyT, typename ValueT>
5279 : class VmaMap
5280 : {
5281 : public:
5282 : typedef VmaPair<KeyT, ValueT> PairType;
5283 : typedef PairType* iterator;
5284 :
5285 : VmaMap(const VmaStlAllocator<PairType>& allocator) : m_Vector(allocator) {}
5286 :
5287 : iterator begin() { return m_Vector.begin(); }
5288 : iterator end() { return m_Vector.end(); }
5289 : size_t size() { return m_Vector.size(); }
5290 :
5291 : void insert(const PairType& pair);
5292 : iterator find(const KeyT& key);
5293 : void erase(iterator it);
5294 :
5295 : private:
5296 : VmaVector< PairType, VmaStlAllocator<PairType>> m_Vector;
5297 : };
5298 :
5299 : #ifndef _VMA_MAP_FUNCTIONS
5300 : template<typename KeyT, typename ValueT>
5301 : void VmaMap<KeyT, ValueT>::insert(const PairType& pair)
5302 : {
5303 : const size_t indexToInsert = VmaBinaryFindFirstNotLess(
5304 : m_Vector.data(),
5305 : m_Vector.data() + m_Vector.size(),
5306 : pair,
5307 : VmaPairFirstLess<KeyT, ValueT>()) - m_Vector.data();
5308 : VmaVectorInsert(m_Vector, indexToInsert, pair);
5309 : }
5310 :
5311 : template<typename KeyT, typename ValueT>
5312 : VmaPair<KeyT, ValueT>* VmaMap<KeyT, ValueT>::find(const KeyT& key)
5313 : {
5314 : PairType* it = VmaBinaryFindFirstNotLess(
5315 : m_Vector.data(),
5316 : m_Vector.data() + m_Vector.size(),
5317 : key,
5318 : VmaPairFirstLess<KeyT, ValueT>());
5319 : if ((it != m_Vector.end()) && (it->first == key))
5320 : {
5321 : return it;
5322 : }
5323 : else
5324 : {
5325 : return m_Vector.end();
5326 : }
5327 : }
5328 :
5329 : template<typename KeyT, typename ValueT>
5330 : void VmaMap<KeyT, ValueT>::erase(iterator it)
5331 : {
5332 : VmaVectorRemove(m_Vector, it - m_Vector.begin());
5333 : }
5334 : #endif // _VMA_MAP_FUNCTIONS
5335 : #endif // _VMA_MAP
5336 :
5337 : #endif // #if 0
5338 :
5339 : #if !defined(_VMA_STRING_BUILDER) && VMA_STATS_STRING_ENABLED
5340 : class VmaStringBuilder
5341 : {
5342 : public:
5343 0 : VmaStringBuilder(const VkAllocationCallbacks* allocationCallbacks) : m_Data(VmaStlAllocator<char>(allocationCallbacks)) {}
5344 0 : ~VmaStringBuilder() = default;
5345 :
5346 0 : size_t GetLength() const { return m_Data.size(); }
5347 0 : const char* GetData() const { return m_Data.data(); }
5348 0 : void AddNewLine() { Add('\n'); }
5349 0 : void Add(char ch) { m_Data.push_back(ch); }
5350 :
5351 : void Add(const char* pStr);
5352 : void AddNumber(uint32_t num);
5353 : void AddNumber(uint64_t num);
5354 : void AddPointer(const void* ptr);
5355 :
5356 : private:
5357 : VmaVector<char, VmaStlAllocator<char>> m_Data;
5358 : };
5359 :
5360 : #ifndef _VMA_STRING_BUILDER_FUNCTIONS
5361 0 : void VmaStringBuilder::Add(const char* pStr)
5362 : {
5363 0 : const size_t strLen = strlen(pStr);
5364 0 : if (strLen > 0)
5365 : {
5366 0 : const size_t oldCount = m_Data.size();
5367 0 : m_Data.resize(oldCount + strLen);
5368 0 : memcpy(m_Data.data() + oldCount, pStr, strLen);
5369 : }
5370 0 : }
5371 :
5372 0 : void VmaStringBuilder::AddNumber(uint32_t num)
5373 : {
5374 : char buf[11];
5375 0 : buf[10] = '\0';
5376 0 : char* p = &buf[10];
5377 0 : do
5378 : {
5379 0 : *--p = '0' + (num % 10);
5380 0 : num /= 10;
5381 0 : } while (num);
5382 0 : Add(p);
5383 0 : }
5384 :
5385 0 : void VmaStringBuilder::AddNumber(uint64_t num)
5386 : {
5387 : char buf[21];
5388 0 : buf[20] = '\0';
5389 0 : char* p = &buf[20];
5390 0 : do
5391 : {
5392 0 : *--p = '0' + (num % 10);
5393 0 : num /= 10;
5394 0 : } while (num);
5395 0 : Add(p);
5396 0 : }
5397 :
5398 0 : void VmaStringBuilder::AddPointer(const void* ptr)
5399 : {
5400 : char buf[21];
5401 0 : VmaPtrToStr(buf, sizeof(buf), ptr);
5402 0 : Add(buf);
5403 0 : }
5404 : #endif //_VMA_STRING_BUILDER_FUNCTIONS
5405 : #endif // _VMA_STRING_BUILDER
5406 :
5407 : #if !defined(_VMA_JSON_WRITER) && VMA_STATS_STRING_ENABLED
5408 : /*
5409 : Allows to conveniently build a correct JSON document to be written to the
5410 : VmaStringBuilder passed to the constructor.
5411 : */
5412 : class VmaJsonWriter
5413 : {
5414 : VMA_CLASS_NO_COPY(VmaJsonWriter)
5415 : public:
5416 : // sb - string builder to write the document to. Must remain alive for the whole lifetime of this object.
5417 : VmaJsonWriter(const VkAllocationCallbacks* pAllocationCallbacks, VmaStringBuilder& sb);
5418 : ~VmaJsonWriter();
5419 :
5420 : // Begins object by writing "{".
5421 : // Inside an object, you must call pairs of WriteString and a value, e.g.:
5422 : // j.BeginObject(true); j.WriteString("A"); j.WriteNumber(1); j.WriteString("B"); j.WriteNumber(2); j.EndObject();
5423 : // Will write: { "A": 1, "B": 2 }
5424 : void BeginObject(bool singleLine = false);
5425 : // Ends object by writing "}".
5426 : void EndObject();
5427 :
5428 : // Begins array by writing "[".
5429 : // Inside an array, you can write a sequence of any values.
5430 : void BeginArray(bool singleLine = false);
5431 : // Ends array by writing "[".
5432 : void EndArray();
5433 :
5434 : // Writes a string value inside "".
5435 : // pStr can contain any ANSI characters, including '"', new line etc. - they will be properly escaped.
5436 : void WriteString(const char* pStr);
5437 :
5438 : // Begins writing a string value.
5439 : // Call BeginString, ContinueString, ContinueString, ..., EndString instead of
5440 : // WriteString to conveniently build the string content incrementally, made of
5441 : // parts including numbers.
5442 : void BeginString(const char* pStr = VMA_NULL);
5443 : // Posts next part of an open string.
5444 : void ContinueString(const char* pStr);
5445 : // Posts next part of an open string. The number is converted to decimal characters.
5446 : void ContinueString(uint32_t n);
5447 : void ContinueString(uint64_t n);
5448 : void ContinueString_Size(size_t n);
5449 : // Posts next part of an open string. Pointer value is converted to characters
5450 : // using "%p" formatting - shown as hexadecimal number, e.g.: 000000081276Ad00
5451 : void ContinueString_Pointer(const void* ptr);
5452 : // Ends writing a string value by writing '"'.
5453 : void EndString(const char* pStr = VMA_NULL);
5454 :
5455 : // Writes a number value.
5456 : void WriteNumber(uint32_t n);
5457 : void WriteNumber(uint64_t n);
5458 : void WriteSize(size_t n);
5459 : // Writes a boolean value - false or true.
5460 : void WriteBool(bool b);
5461 : // Writes a null value.
5462 : void WriteNull();
5463 :
5464 : private:
5465 : enum COLLECTION_TYPE
5466 : {
5467 : COLLECTION_TYPE_OBJECT,
5468 : COLLECTION_TYPE_ARRAY,
5469 : };
5470 : struct StackItem
5471 : {
5472 : COLLECTION_TYPE type;
5473 : uint32_t valueCount;
5474 : bool singleLineMode;
5475 : };
5476 :
5477 : static const char* const INDENT;
5478 :
5479 : VmaStringBuilder& m_SB;
5480 : VmaVector< StackItem, VmaStlAllocator<StackItem> > m_Stack;
5481 : bool m_InsideString;
5482 :
5483 : // Write size_t for less than 64bits
5484 : void WriteSize(size_t n, std::integral_constant<bool, false>) { m_SB.AddNumber(static_cast<uint32_t>(n)); }
5485 : // Write size_t for 64bits
5486 0 : void WriteSize(size_t n, std::integral_constant<bool, true>) { m_SB.AddNumber(static_cast<uint64_t>(n)); }
5487 :
5488 : void BeginValue(bool isString);
5489 : void WriteIndent(bool oneLess = false);
5490 : };
5491 : const char* const VmaJsonWriter::INDENT = " ";
5492 :
5493 : #ifndef _VMA_JSON_WRITER_FUNCTIONS
5494 0 : VmaJsonWriter::VmaJsonWriter(const VkAllocationCallbacks* pAllocationCallbacks, VmaStringBuilder& sb)
5495 : : m_SB(sb),
5496 0 : m_Stack(VmaStlAllocator<StackItem>(pAllocationCallbacks)),
5497 0 : m_InsideString(false) {}
5498 :
5499 0 : VmaJsonWriter::~VmaJsonWriter()
5500 : {
5501 0 : VMA_ASSERT(!m_InsideString);
5502 0 : VMA_ASSERT(m_Stack.empty());
5503 0 : }
5504 :
5505 0 : void VmaJsonWriter::BeginObject(bool singleLine)
5506 : {
5507 0 : VMA_ASSERT(!m_InsideString);
5508 :
5509 0 : BeginValue(false);
5510 0 : m_SB.Add('{');
5511 :
5512 : StackItem item;
5513 0 : item.type = COLLECTION_TYPE_OBJECT;
5514 0 : item.valueCount = 0;
5515 0 : item.singleLineMode = singleLine;
5516 0 : m_Stack.push_back(item);
5517 0 : }
5518 :
5519 0 : void VmaJsonWriter::EndObject()
5520 : {
5521 0 : VMA_ASSERT(!m_InsideString);
5522 :
5523 0 : WriteIndent(true);
5524 0 : m_SB.Add('}');
5525 :
5526 0 : VMA_ASSERT(!m_Stack.empty() && m_Stack.back().type == COLLECTION_TYPE_OBJECT);
5527 0 : m_Stack.pop_back();
5528 0 : }
5529 :
5530 0 : void VmaJsonWriter::BeginArray(bool singleLine)
5531 : {
5532 0 : VMA_ASSERT(!m_InsideString);
5533 :
5534 0 : BeginValue(false);
5535 0 : m_SB.Add('[');
5536 :
5537 : StackItem item;
5538 0 : item.type = COLLECTION_TYPE_ARRAY;
5539 0 : item.valueCount = 0;
5540 0 : item.singleLineMode = singleLine;
5541 0 : m_Stack.push_back(item);
5542 0 : }
5543 :
5544 0 : void VmaJsonWriter::EndArray()
5545 : {
5546 0 : VMA_ASSERT(!m_InsideString);
5547 :
5548 0 : WriteIndent(true);
5549 0 : m_SB.Add(']');
5550 :
5551 0 : VMA_ASSERT(!m_Stack.empty() && m_Stack.back().type == COLLECTION_TYPE_ARRAY);
5552 0 : m_Stack.pop_back();
5553 0 : }
5554 :
5555 0 : void VmaJsonWriter::WriteString(const char* pStr)
5556 : {
5557 0 : BeginString(pStr);
5558 0 : EndString();
5559 0 : }
5560 :
5561 0 : void VmaJsonWriter::BeginString(const char* pStr)
5562 : {
5563 0 : VMA_ASSERT(!m_InsideString);
5564 :
5565 0 : BeginValue(true);
5566 0 : m_SB.Add('"');
5567 0 : m_InsideString = true;
5568 0 : if (pStr != VMA_NULL && pStr[0] != '\0')
5569 : {
5570 0 : ContinueString(pStr);
5571 : }
5572 0 : }
5573 :
5574 0 : void VmaJsonWriter::ContinueString(const char* pStr)
5575 : {
5576 0 : VMA_ASSERT(m_InsideString);
5577 :
5578 0 : const size_t strLen = strlen(pStr);
5579 0 : for (size_t i = 0; i < strLen; ++i)
5580 : {
5581 0 : char ch = pStr[i];
5582 0 : if (ch == '\\')
5583 : {
5584 0 : m_SB.Add("\\\\");
5585 : }
5586 0 : else if (ch == '"')
5587 : {
5588 0 : m_SB.Add("\\\"");
5589 : }
5590 0 : else if (ch >= 32)
5591 : {
5592 0 : m_SB.Add(ch);
5593 : }
5594 0 : else switch (ch)
5595 : {
5596 0 : case '\b':
5597 0 : m_SB.Add("\\b");
5598 0 : break;
5599 0 : case '\f':
5600 0 : m_SB.Add("\\f");
5601 0 : break;
5602 0 : case '\n':
5603 0 : m_SB.Add("\\n");
5604 0 : break;
5605 0 : case '\r':
5606 0 : m_SB.Add("\\r");
5607 0 : break;
5608 0 : case '\t':
5609 0 : m_SB.Add("\\t");
5610 0 : break;
5611 0 : default:
5612 0 : VMA_ASSERT(0 && "Character not currently supported.");
5613 0 : break;
5614 : }
5615 : }
5616 0 : }
5617 :
5618 0 : void VmaJsonWriter::ContinueString(uint32_t n)
5619 : {
5620 0 : VMA_ASSERT(m_InsideString);
5621 0 : m_SB.AddNumber(n);
5622 0 : }
5623 :
5624 0 : void VmaJsonWriter::ContinueString(uint64_t n)
5625 : {
5626 0 : VMA_ASSERT(m_InsideString);
5627 0 : m_SB.AddNumber(n);
5628 0 : }
5629 :
5630 0 : void VmaJsonWriter::ContinueString_Size(size_t n)
5631 : {
5632 0 : VMA_ASSERT(m_InsideString);
5633 : // Fix for AppleClang incorrect type casting
5634 : // TODO: Change to if constexpr when C++17 used as minimal standard
5635 0 : WriteSize(n, std::is_same<size_t, uint64_t>{});
5636 0 : }
5637 :
5638 0 : void VmaJsonWriter::ContinueString_Pointer(const void* ptr)
5639 : {
5640 0 : VMA_ASSERT(m_InsideString);
5641 0 : m_SB.AddPointer(ptr);
5642 0 : }
5643 :
5644 0 : void VmaJsonWriter::EndString(const char* pStr)
5645 : {
5646 0 : VMA_ASSERT(m_InsideString);
5647 0 : if (pStr != VMA_NULL && pStr[0] != '\0')
5648 : {
5649 0 : ContinueString(pStr);
5650 : }
5651 0 : m_SB.Add('"');
5652 0 : m_InsideString = false;
5653 0 : }
5654 :
5655 0 : void VmaJsonWriter::WriteNumber(uint32_t n)
5656 : {
5657 0 : VMA_ASSERT(!m_InsideString);
5658 0 : BeginValue(false);
5659 0 : m_SB.AddNumber(n);
5660 0 : }
5661 :
5662 0 : void VmaJsonWriter::WriteNumber(uint64_t n)
5663 : {
5664 0 : VMA_ASSERT(!m_InsideString);
5665 0 : BeginValue(false);
5666 0 : m_SB.AddNumber(n);
5667 0 : }
5668 :
5669 0 : void VmaJsonWriter::WriteSize(size_t n)
5670 : {
5671 0 : VMA_ASSERT(!m_InsideString);
5672 0 : BeginValue(false);
5673 : // Fix for AppleClang incorrect type casting
5674 : // TODO: Change to if constexpr when C++17 used as minimal standard
5675 0 : WriteSize(n, std::is_same<size_t, uint64_t>{});
5676 0 : }
5677 :
5678 0 : void VmaJsonWriter::WriteBool(bool b)
5679 : {
5680 0 : VMA_ASSERT(!m_InsideString);
5681 0 : BeginValue(false);
5682 0 : m_SB.Add(b ? "true" : "false");
5683 0 : }
5684 :
5685 0 : void VmaJsonWriter::WriteNull()
5686 : {
5687 0 : VMA_ASSERT(!m_InsideString);
5688 0 : BeginValue(false);
5689 0 : m_SB.Add("null");
5690 0 : }
5691 :
5692 0 : void VmaJsonWriter::BeginValue(bool isString)
5693 : {
5694 0 : if (!m_Stack.empty())
5695 : {
5696 0 : StackItem& currItem = m_Stack.back();
5697 0 : if (currItem.type == COLLECTION_TYPE_OBJECT &&
5698 0 : currItem.valueCount % 2 == 0)
5699 : {
5700 0 : VMA_ASSERT(isString);
5701 : }
5702 :
5703 0 : if (currItem.type == COLLECTION_TYPE_OBJECT &&
5704 0 : currItem.valueCount % 2 != 0)
5705 : {
5706 0 : m_SB.Add(": ");
5707 : }
5708 0 : else if (currItem.valueCount > 0)
5709 : {
5710 0 : m_SB.Add(", ");
5711 0 : WriteIndent();
5712 : }
5713 : else
5714 : {
5715 0 : WriteIndent();
5716 : }
5717 0 : ++currItem.valueCount;
5718 : }
5719 0 : }
5720 :
5721 0 : void VmaJsonWriter::WriteIndent(bool oneLess)
5722 : {
5723 0 : if (!m_Stack.empty() && !m_Stack.back().singleLineMode)
5724 : {
5725 0 : m_SB.AddNewLine();
5726 :
5727 0 : size_t count = m_Stack.size();
5728 0 : if (count > 0 && oneLess)
5729 : {
5730 0 : --count;
5731 : }
5732 0 : for (size_t i = 0; i < count; ++i)
5733 : {
5734 0 : m_SB.Add(INDENT);
5735 : }
5736 : }
5737 0 : }
5738 : #endif // _VMA_JSON_WRITER_FUNCTIONS
5739 :
5740 0 : static void VmaPrintDetailedStatistics(VmaJsonWriter& json, const VmaDetailedStatistics& stat)
5741 : {
5742 0 : json.BeginObject();
5743 :
5744 0 : json.WriteString("BlockCount");
5745 0 : json.WriteNumber(stat.statistics.blockCount);
5746 0 : json.WriteString("BlockBytes");
5747 0 : json.WriteNumber(stat.statistics.blockBytes);
5748 0 : json.WriteString("AllocationCount");
5749 0 : json.WriteNumber(stat.statistics.allocationCount);
5750 0 : json.WriteString("AllocationBytes");
5751 0 : json.WriteNumber(stat.statistics.allocationBytes);
5752 0 : json.WriteString("UnusedRangeCount");
5753 0 : json.WriteNumber(stat.unusedRangeCount);
5754 :
5755 0 : if (stat.statistics.allocationCount > 1)
5756 : {
5757 0 : json.WriteString("AllocationSizeMin");
5758 0 : json.WriteNumber(stat.allocationSizeMin);
5759 0 : json.WriteString("AllocationSizeMax");
5760 0 : json.WriteNumber(stat.allocationSizeMax);
5761 : }
5762 0 : if (stat.unusedRangeCount > 1)
5763 : {
5764 0 : json.WriteString("UnusedRangeSizeMin");
5765 0 : json.WriteNumber(stat.unusedRangeSizeMin);
5766 0 : json.WriteString("UnusedRangeSizeMax");
5767 0 : json.WriteNumber(stat.unusedRangeSizeMax);
5768 : }
5769 0 : json.EndObject();
5770 0 : }
5771 : #endif // _VMA_JSON_WRITER
5772 :
5773 : #ifndef _VMA_MAPPING_HYSTERESIS
5774 :
5775 : class VmaMappingHysteresis
5776 : {
5777 : VMA_CLASS_NO_COPY(VmaMappingHysteresis)
5778 : public:
5779 0 : VmaMappingHysteresis() = default;
5780 :
5781 0 : uint32_t GetExtraMapping() const { return m_ExtraMapping; }
5782 :
5783 : // Call when Map was called.
5784 : // Returns true if switched to extra +1 mapping reference count.
5785 0 : bool PostMap()
5786 : {
5787 : #if VMA_MAPPING_HYSTERESIS_ENABLED
5788 0 : if(m_ExtraMapping == 0)
5789 : {
5790 0 : ++m_MajorCounter;
5791 0 : if(m_MajorCounter >= COUNTER_MIN_EXTRA_MAPPING)
5792 : {
5793 0 : m_ExtraMapping = 1;
5794 0 : m_MajorCounter = 0;
5795 0 : m_MinorCounter = 0;
5796 0 : return true;
5797 : }
5798 : }
5799 : else // m_ExtraMapping == 1
5800 0 : PostMinorCounter();
5801 : #endif // #if VMA_MAPPING_HYSTERESIS_ENABLED
5802 0 : return false;
5803 : }
5804 :
5805 : // Call when Unmap was called.
5806 0 : void PostUnmap()
5807 : {
5808 : #if VMA_MAPPING_HYSTERESIS_ENABLED
5809 0 : if(m_ExtraMapping == 0)
5810 0 : ++m_MajorCounter;
5811 : else // m_ExtraMapping == 1
5812 0 : PostMinorCounter();
5813 : #endif // #if VMA_MAPPING_HYSTERESIS_ENABLED
5814 0 : }
5815 :
5816 : // Call when allocation was made from the memory block.
5817 0 : void PostAlloc()
5818 : {
5819 : #if VMA_MAPPING_HYSTERESIS_ENABLED
5820 0 : if(m_ExtraMapping == 1)
5821 0 : ++m_MajorCounter;
5822 : else // m_ExtraMapping == 0
5823 0 : PostMinorCounter();
5824 : #endif // #if VMA_MAPPING_HYSTERESIS_ENABLED
5825 0 : }
5826 :
5827 : // Call when allocation was freed from the memory block.
5828 : // Returns true if switched to extra -1 mapping reference count.
5829 0 : bool PostFree()
5830 : {
5831 : #if VMA_MAPPING_HYSTERESIS_ENABLED
5832 0 : if(m_ExtraMapping == 1)
5833 : {
5834 0 : ++m_MajorCounter;
5835 0 : if(m_MajorCounter >= COUNTER_MIN_EXTRA_MAPPING &&
5836 0 : m_MajorCounter > m_MinorCounter + 1)
5837 : {
5838 0 : m_ExtraMapping = 0;
5839 0 : m_MajorCounter = 0;
5840 0 : m_MinorCounter = 0;
5841 0 : return true;
5842 : }
5843 : }
5844 : else // m_ExtraMapping == 0
5845 0 : PostMinorCounter();
5846 : #endif // #if VMA_MAPPING_HYSTERESIS_ENABLED
5847 0 : return false;
5848 : }
5849 :
5850 : private:
5851 : static const int32_t COUNTER_MIN_EXTRA_MAPPING = 7;
5852 :
5853 : uint32_t m_MinorCounter = 0;
5854 : uint32_t m_MajorCounter = 0;
5855 : uint32_t m_ExtraMapping = 0; // 0 or 1.
5856 :
5857 0 : void PostMinorCounter()
5858 : {
5859 0 : if(m_MinorCounter < m_MajorCounter)
5860 : {
5861 0 : ++m_MinorCounter;
5862 : }
5863 0 : else if(m_MajorCounter > 0)
5864 : {
5865 0 : --m_MajorCounter;
5866 0 : --m_MinorCounter;
5867 : }
5868 0 : }
5869 : };
5870 :
5871 : #endif // _VMA_MAPPING_HYSTERESIS
5872 :
5873 : #ifndef _VMA_DEVICE_MEMORY_BLOCK
5874 : /*
5875 : Represents a single block of device memory (`VkDeviceMemory`) with all the
5876 : data about its regions (aka suballocations, #VmaAllocation), assigned and free.
5877 :
5878 : Thread-safety:
5879 : - Access to m_pMetadata must be externally synchronized.
5880 : - Map, Unmap, Bind* are synchronized internally.
5881 : */
5882 : class VmaDeviceMemoryBlock
5883 : {
5884 : VMA_CLASS_NO_COPY(VmaDeviceMemoryBlock)
5885 : public:
5886 : VmaBlockMetadata* m_pMetadata;
5887 :
5888 : VmaDeviceMemoryBlock(VmaAllocator hAllocator);
5889 : ~VmaDeviceMemoryBlock();
5890 :
5891 : // Always call after construction.
5892 : void Init(
5893 : VmaAllocator hAllocator,
5894 : VmaPool hParentPool,
5895 : uint32_t newMemoryTypeIndex,
5896 : VkDeviceMemory newMemory,
5897 : VkDeviceSize newSize,
5898 : uint32_t id,
5899 : uint32_t algorithm,
5900 : VkDeviceSize bufferImageGranularity);
5901 : // Always call before destruction.
5902 : void Destroy(VmaAllocator allocator);
5903 :
5904 0 : VmaPool GetParentPool() const { return m_hParentPool; }
5905 0 : VkDeviceMemory GetDeviceMemory() const { return m_hMemory; }
5906 : uint32_t GetMemoryTypeIndex() const { return m_MemoryTypeIndex; }
5907 0 : uint32_t GetId() const { return m_Id; }
5908 0 : void* GetMappedData() const { return m_pMappedData; }
5909 0 : uint32_t GetMapRefCount() const { return m_MapCount; }
5910 :
5911 : // Call when allocation/free was made from m_pMetadata.
5912 : // Used for m_MappingHysteresis.
5913 0 : void PostAlloc() { m_MappingHysteresis.PostAlloc(); }
5914 : void PostFree(VmaAllocator hAllocator);
5915 :
5916 : // Validates all data structures inside this object. If not valid, returns false.
5917 : bool Validate() const;
5918 : VkResult CheckCorruption(VmaAllocator hAllocator);
5919 :
5920 : // ppData can be null.
5921 : VkResult Map(VmaAllocator hAllocator, uint32_t count, void** ppData);
5922 : void Unmap(VmaAllocator hAllocator, uint32_t count);
5923 :
5924 : VkResult WriteMagicValueAfterAllocation(VmaAllocator hAllocator, VkDeviceSize allocOffset, VkDeviceSize allocSize);
5925 : VkResult ValidateMagicValueAfterAllocation(VmaAllocator hAllocator, VkDeviceSize allocOffset, VkDeviceSize allocSize);
5926 :
5927 : VkResult BindBufferMemory(
5928 : const VmaAllocator hAllocator,
5929 : const VmaAllocation hAllocation,
5930 : VkDeviceSize allocationLocalOffset,
5931 : VkBuffer hBuffer,
5932 : const void* pNext);
5933 : VkResult BindImageMemory(
5934 : const VmaAllocator hAllocator,
5935 : const VmaAllocation hAllocation,
5936 : VkDeviceSize allocationLocalOffset,
5937 : VkImage hImage,
5938 : const void* pNext);
5939 :
5940 : private:
5941 : VmaPool m_hParentPool; // VK_NULL_HANDLE if not belongs to custom pool.
5942 : uint32_t m_MemoryTypeIndex;
5943 : uint32_t m_Id;
5944 : VkDeviceMemory m_hMemory;
5945 :
5946 : /*
5947 : Protects access to m_hMemory so it is not used by multiple threads simultaneously, e.g. vkMapMemory, vkBindBufferMemory.
5948 : Also protects m_MapCount, m_pMappedData.
5949 : Allocations, deallocations, any change in m_pMetadata is protected by parent's VmaBlockVector::m_Mutex.
5950 : */
5951 : VMA_MUTEX m_MapAndBindMutex;
5952 : VmaMappingHysteresis m_MappingHysteresis;
5953 : uint32_t m_MapCount;
5954 : void* m_pMappedData;
5955 : };
5956 : #endif // _VMA_DEVICE_MEMORY_BLOCK
5957 :
5958 : #ifndef _VMA_ALLOCATION_T
5959 : struct VmaAllocation_T
5960 : {
5961 : friend struct VmaDedicatedAllocationListItemTraits;
5962 :
5963 : enum FLAGS
5964 : {
5965 : FLAG_PERSISTENT_MAP = 0x01,
5966 : FLAG_MAPPING_ALLOWED = 0x02,
5967 : };
5968 :
5969 : public:
5970 : enum ALLOCATION_TYPE
5971 : {
5972 : ALLOCATION_TYPE_NONE,
5973 : ALLOCATION_TYPE_BLOCK,
5974 : ALLOCATION_TYPE_DEDICATED,
5975 : };
5976 :
5977 : // This struct is allocated using VmaPoolAllocator.
5978 : VmaAllocation_T(bool mappingAllowed);
5979 : ~VmaAllocation_T();
5980 :
5981 : void InitBlockAllocation(
5982 : VmaDeviceMemoryBlock* block,
5983 : VmaAllocHandle allocHandle,
5984 : VkDeviceSize alignment,
5985 : VkDeviceSize size,
5986 : uint32_t memoryTypeIndex,
5987 : VmaSuballocationType suballocationType,
5988 : bool mapped);
5989 : // pMappedData not null means allocation is created with MAPPED flag.
5990 : void InitDedicatedAllocation(
5991 : VmaPool hParentPool,
5992 : uint32_t memoryTypeIndex,
5993 : VkDeviceMemory hMemory,
5994 : VmaSuballocationType suballocationType,
5995 : void* pMappedData,
5996 : VkDeviceSize size);
5997 :
5998 0 : ALLOCATION_TYPE GetType() const { return (ALLOCATION_TYPE)m_Type; }
5999 0 : VkDeviceSize GetAlignment() const { return m_Alignment; }
6000 0 : VkDeviceSize GetSize() const { return m_Size; }
6001 0 : void* GetUserData() const { return m_pUserData; }
6002 0 : const char* GetName() const { return m_pName; }
6003 0 : VmaSuballocationType GetSuballocationType() const { return (VmaSuballocationType)m_SuballocationType; }
6004 :
6005 0 : VmaDeviceMemoryBlock* GetBlock() const { VMA_ASSERT(m_Type == ALLOCATION_TYPE_BLOCK); return m_BlockAllocation.m_Block; }
6006 0 : uint32_t GetMemoryTypeIndex() const { return m_MemoryTypeIndex; }
6007 0 : bool IsPersistentMap() const { return (m_Flags & FLAG_PERSISTENT_MAP) != 0; }
6008 0 : bool IsMappingAllowed() const { return (m_Flags & FLAG_MAPPING_ALLOWED) != 0; }
6009 :
6010 0 : void SetUserData(VmaAllocator hAllocator, void* pUserData) { m_pUserData = pUserData; }
6011 : void SetName(VmaAllocator hAllocator, const char* pName);
6012 : void FreeName(VmaAllocator hAllocator);
6013 : uint8_t SwapBlockAllocation(VmaAllocator hAllocator, VmaAllocation allocation);
6014 : VmaAllocHandle GetAllocHandle() const;
6015 : VkDeviceSize GetOffset() const;
6016 : VmaPool GetParentPool() const;
6017 : VkDeviceMemory GetMemory() const;
6018 : void* GetMappedData() const;
6019 :
6020 : void BlockAllocMap();
6021 : void BlockAllocUnmap();
6022 : VkResult DedicatedAllocMap(VmaAllocator hAllocator, void** ppData);
6023 : void DedicatedAllocUnmap(VmaAllocator hAllocator);
6024 :
6025 : #if VMA_STATS_STRING_ENABLED
6026 0 : uint32_t GetBufferImageUsage() const { return m_BufferImageUsage; }
6027 :
6028 : void InitBufferImageUsage(uint32_t bufferImageUsage);
6029 : void PrintParameters(class VmaJsonWriter& json) const;
6030 : #endif
6031 :
6032 : private:
6033 : // Allocation out of VmaDeviceMemoryBlock.
6034 : struct BlockAllocation
6035 : {
6036 : VmaDeviceMemoryBlock* m_Block;
6037 : VmaAllocHandle m_AllocHandle;
6038 : };
6039 : // Allocation for an object that has its own private VkDeviceMemory.
6040 : struct DedicatedAllocation
6041 : {
6042 : VmaPool m_hParentPool; // VK_NULL_HANDLE if not belongs to custom pool.
6043 : VkDeviceMemory m_hMemory;
6044 : void* m_pMappedData; // Not null means memory is mapped.
6045 : VmaAllocation_T* m_Prev;
6046 : VmaAllocation_T* m_Next;
6047 : };
6048 : union
6049 : {
6050 : // Allocation out of VmaDeviceMemoryBlock.
6051 : BlockAllocation m_BlockAllocation;
6052 : // Allocation for an object that has its own private VkDeviceMemory.
6053 : DedicatedAllocation m_DedicatedAllocation;
6054 : };
6055 :
6056 : VkDeviceSize m_Alignment;
6057 : VkDeviceSize m_Size;
6058 : void* m_pUserData;
6059 : char* m_pName;
6060 : uint32_t m_MemoryTypeIndex;
6061 : uint8_t m_Type; // ALLOCATION_TYPE
6062 : uint8_t m_SuballocationType; // VmaSuballocationType
6063 : // Reference counter for vmaMapMemory()/vmaUnmapMemory().
6064 : uint8_t m_MapCount;
6065 : uint8_t m_Flags; // enum FLAGS
6066 : #if VMA_STATS_STRING_ENABLED
6067 : uint32_t m_BufferImageUsage; // 0 if unknown.
6068 : #endif
6069 : };
6070 : #endif // _VMA_ALLOCATION_T
6071 :
6072 : #ifndef _VMA_DEDICATED_ALLOCATION_LIST_ITEM_TRAITS
6073 : struct VmaDedicatedAllocationListItemTraits
6074 : {
6075 : typedef VmaAllocation_T ItemType;
6076 :
6077 0 : static ItemType* GetPrev(const ItemType* item)
6078 : {
6079 0 : VMA_HEAVY_ASSERT(item->GetType() == VmaAllocation_T::ALLOCATION_TYPE_DEDICATED);
6080 0 : return item->m_DedicatedAllocation.m_Prev;
6081 : }
6082 0 : static ItemType* GetNext(const ItemType* item)
6083 : {
6084 0 : VMA_HEAVY_ASSERT(item->GetType() == VmaAllocation_T::ALLOCATION_TYPE_DEDICATED);
6085 0 : return item->m_DedicatedAllocation.m_Next;
6086 : }
6087 0 : static ItemType*& AccessPrev(ItemType* item)
6088 : {
6089 0 : VMA_HEAVY_ASSERT(item->GetType() == VmaAllocation_T::ALLOCATION_TYPE_DEDICATED);
6090 0 : return item->m_DedicatedAllocation.m_Prev;
6091 : }
6092 0 : static ItemType*& AccessNext(ItemType* item)
6093 : {
6094 0 : VMA_HEAVY_ASSERT(item->GetType() == VmaAllocation_T::ALLOCATION_TYPE_DEDICATED);
6095 0 : return item->m_DedicatedAllocation.m_Next;
6096 : }
6097 : };
6098 : #endif // _VMA_DEDICATED_ALLOCATION_LIST_ITEM_TRAITS
6099 :
6100 : #ifndef _VMA_DEDICATED_ALLOCATION_LIST
6101 : /*
6102 : Stores linked list of VmaAllocation_T objects.
6103 : Thread-safe, synchronized internally.
6104 : */
6105 : class VmaDedicatedAllocationList
6106 : {
6107 : public:
6108 0 : VmaDedicatedAllocationList() {}
6109 : ~VmaDedicatedAllocationList();
6110 :
6111 : void Init(bool useMutex) { m_UseMutex = useMutex; }
6112 : bool Validate();
6113 :
6114 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats);
6115 : void AddStatistics(VmaStatistics& inoutStats);
6116 : #if VMA_STATS_STRING_ENABLED
6117 : // Writes JSON array with the list of allocations.
6118 : void BuildStatsString(VmaJsonWriter& json);
6119 : #endif
6120 :
6121 : bool IsEmpty();
6122 : void Register(VmaAllocation alloc);
6123 : void Unregister(VmaAllocation alloc);
6124 :
6125 : private:
6126 : typedef VmaIntrusiveLinkedList<VmaDedicatedAllocationListItemTraits> DedicatedAllocationLinkedList;
6127 :
6128 : bool m_UseMutex = true;
6129 : VMA_RW_MUTEX m_Mutex;
6130 : DedicatedAllocationLinkedList m_AllocationList;
6131 : };
6132 :
6133 : #ifndef _VMA_DEDICATED_ALLOCATION_LIST_FUNCTIONS
6134 :
6135 0 : VmaDedicatedAllocationList::~VmaDedicatedAllocationList()
6136 : {
6137 0 : VMA_HEAVY_ASSERT(Validate());
6138 :
6139 0 : if (!m_AllocationList.IsEmpty())
6140 : {
6141 0 : VMA_ASSERT(false && "Unfreed dedicated allocations found!");
6142 : }
6143 0 : }
6144 :
6145 0 : bool VmaDedicatedAllocationList::Validate()
6146 : {
6147 0 : const size_t declaredCount = m_AllocationList.GetCount();
6148 0 : size_t actualCount = 0;
6149 0 : VmaMutexLockRead lock(m_Mutex, m_UseMutex);
6150 0 : for (VmaAllocation alloc = m_AllocationList.Front();
6151 0 : alloc != VMA_NULL; alloc = m_AllocationList.GetNext(alloc))
6152 : {
6153 0 : ++actualCount;
6154 : }
6155 0 : VMA_VALIDATE(actualCount == declaredCount);
6156 :
6157 0 : return true;
6158 : }
6159 :
6160 0 : void VmaDedicatedAllocationList::AddDetailedStatistics(VmaDetailedStatistics& inoutStats)
6161 : {
6162 0 : for(auto* item = m_AllocationList.Front(); item != nullptr; item = DedicatedAllocationLinkedList::GetNext(item))
6163 : {
6164 0 : const VkDeviceSize size = item->GetSize();
6165 0 : inoutStats.statistics.blockCount++;
6166 0 : inoutStats.statistics.blockBytes += size;
6167 0 : VmaAddDetailedStatisticsAllocation(inoutStats, item->GetSize());
6168 : }
6169 0 : }
6170 :
6171 0 : void VmaDedicatedAllocationList::AddStatistics(VmaStatistics& inoutStats)
6172 : {
6173 0 : VmaMutexLockRead lock(m_Mutex, m_UseMutex);
6174 :
6175 0 : const uint32_t allocCount = (uint32_t)m_AllocationList.GetCount();
6176 0 : inoutStats.blockCount += allocCount;
6177 0 : inoutStats.allocationCount += allocCount;
6178 :
6179 0 : for(auto* item = m_AllocationList.Front(); item != nullptr; item = DedicatedAllocationLinkedList::GetNext(item))
6180 : {
6181 0 : const VkDeviceSize size = item->GetSize();
6182 0 : inoutStats.blockBytes += size;
6183 0 : inoutStats.allocationBytes += size;
6184 : }
6185 0 : }
6186 :
6187 : #if VMA_STATS_STRING_ENABLED
6188 0 : void VmaDedicatedAllocationList::BuildStatsString(VmaJsonWriter& json)
6189 : {
6190 0 : VmaMutexLockRead lock(m_Mutex, m_UseMutex);
6191 0 : json.BeginArray();
6192 0 : for (VmaAllocation alloc = m_AllocationList.Front();
6193 0 : alloc != VMA_NULL; alloc = m_AllocationList.GetNext(alloc))
6194 : {
6195 0 : json.BeginObject(true);
6196 0 : alloc->PrintParameters(json);
6197 0 : json.EndObject();
6198 : }
6199 0 : json.EndArray();
6200 0 : }
6201 : #endif // VMA_STATS_STRING_ENABLED
6202 :
6203 0 : bool VmaDedicatedAllocationList::IsEmpty()
6204 : {
6205 0 : VmaMutexLockRead lock(m_Mutex, m_UseMutex);
6206 0 : return m_AllocationList.IsEmpty();
6207 : }
6208 :
6209 0 : void VmaDedicatedAllocationList::Register(VmaAllocation alloc)
6210 : {
6211 0 : VmaMutexLockWrite lock(m_Mutex, m_UseMutex);
6212 0 : m_AllocationList.PushBack(alloc);
6213 0 : }
6214 :
6215 0 : void VmaDedicatedAllocationList::Unregister(VmaAllocation alloc)
6216 : {
6217 0 : VmaMutexLockWrite lock(m_Mutex, m_UseMutex);
6218 0 : m_AllocationList.Remove(alloc);
6219 0 : }
6220 : #endif // _VMA_DEDICATED_ALLOCATION_LIST_FUNCTIONS
6221 : #endif // _VMA_DEDICATED_ALLOCATION_LIST
6222 :
6223 : #ifndef _VMA_SUBALLOCATION
6224 : /*
6225 : Represents a region of VmaDeviceMemoryBlock that is either assigned and returned as
6226 : allocated memory block or free.
6227 : */
6228 : struct VmaSuballocation
6229 : {
6230 : VkDeviceSize offset;
6231 : VkDeviceSize size;
6232 : void* userData;
6233 : VmaSuballocationType type;
6234 : };
6235 :
6236 : // Comparator for offsets.
6237 : struct VmaSuballocationOffsetLess
6238 : {
6239 0 : bool operator()(const VmaSuballocation& lhs, const VmaSuballocation& rhs) const
6240 : {
6241 0 : return lhs.offset < rhs.offset;
6242 : }
6243 : };
6244 :
6245 : struct VmaSuballocationOffsetGreater
6246 : {
6247 0 : bool operator()(const VmaSuballocation& lhs, const VmaSuballocation& rhs) const
6248 : {
6249 0 : return lhs.offset > rhs.offset;
6250 : }
6251 : };
6252 :
6253 : struct VmaSuballocationItemSizeLess
6254 : {
6255 : bool operator()(const VmaSuballocationList::iterator lhs,
6256 : const VmaSuballocationList::iterator rhs) const
6257 : {
6258 : return lhs->size < rhs->size;
6259 : }
6260 :
6261 : bool operator()(const VmaSuballocationList::iterator lhs,
6262 : VkDeviceSize rhsSize) const
6263 : {
6264 : return lhs->size < rhsSize;
6265 : }
6266 : };
6267 : #endif // _VMA_SUBALLOCATION
6268 :
6269 : #ifndef _VMA_ALLOCATION_REQUEST
6270 : /*
6271 : Parameters of planned allocation inside a VmaDeviceMemoryBlock.
6272 : item points to a FREE suballocation.
6273 : */
6274 : struct VmaAllocationRequest
6275 : {
6276 : VmaAllocHandle allocHandle;
6277 : VkDeviceSize size;
6278 : VmaSuballocationList::iterator item;
6279 : void* customData;
6280 : uint64_t algorithmData;
6281 : VmaAllocationRequestType type;
6282 : };
6283 : #endif // _VMA_ALLOCATION_REQUEST
6284 :
6285 : #ifndef _VMA_BLOCK_METADATA
6286 : /*
6287 : Data structure used for bookkeeping of allocations and unused ranges of memory
6288 : in a single VkDeviceMemory block.
6289 : */
6290 : class VmaBlockMetadata
6291 : {
6292 : public:
6293 : // pAllocationCallbacks, if not null, must be owned externally - alive and unchanged for the whole lifetime of this object.
6294 : VmaBlockMetadata(const VkAllocationCallbacks* pAllocationCallbacks,
6295 : VkDeviceSize bufferImageGranularity, bool isVirtual);
6296 0 : virtual ~VmaBlockMetadata() = default;
6297 :
6298 0 : virtual void Init(VkDeviceSize size) { m_Size = size; }
6299 0 : bool IsVirtual() const { return m_IsVirtual; }
6300 0 : VkDeviceSize GetSize() const { return m_Size; }
6301 :
6302 : // Validates all data structures inside this object. If not valid, returns false.
6303 : virtual bool Validate() const = 0;
6304 : virtual size_t GetAllocationCount() const = 0;
6305 : virtual size_t GetFreeRegionsCount() const = 0;
6306 : virtual VkDeviceSize GetSumFreeSize() const = 0;
6307 : // Returns true if this block is empty - contains only single free suballocation.
6308 : virtual bool IsEmpty() const = 0;
6309 : virtual void GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo) = 0;
6310 : virtual VkDeviceSize GetAllocationOffset(VmaAllocHandle allocHandle) const = 0;
6311 : virtual void* GetAllocationUserData(VmaAllocHandle allocHandle) const = 0;
6312 :
6313 : virtual VmaAllocHandle GetAllocationListBegin() const = 0;
6314 : virtual VmaAllocHandle GetNextAllocation(VmaAllocHandle prevAlloc) const = 0;
6315 : virtual VkDeviceSize GetNextFreeRegionSize(VmaAllocHandle alloc) const = 0;
6316 :
6317 : // Shouldn't modify blockCount.
6318 : virtual void AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const = 0;
6319 : virtual void AddStatistics(VmaStatistics& inoutStats) const = 0;
6320 :
6321 : #if VMA_STATS_STRING_ENABLED
6322 : virtual void PrintDetailedMap(class VmaJsonWriter& json) const = 0;
6323 : #endif
6324 :
6325 : // Tries to find a place for suballocation with given parameters inside this block.
6326 : // If succeeded, fills pAllocationRequest and returns true.
6327 : // If failed, returns false.
6328 : virtual bool CreateAllocationRequest(
6329 : VkDeviceSize allocSize,
6330 : VkDeviceSize allocAlignment,
6331 : bool upperAddress,
6332 : VmaSuballocationType allocType,
6333 : // Always one of VMA_ALLOCATION_CREATE_STRATEGY_* or VMA_ALLOCATION_INTERNAL_STRATEGY_* flags.
6334 : uint32_t strategy,
6335 : VmaAllocationRequest* pAllocationRequest) = 0;
6336 :
6337 : virtual VkResult CheckCorruption(const void* pBlockData) = 0;
6338 :
6339 : // Makes actual allocation based on request. Request must already be checked and valid.
6340 : virtual void Alloc(
6341 : const VmaAllocationRequest& request,
6342 : VmaSuballocationType type,
6343 : void* userData) = 0;
6344 :
6345 : // Frees suballocation assigned to given memory region.
6346 : virtual void Free(VmaAllocHandle allocHandle) = 0;
6347 :
6348 : // Frees all allocations.
6349 : // Careful! Don't call it if there are VmaAllocation objects owned by userData of cleared allocations!
6350 : virtual void Clear() = 0;
6351 :
6352 : virtual void SetAllocationUserData(VmaAllocHandle allocHandle, void* userData) = 0;
6353 : virtual void DebugLogAllAllocations() const = 0;
6354 :
6355 : protected:
6356 0 : const VkAllocationCallbacks* GetAllocationCallbacks() const { return m_pAllocationCallbacks; }
6357 0 : VkDeviceSize GetBufferImageGranularity() const { return m_BufferImageGranularity; }
6358 0 : VkDeviceSize GetDebugMargin() const { return IsVirtual() ? 0 : VMA_DEBUG_MARGIN; }
6359 :
6360 : void DebugLogAllocation(VkDeviceSize offset, VkDeviceSize size, void* userData) const;
6361 : #if VMA_STATS_STRING_ENABLED
6362 : // mapRefCount == UINT32_MAX means unspecified.
6363 : void PrintDetailedMap_Begin(class VmaJsonWriter& json,
6364 : VkDeviceSize unusedBytes,
6365 : size_t allocationCount,
6366 : size_t unusedRangeCount) const;
6367 : void PrintDetailedMap_Allocation(class VmaJsonWriter& json,
6368 : VkDeviceSize offset, VkDeviceSize size, void* userData) const;
6369 : void PrintDetailedMap_UnusedRange(class VmaJsonWriter& json,
6370 : VkDeviceSize offset,
6371 : VkDeviceSize size) const;
6372 : void PrintDetailedMap_End(class VmaJsonWriter& json) const;
6373 : #endif
6374 :
6375 : private:
6376 : VkDeviceSize m_Size;
6377 : const VkAllocationCallbacks* m_pAllocationCallbacks;
6378 : const VkDeviceSize m_BufferImageGranularity;
6379 : const bool m_IsVirtual;
6380 : };
6381 :
6382 : #ifndef _VMA_BLOCK_METADATA_FUNCTIONS
6383 0 : VmaBlockMetadata::VmaBlockMetadata(const VkAllocationCallbacks* pAllocationCallbacks,
6384 0 : VkDeviceSize bufferImageGranularity, bool isVirtual)
6385 : : m_Size(0),
6386 : m_pAllocationCallbacks(pAllocationCallbacks),
6387 : m_BufferImageGranularity(bufferImageGranularity),
6388 0 : m_IsVirtual(isVirtual) {}
6389 :
6390 0 : void VmaBlockMetadata::DebugLogAllocation(VkDeviceSize offset, VkDeviceSize size, void* userData) const
6391 : {
6392 0 : if (IsVirtual())
6393 : {
6394 0 : VMA_DEBUG_LOG("UNFREED VIRTUAL ALLOCATION; Offset: %llu; Size: %llu; UserData: %p", offset, size, userData);
6395 : }
6396 : else
6397 : {
6398 0 : VMA_ASSERT(userData != VMA_NULL);
6399 0 : VmaAllocation allocation = reinterpret_cast<VmaAllocation>(userData);
6400 :
6401 0 : userData = allocation->GetUserData();
6402 0 : const char* name = allocation->GetName();
6403 :
6404 : #if VMA_STATS_STRING_ENABLED
6405 0 : VMA_DEBUG_LOG("UNFREED ALLOCATION; Offset: %llu; Size: %llu; UserData: %p; Name: %s; Type: %s; Usage: %u",
6406 : offset, size, userData, name ? name : "vma_empty",
6407 : VMA_SUBALLOCATION_TYPE_NAMES[allocation->GetSuballocationType()],
6408 : allocation->GetBufferImageUsage());
6409 : #else
6410 : VMA_DEBUG_LOG("UNFREED ALLOCATION; Offset: %llu; Size: %llu; UserData: %p; Name: %s; Type: %u",
6411 : offset, size, userData, name ? name : "vma_empty",
6412 : (uint32_t)allocation->GetSuballocationType());
6413 : #endif // VMA_STATS_STRING_ENABLED
6414 : }
6415 :
6416 0 : }
6417 :
6418 : #if VMA_STATS_STRING_ENABLED
6419 0 : void VmaBlockMetadata::PrintDetailedMap_Begin(class VmaJsonWriter& json,
6420 : VkDeviceSize unusedBytes, size_t allocationCount, size_t unusedRangeCount) const
6421 : {
6422 0 : json.WriteString("TotalBytes");
6423 0 : json.WriteNumber(GetSize());
6424 :
6425 0 : json.WriteString("UnusedBytes");
6426 0 : json.WriteSize(unusedBytes);
6427 :
6428 0 : json.WriteString("Allocations");
6429 0 : json.WriteSize(allocationCount);
6430 :
6431 0 : json.WriteString("UnusedRanges");
6432 0 : json.WriteSize(unusedRangeCount);
6433 :
6434 0 : json.WriteString("Suballocations");
6435 0 : json.BeginArray();
6436 0 : }
6437 :
6438 0 : void VmaBlockMetadata::PrintDetailedMap_Allocation(class VmaJsonWriter& json,
6439 : VkDeviceSize offset, VkDeviceSize size, void* userData) const
6440 : {
6441 0 : json.BeginObject(true);
6442 :
6443 0 : json.WriteString("Offset");
6444 0 : json.WriteNumber(offset);
6445 :
6446 0 : if (IsVirtual())
6447 : {
6448 0 : json.WriteString("Size");
6449 0 : json.WriteNumber(size);
6450 0 : if (userData)
6451 : {
6452 0 : json.WriteString("CustomData");
6453 0 : json.BeginString();
6454 0 : json.ContinueString_Pointer(userData);
6455 0 : json.EndString();
6456 : }
6457 : }
6458 : else
6459 : {
6460 0 : ((VmaAllocation)userData)->PrintParameters(json);
6461 : }
6462 :
6463 0 : json.EndObject();
6464 0 : }
6465 :
6466 0 : void VmaBlockMetadata::PrintDetailedMap_UnusedRange(class VmaJsonWriter& json,
6467 : VkDeviceSize offset, VkDeviceSize size) const
6468 : {
6469 0 : json.BeginObject(true);
6470 :
6471 0 : json.WriteString("Offset");
6472 0 : json.WriteNumber(offset);
6473 :
6474 0 : json.WriteString("Type");
6475 0 : json.WriteString(VMA_SUBALLOCATION_TYPE_NAMES[VMA_SUBALLOCATION_TYPE_FREE]);
6476 :
6477 0 : json.WriteString("Size");
6478 0 : json.WriteNumber(size);
6479 :
6480 0 : json.EndObject();
6481 0 : }
6482 :
6483 0 : void VmaBlockMetadata::PrintDetailedMap_End(class VmaJsonWriter& json) const
6484 : {
6485 0 : json.EndArray();
6486 0 : }
6487 : #endif // VMA_STATS_STRING_ENABLED
6488 : #endif // _VMA_BLOCK_METADATA_FUNCTIONS
6489 : #endif // _VMA_BLOCK_METADATA
6490 :
6491 : #ifndef _VMA_BLOCK_BUFFER_IMAGE_GRANULARITY
6492 : // Before deleting object of this class remember to call 'Destroy()'
6493 : class VmaBlockBufferImageGranularity final
6494 : {
6495 : public:
6496 : struct ValidationContext
6497 : {
6498 : const VkAllocationCallbacks* allocCallbacks;
6499 : uint16_t* pageAllocs;
6500 : };
6501 :
6502 : VmaBlockBufferImageGranularity(VkDeviceSize bufferImageGranularity);
6503 : ~VmaBlockBufferImageGranularity();
6504 :
6505 0 : bool IsEnabled() const { return m_BufferImageGranularity > MAX_LOW_BUFFER_IMAGE_GRANULARITY; }
6506 :
6507 : void Init(const VkAllocationCallbacks* pAllocationCallbacks, VkDeviceSize size);
6508 : // Before destroying object you must call free it's memory
6509 : void Destroy(const VkAllocationCallbacks* pAllocationCallbacks);
6510 :
6511 : void RoundupAllocRequest(VmaSuballocationType allocType,
6512 : VkDeviceSize& inOutAllocSize,
6513 : VkDeviceSize& inOutAllocAlignment) const;
6514 :
6515 : bool CheckConflictAndAlignUp(VkDeviceSize& inOutAllocOffset,
6516 : VkDeviceSize allocSize,
6517 : VkDeviceSize blockOffset,
6518 : VkDeviceSize blockSize,
6519 : VmaSuballocationType allocType) const;
6520 :
6521 : void AllocPages(uint8_t allocType, VkDeviceSize offset, VkDeviceSize size);
6522 : void FreePages(VkDeviceSize offset, VkDeviceSize size);
6523 : void Clear();
6524 :
6525 : ValidationContext StartValidation(const VkAllocationCallbacks* pAllocationCallbacks,
6526 : bool isVirutal) const;
6527 : bool Validate(ValidationContext& ctx, VkDeviceSize offset, VkDeviceSize size) const;
6528 : bool FinishValidation(ValidationContext& ctx) const;
6529 :
6530 : private:
6531 : static const uint16_t MAX_LOW_BUFFER_IMAGE_GRANULARITY = 256;
6532 :
6533 : struct RegionInfo
6534 : {
6535 : uint8_t allocType;
6536 : uint16_t allocCount;
6537 : };
6538 :
6539 : VkDeviceSize m_BufferImageGranularity;
6540 : uint32_t m_RegionCount;
6541 : RegionInfo* m_RegionInfo;
6542 :
6543 0 : uint32_t GetStartPage(VkDeviceSize offset) const { return OffsetToPageIndex(offset & ~(m_BufferImageGranularity - 1)); }
6544 0 : uint32_t GetEndPage(VkDeviceSize offset, VkDeviceSize size) const { return OffsetToPageIndex((offset + size - 1) & ~(m_BufferImageGranularity - 1)); }
6545 :
6546 : uint32_t OffsetToPageIndex(VkDeviceSize offset) const;
6547 : void AllocPage(RegionInfo& page, uint8_t allocType);
6548 : };
6549 :
6550 : #ifndef _VMA_BLOCK_BUFFER_IMAGE_GRANULARITY_FUNCTIONS
6551 0 : VmaBlockBufferImageGranularity::VmaBlockBufferImageGranularity(VkDeviceSize bufferImageGranularity)
6552 : : m_BufferImageGranularity(bufferImageGranularity),
6553 : m_RegionCount(0),
6554 0 : m_RegionInfo(VMA_NULL) {}
6555 :
6556 0 : VmaBlockBufferImageGranularity::~VmaBlockBufferImageGranularity()
6557 : {
6558 0 : VMA_ASSERT(m_RegionInfo == VMA_NULL && "Free not called before destroying object!");
6559 0 : }
6560 :
6561 0 : void VmaBlockBufferImageGranularity::Init(const VkAllocationCallbacks* pAllocationCallbacks, VkDeviceSize size)
6562 : {
6563 0 : if (IsEnabled())
6564 : {
6565 0 : m_RegionCount = static_cast<uint32_t>(VmaDivideRoundingUp(size, m_BufferImageGranularity));
6566 0 : m_RegionInfo = vma_new_array(pAllocationCallbacks, RegionInfo, m_RegionCount);
6567 0 : memset(m_RegionInfo, 0, m_RegionCount * sizeof(RegionInfo));
6568 : }
6569 0 : }
6570 :
6571 0 : void VmaBlockBufferImageGranularity::Destroy(const VkAllocationCallbacks* pAllocationCallbacks)
6572 : {
6573 0 : if (m_RegionInfo)
6574 : {
6575 0 : vma_delete_array(pAllocationCallbacks, m_RegionInfo, m_RegionCount);
6576 0 : m_RegionInfo = VMA_NULL;
6577 : }
6578 0 : }
6579 :
6580 0 : void VmaBlockBufferImageGranularity::RoundupAllocRequest(VmaSuballocationType allocType,
6581 : VkDeviceSize& inOutAllocSize,
6582 : VkDeviceSize& inOutAllocAlignment) const
6583 : {
6584 0 : if (m_BufferImageGranularity > 1 &&
6585 0 : m_BufferImageGranularity <= MAX_LOW_BUFFER_IMAGE_GRANULARITY)
6586 : {
6587 0 : if (allocType == VMA_SUBALLOCATION_TYPE_UNKNOWN ||
6588 0 : allocType == VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN ||
6589 : allocType == VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL)
6590 : {
6591 0 : inOutAllocAlignment = VMA_MAX(inOutAllocAlignment, m_BufferImageGranularity);
6592 0 : inOutAllocSize = VmaAlignUp(inOutAllocSize, m_BufferImageGranularity);
6593 : }
6594 : }
6595 0 : }
6596 :
6597 0 : bool VmaBlockBufferImageGranularity::CheckConflictAndAlignUp(VkDeviceSize& inOutAllocOffset,
6598 : VkDeviceSize allocSize,
6599 : VkDeviceSize blockOffset,
6600 : VkDeviceSize blockSize,
6601 : VmaSuballocationType allocType) const
6602 : {
6603 0 : if (IsEnabled())
6604 : {
6605 0 : uint32_t startPage = GetStartPage(inOutAllocOffset);
6606 0 : if (m_RegionInfo[startPage].allocCount > 0 &&
6607 0 : VmaIsBufferImageGranularityConflict(static_cast<VmaSuballocationType>(m_RegionInfo[startPage].allocType), allocType))
6608 : {
6609 0 : inOutAllocOffset = VmaAlignUp(inOutAllocOffset, m_BufferImageGranularity);
6610 0 : if (blockSize < allocSize + inOutAllocOffset - blockOffset)
6611 0 : return true;
6612 0 : ++startPage;
6613 : }
6614 0 : uint32_t endPage = GetEndPage(inOutAllocOffset, allocSize);
6615 0 : if (endPage != startPage &&
6616 0 : m_RegionInfo[endPage].allocCount > 0 &&
6617 0 : VmaIsBufferImageGranularityConflict(static_cast<VmaSuballocationType>(m_RegionInfo[endPage].allocType), allocType))
6618 : {
6619 0 : return true;
6620 : }
6621 : }
6622 0 : return false;
6623 : }
6624 :
6625 0 : void VmaBlockBufferImageGranularity::AllocPages(uint8_t allocType, VkDeviceSize offset, VkDeviceSize size)
6626 : {
6627 0 : if (IsEnabled())
6628 : {
6629 0 : uint32_t startPage = GetStartPage(offset);
6630 0 : AllocPage(m_RegionInfo[startPage], allocType);
6631 :
6632 0 : uint32_t endPage = GetEndPage(offset, size);
6633 0 : if (startPage != endPage)
6634 0 : AllocPage(m_RegionInfo[endPage], allocType);
6635 : }
6636 0 : }
6637 :
6638 0 : void VmaBlockBufferImageGranularity::FreePages(VkDeviceSize offset, VkDeviceSize size)
6639 : {
6640 0 : if (IsEnabled())
6641 : {
6642 0 : uint32_t startPage = GetStartPage(offset);
6643 0 : --m_RegionInfo[startPage].allocCount;
6644 0 : if (m_RegionInfo[startPage].allocCount == 0)
6645 0 : m_RegionInfo[startPage].allocType = VMA_SUBALLOCATION_TYPE_FREE;
6646 0 : uint32_t endPage = GetEndPage(offset, size);
6647 0 : if (startPage != endPage)
6648 : {
6649 0 : --m_RegionInfo[endPage].allocCount;
6650 0 : if (m_RegionInfo[endPage].allocCount == 0)
6651 0 : m_RegionInfo[endPage].allocType = VMA_SUBALLOCATION_TYPE_FREE;
6652 : }
6653 : }
6654 0 : }
6655 :
6656 0 : void VmaBlockBufferImageGranularity::Clear()
6657 : {
6658 0 : if (m_RegionInfo)
6659 0 : memset(m_RegionInfo, 0, m_RegionCount * sizeof(RegionInfo));
6660 0 : }
6661 :
6662 0 : VmaBlockBufferImageGranularity::ValidationContext VmaBlockBufferImageGranularity::StartValidation(
6663 : const VkAllocationCallbacks* pAllocationCallbacks, bool isVirutal) const
6664 : {
6665 0 : ValidationContext ctx{ pAllocationCallbacks, VMA_NULL };
6666 0 : if (!isVirutal && IsEnabled())
6667 : {
6668 0 : ctx.pageAllocs = vma_new_array(pAllocationCallbacks, uint16_t, m_RegionCount);
6669 0 : memset(ctx.pageAllocs, 0, m_RegionCount * sizeof(uint16_t));
6670 : }
6671 0 : return ctx;
6672 : }
6673 :
6674 0 : bool VmaBlockBufferImageGranularity::Validate(ValidationContext& ctx,
6675 : VkDeviceSize offset, VkDeviceSize size) const
6676 : {
6677 0 : if (IsEnabled())
6678 : {
6679 0 : uint32_t start = GetStartPage(offset);
6680 0 : ++ctx.pageAllocs[start];
6681 0 : VMA_VALIDATE(m_RegionInfo[start].allocCount > 0);
6682 :
6683 0 : uint32_t end = GetEndPage(offset, size);
6684 0 : if (start != end)
6685 : {
6686 0 : ++ctx.pageAllocs[end];
6687 0 : VMA_VALIDATE(m_RegionInfo[end].allocCount > 0);
6688 : }
6689 : }
6690 0 : return true;
6691 : }
6692 :
6693 0 : bool VmaBlockBufferImageGranularity::FinishValidation(ValidationContext& ctx) const
6694 : {
6695 : // Check proper page structure
6696 0 : if (IsEnabled())
6697 : {
6698 0 : VMA_ASSERT(ctx.pageAllocs != VMA_NULL && "Validation context not initialized!");
6699 :
6700 0 : for (uint32_t page = 0; page < m_RegionCount; ++page)
6701 : {
6702 0 : VMA_VALIDATE(ctx.pageAllocs[page] == m_RegionInfo[page].allocCount);
6703 : }
6704 0 : vma_delete_array(ctx.allocCallbacks, ctx.pageAllocs, m_RegionCount);
6705 0 : ctx.pageAllocs = VMA_NULL;
6706 : }
6707 0 : return true;
6708 : }
6709 :
6710 0 : uint32_t VmaBlockBufferImageGranularity::OffsetToPageIndex(VkDeviceSize offset) const
6711 : {
6712 0 : return static_cast<uint32_t>(offset >> VMA_BITSCAN_MSB(m_BufferImageGranularity));
6713 : }
6714 :
6715 0 : void VmaBlockBufferImageGranularity::AllocPage(RegionInfo& page, uint8_t allocType)
6716 : {
6717 : // When current alloc type is free then it can be overriden by new type
6718 0 : if (page.allocCount == 0 || (page.allocCount > 0 && page.allocType == VMA_SUBALLOCATION_TYPE_FREE))
6719 0 : page.allocType = allocType;
6720 :
6721 0 : ++page.allocCount;
6722 0 : }
6723 : #endif // _VMA_BLOCK_BUFFER_IMAGE_GRANULARITY_FUNCTIONS
6724 : #endif // _VMA_BLOCK_BUFFER_IMAGE_GRANULARITY
6725 :
6726 : #if 0
6727 : #ifndef _VMA_BLOCK_METADATA_GENERIC
6728 : class VmaBlockMetadata_Generic : public VmaBlockMetadata
6729 : {
6730 : friend class VmaDefragmentationAlgorithm_Generic;
6731 : friend class VmaDefragmentationAlgorithm_Fast;
6732 : VMA_CLASS_NO_COPY(VmaBlockMetadata_Generic)
6733 : public:
6734 : VmaBlockMetadata_Generic(const VkAllocationCallbacks* pAllocationCallbacks,
6735 : VkDeviceSize bufferImageGranularity, bool isVirtual);
6736 : virtual ~VmaBlockMetadata_Generic() = default;
6737 :
6738 : size_t GetAllocationCount() const override { return m_Suballocations.size() - m_FreeCount; }
6739 : VkDeviceSize GetSumFreeSize() const override { return m_SumFreeSize; }
6740 : bool IsEmpty() const override { return (m_Suballocations.size() == 1) && (m_FreeCount == 1); }
6741 : void Free(VmaAllocHandle allocHandle) override { FreeSuballocation(FindAtOffset((VkDeviceSize)allocHandle - 1)); }
6742 : VkDeviceSize GetAllocationOffset(VmaAllocHandle allocHandle) const override { return (VkDeviceSize)allocHandle - 1; };
6743 :
6744 : void Init(VkDeviceSize size) override;
6745 : bool Validate() const override;
6746 :
6747 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const override;
6748 : void AddStatistics(VmaStatistics& inoutStats) const override;
6749 :
6750 : #if VMA_STATS_STRING_ENABLED
6751 : void PrintDetailedMap(class VmaJsonWriter& json, uint32_t mapRefCount) const override;
6752 : #endif
6753 :
6754 : bool CreateAllocationRequest(
6755 : VkDeviceSize allocSize,
6756 : VkDeviceSize allocAlignment,
6757 : bool upperAddress,
6758 : VmaSuballocationType allocType,
6759 : uint32_t strategy,
6760 : VmaAllocationRequest* pAllocationRequest) override;
6761 :
6762 : VkResult CheckCorruption(const void* pBlockData) override;
6763 :
6764 : void Alloc(
6765 : const VmaAllocationRequest& request,
6766 : VmaSuballocationType type,
6767 : void* userData) override;
6768 :
6769 : void GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo) override;
6770 : void* GetAllocationUserData(VmaAllocHandle allocHandle) const override;
6771 : VmaAllocHandle GetAllocationListBegin() const override;
6772 : VmaAllocHandle GetNextAllocation(VmaAllocHandle prevAlloc) const override;
6773 : void Clear() override;
6774 : void SetAllocationUserData(VmaAllocHandle allocHandle, void* userData) override;
6775 : void DebugLogAllAllocations() const override;
6776 :
6777 : private:
6778 : uint32_t m_FreeCount;
6779 : VkDeviceSize m_SumFreeSize;
6780 : VmaSuballocationList m_Suballocations;
6781 : // Suballocations that are free. Sorted by size, ascending.
6782 : VmaVector<VmaSuballocationList::iterator, VmaStlAllocator<VmaSuballocationList::iterator>> m_FreeSuballocationsBySize;
6783 :
6784 : VkDeviceSize AlignAllocationSize(VkDeviceSize size) const { return IsVirtual() ? size : VmaAlignUp(size, (VkDeviceSize)16); }
6785 :
6786 : VmaSuballocationList::iterator FindAtOffset(VkDeviceSize offset) const;
6787 : bool ValidateFreeSuballocationList() const;
6788 :
6789 : // Checks if requested suballocation with given parameters can be placed in given pFreeSuballocItem.
6790 : // If yes, fills pOffset and returns true. If no, returns false.
6791 : bool CheckAllocation(
6792 : VkDeviceSize allocSize,
6793 : VkDeviceSize allocAlignment,
6794 : VmaSuballocationType allocType,
6795 : VmaSuballocationList::const_iterator suballocItem,
6796 : VmaAllocHandle* pAllocHandle) const;
6797 :
6798 : // Given free suballocation, it merges it with following one, which must also be free.
6799 : void MergeFreeWithNext(VmaSuballocationList::iterator item);
6800 : // Releases given suballocation, making it free.
6801 : // Merges it with adjacent free suballocations if applicable.
6802 : // Returns iterator to new free suballocation at this place.
6803 : VmaSuballocationList::iterator FreeSuballocation(VmaSuballocationList::iterator suballocItem);
6804 : // Given free suballocation, it inserts it into sorted list of
6805 : // m_FreeSuballocationsBySize if it is suitable.
6806 : void RegisterFreeSuballocation(VmaSuballocationList::iterator item);
6807 : // Given free suballocation, it removes it from sorted list of
6808 : // m_FreeSuballocationsBySize if it is suitable.
6809 : void UnregisterFreeSuballocation(VmaSuballocationList::iterator item);
6810 : };
6811 :
6812 : #ifndef _VMA_BLOCK_METADATA_GENERIC_FUNCTIONS
6813 : VmaBlockMetadata_Generic::VmaBlockMetadata_Generic(const VkAllocationCallbacks* pAllocationCallbacks,
6814 : VkDeviceSize bufferImageGranularity, bool isVirtual)
6815 : : VmaBlockMetadata(pAllocationCallbacks, bufferImageGranularity, isVirtual),
6816 : m_FreeCount(0),
6817 : m_SumFreeSize(0),
6818 : m_Suballocations(VmaStlAllocator<VmaSuballocation>(pAllocationCallbacks)),
6819 : m_FreeSuballocationsBySize(VmaStlAllocator<VmaSuballocationList::iterator>(pAllocationCallbacks)) {}
6820 :
6821 : void VmaBlockMetadata_Generic::Init(VkDeviceSize size)
6822 : {
6823 : VmaBlockMetadata::Init(size);
6824 :
6825 : m_FreeCount = 1;
6826 : m_SumFreeSize = size;
6827 :
6828 : VmaSuballocation suballoc = {};
6829 : suballoc.offset = 0;
6830 : suballoc.size = size;
6831 : suballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
6832 :
6833 : m_Suballocations.push_back(suballoc);
6834 : m_FreeSuballocationsBySize.push_back(m_Suballocations.begin());
6835 : }
6836 :
6837 : bool VmaBlockMetadata_Generic::Validate() const
6838 : {
6839 : VMA_VALIDATE(!m_Suballocations.empty());
6840 :
6841 : // Expected offset of new suballocation as calculated from previous ones.
6842 : VkDeviceSize calculatedOffset = 0;
6843 : // Expected number of free suballocations as calculated from traversing their list.
6844 : uint32_t calculatedFreeCount = 0;
6845 : // Expected sum size of free suballocations as calculated from traversing their list.
6846 : VkDeviceSize calculatedSumFreeSize = 0;
6847 : // Expected number of free suballocations that should be registered in
6848 : // m_FreeSuballocationsBySize calculated from traversing their list.
6849 : size_t freeSuballocationsToRegister = 0;
6850 : // True if previous visited suballocation was free.
6851 : bool prevFree = false;
6852 :
6853 : const VkDeviceSize debugMargin = GetDebugMargin();
6854 :
6855 : for (const auto& subAlloc : m_Suballocations)
6856 : {
6857 : // Actual offset of this suballocation doesn't match expected one.
6858 : VMA_VALIDATE(subAlloc.offset == calculatedOffset);
6859 :
6860 : const bool currFree = (subAlloc.type == VMA_SUBALLOCATION_TYPE_FREE);
6861 : // Two adjacent free suballocations are invalid. They should be merged.
6862 : VMA_VALIDATE(!prevFree || !currFree);
6863 :
6864 : VmaAllocation alloc = (VmaAllocation)subAlloc.userData;
6865 : if (!IsVirtual())
6866 : {
6867 : VMA_VALIDATE(currFree == (alloc == VK_NULL_HANDLE));
6868 : }
6869 :
6870 : if (currFree)
6871 : {
6872 : calculatedSumFreeSize += subAlloc.size;
6873 : ++calculatedFreeCount;
6874 : ++freeSuballocationsToRegister;
6875 :
6876 : // Margin required between allocations - every free space must be at least that large.
6877 : VMA_VALIDATE(subAlloc.size >= debugMargin);
6878 : }
6879 : else
6880 : {
6881 : if (!IsVirtual())
6882 : {
6883 : VMA_VALIDATE((VkDeviceSize)alloc->GetAllocHandle() == subAlloc.offset + 1);
6884 : VMA_VALIDATE(alloc->GetSize() == subAlloc.size);
6885 : }
6886 :
6887 : // Margin required between allocations - previous allocation must be free.
6888 : VMA_VALIDATE(debugMargin == 0 || prevFree);
6889 : }
6890 :
6891 : calculatedOffset += subAlloc.size;
6892 : prevFree = currFree;
6893 : }
6894 :
6895 : // Number of free suballocations registered in m_FreeSuballocationsBySize doesn't
6896 : // match expected one.
6897 : VMA_VALIDATE(m_FreeSuballocationsBySize.size() == freeSuballocationsToRegister);
6898 :
6899 : VkDeviceSize lastSize = 0;
6900 : for (size_t i = 0; i < m_FreeSuballocationsBySize.size(); ++i)
6901 : {
6902 : VmaSuballocationList::iterator suballocItem = m_FreeSuballocationsBySize[i];
6903 :
6904 : // Only free suballocations can be registered in m_FreeSuballocationsBySize.
6905 : VMA_VALIDATE(suballocItem->type == VMA_SUBALLOCATION_TYPE_FREE);
6906 : // They must be sorted by size ascending.
6907 : VMA_VALIDATE(suballocItem->size >= lastSize);
6908 :
6909 : lastSize = suballocItem->size;
6910 : }
6911 :
6912 : // Check if totals match calculated values.
6913 : VMA_VALIDATE(ValidateFreeSuballocationList());
6914 : VMA_VALIDATE(calculatedOffset == GetSize());
6915 : VMA_VALIDATE(calculatedSumFreeSize == m_SumFreeSize);
6916 : VMA_VALIDATE(calculatedFreeCount == m_FreeCount);
6917 :
6918 : return true;
6919 : }
6920 :
6921 : void VmaBlockMetadata_Generic::AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const
6922 : {
6923 : const uint32_t rangeCount = (uint32_t)m_Suballocations.size();
6924 : inoutStats.statistics.blockCount++;
6925 : inoutStats.statistics.blockBytes += GetSize();
6926 :
6927 : for (const auto& suballoc : m_Suballocations)
6928 : {
6929 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
6930 : VmaAddDetailedStatisticsAllocation(inoutStats, suballoc.size);
6931 : else
6932 : VmaAddDetailedStatisticsUnusedRange(inoutStats, suballoc.size);
6933 : }
6934 : }
6935 :
6936 : void VmaBlockMetadata_Generic::AddStatistics(VmaStatistics& inoutStats) const
6937 : {
6938 : inoutStats.blockCount++;
6939 : inoutStats.allocationCount += (uint32_t)m_Suballocations.size() - m_FreeCount;
6940 : inoutStats.blockBytes += GetSize();
6941 : inoutStats.allocationBytes += GetSize() - m_SumFreeSize;
6942 : }
6943 :
6944 : #if VMA_STATS_STRING_ENABLED
6945 : void VmaBlockMetadata_Generic::PrintDetailedMap(class VmaJsonWriter& json, uint32_t mapRefCount) const
6946 : {
6947 : PrintDetailedMap_Begin(json,
6948 : m_SumFreeSize, // unusedBytes
6949 : m_Suballocations.size() - (size_t)m_FreeCount, // allocationCount
6950 : m_FreeCount, // unusedRangeCount
6951 : mapRefCount);
6952 :
6953 : for (const auto& suballoc : m_Suballocations)
6954 : {
6955 : if (suballoc.type == VMA_SUBALLOCATION_TYPE_FREE)
6956 : {
6957 : PrintDetailedMap_UnusedRange(json, suballoc.offset, suballoc.size);
6958 : }
6959 : else
6960 : {
6961 : PrintDetailedMap_Allocation(json, suballoc.offset, suballoc.size, suballoc.userData);
6962 : }
6963 : }
6964 :
6965 : PrintDetailedMap_End(json);
6966 : }
6967 : #endif // VMA_STATS_STRING_ENABLED
6968 :
6969 : bool VmaBlockMetadata_Generic::CreateAllocationRequest(
6970 : VkDeviceSize allocSize,
6971 : VkDeviceSize allocAlignment,
6972 : bool upperAddress,
6973 : VmaSuballocationType allocType,
6974 : uint32_t strategy,
6975 : VmaAllocationRequest* pAllocationRequest)
6976 : {
6977 : VMA_ASSERT(allocSize > 0);
6978 : VMA_ASSERT(!upperAddress);
6979 : VMA_ASSERT(allocType != VMA_SUBALLOCATION_TYPE_FREE);
6980 : VMA_ASSERT(pAllocationRequest != VMA_NULL);
6981 : VMA_HEAVY_ASSERT(Validate());
6982 :
6983 : allocSize = AlignAllocationSize(allocSize);
6984 :
6985 : pAllocationRequest->type = VmaAllocationRequestType::Normal;
6986 : pAllocationRequest->size = allocSize;
6987 :
6988 : const VkDeviceSize debugMargin = GetDebugMargin();
6989 :
6990 : // There is not enough total free space in this block to fulfill the request: Early return.
6991 : if (m_SumFreeSize < allocSize + debugMargin)
6992 : {
6993 : return false;
6994 : }
6995 :
6996 : // New algorithm, efficiently searching freeSuballocationsBySize.
6997 : const size_t freeSuballocCount = m_FreeSuballocationsBySize.size();
6998 : if (freeSuballocCount > 0)
6999 : {
7000 : if (strategy == 0 ||
7001 : strategy == VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT)
7002 : {
7003 : // Find first free suballocation with size not less than allocSize + debugMargin.
7004 : VmaSuballocationList::iterator* const it = VmaBinaryFindFirstNotLess(
7005 : m_FreeSuballocationsBySize.data(),
7006 : m_FreeSuballocationsBySize.data() + freeSuballocCount,
7007 : allocSize + debugMargin,
7008 : VmaSuballocationItemSizeLess());
7009 : size_t index = it - m_FreeSuballocationsBySize.data();
7010 : for (; index < freeSuballocCount; ++index)
7011 : {
7012 : if (CheckAllocation(
7013 : allocSize,
7014 : allocAlignment,
7015 : allocType,
7016 : m_FreeSuballocationsBySize[index],
7017 : &pAllocationRequest->allocHandle))
7018 : {
7019 : pAllocationRequest->item = m_FreeSuballocationsBySize[index];
7020 : return true;
7021 : }
7022 : }
7023 : }
7024 : else if (strategy == VMA_ALLOCATION_INTERNAL_STRATEGY_MIN_OFFSET)
7025 : {
7026 : for (VmaSuballocationList::iterator it = m_Suballocations.begin();
7027 : it != m_Suballocations.end();
7028 : ++it)
7029 : {
7030 : if (it->type == VMA_SUBALLOCATION_TYPE_FREE && CheckAllocation(
7031 : allocSize,
7032 : allocAlignment,
7033 : allocType,
7034 : it,
7035 : &pAllocationRequest->allocHandle))
7036 : {
7037 : pAllocationRequest->item = it;
7038 : return true;
7039 : }
7040 : }
7041 : }
7042 : else
7043 : {
7044 : VMA_ASSERT(strategy & (VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT | VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT ));
7045 : // Search staring from biggest suballocations.
7046 : for (size_t index = freeSuballocCount; index--; )
7047 : {
7048 : if (CheckAllocation(
7049 : allocSize,
7050 : allocAlignment,
7051 : allocType,
7052 : m_FreeSuballocationsBySize[index],
7053 : &pAllocationRequest->allocHandle))
7054 : {
7055 : pAllocationRequest->item = m_FreeSuballocationsBySize[index];
7056 : return true;
7057 : }
7058 : }
7059 : }
7060 : }
7061 :
7062 : return false;
7063 : }
7064 :
7065 : VkResult VmaBlockMetadata_Generic::CheckCorruption(const void* pBlockData)
7066 : {
7067 : for (auto& suballoc : m_Suballocations)
7068 : {
7069 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
7070 : {
7071 : if (!VmaValidateMagicValue(pBlockData, suballoc.offset + suballoc.size))
7072 : {
7073 : VMA_ASSERT(0 && "MEMORY CORRUPTION DETECTED AFTER VALIDATED ALLOCATION!");
7074 : return VK_ERROR_UNKNOWN_COPY;
7075 : }
7076 : }
7077 : }
7078 :
7079 : return VK_SUCCESS;
7080 : }
7081 :
7082 : void VmaBlockMetadata_Generic::Alloc(
7083 : const VmaAllocationRequest& request,
7084 : VmaSuballocationType type,
7085 : void* userData)
7086 : {
7087 : VMA_ASSERT(request.type == VmaAllocationRequestType::Normal);
7088 : VMA_ASSERT(request.item != m_Suballocations.end());
7089 : VmaSuballocation& suballoc = *request.item;
7090 : // Given suballocation is a free block.
7091 : VMA_ASSERT(suballoc.type == VMA_SUBALLOCATION_TYPE_FREE);
7092 :
7093 : // Given offset is inside this suballocation.
7094 : VMA_ASSERT((VkDeviceSize)request.allocHandle - 1 >= suballoc.offset);
7095 : const VkDeviceSize paddingBegin = (VkDeviceSize)request.allocHandle - suballoc.offset - 1;
7096 : VMA_ASSERT(suballoc.size >= paddingBegin + request.size);
7097 : const VkDeviceSize paddingEnd = suballoc.size - paddingBegin - request.size;
7098 :
7099 : // Unregister this free suballocation from m_FreeSuballocationsBySize and update
7100 : // it to become used.
7101 : UnregisterFreeSuballocation(request.item);
7102 :
7103 : suballoc.offset = (VkDeviceSize)request.allocHandle - 1;
7104 : suballoc.size = request.size;
7105 : suballoc.type = type;
7106 : suballoc.userData = userData;
7107 :
7108 : // If there are any free bytes remaining at the end, insert new free suballocation after current one.
7109 : if (paddingEnd)
7110 : {
7111 : VmaSuballocation paddingSuballoc = {};
7112 : paddingSuballoc.offset = suballoc.offset + suballoc.size;
7113 : paddingSuballoc.size = paddingEnd;
7114 : paddingSuballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
7115 : VmaSuballocationList::iterator next = request.item;
7116 : ++next;
7117 : const VmaSuballocationList::iterator paddingEndItem =
7118 : m_Suballocations.insert(next, paddingSuballoc);
7119 : RegisterFreeSuballocation(paddingEndItem);
7120 : }
7121 :
7122 : // If there are any free bytes remaining at the beginning, insert new free suballocation before current one.
7123 : if (paddingBegin)
7124 : {
7125 : VmaSuballocation paddingSuballoc = {};
7126 : paddingSuballoc.offset = suballoc.offset - paddingBegin;
7127 : paddingSuballoc.size = paddingBegin;
7128 : paddingSuballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
7129 : const VmaSuballocationList::iterator paddingBeginItem =
7130 : m_Suballocations.insert(request.item, paddingSuballoc);
7131 : RegisterFreeSuballocation(paddingBeginItem);
7132 : }
7133 :
7134 : // Update totals.
7135 : m_FreeCount = m_FreeCount - 1;
7136 : if (paddingBegin > 0)
7137 : {
7138 : ++m_FreeCount;
7139 : }
7140 : if (paddingEnd > 0)
7141 : {
7142 : ++m_FreeCount;
7143 : }
7144 : m_SumFreeSize -= request.size;
7145 : }
7146 :
7147 : void VmaBlockMetadata_Generic::GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo)
7148 : {
7149 : outInfo.offset = (VkDeviceSize)allocHandle - 1;
7150 : const VmaSuballocation& suballoc = *FindAtOffset(outInfo.offset);
7151 : outInfo.size = suballoc.size;
7152 : outInfo.pUserData = suballoc.userData;
7153 : }
7154 :
7155 : void* VmaBlockMetadata_Generic::GetAllocationUserData(VmaAllocHandle allocHandle) const
7156 : {
7157 : return FindAtOffset((VkDeviceSize)allocHandle - 1)->userData;
7158 : }
7159 :
7160 : VmaAllocHandle VmaBlockMetadata_Generic::GetAllocationListBegin() const
7161 : {
7162 : if (IsEmpty())
7163 : return VK_NULL_HANDLE;
7164 :
7165 : for (const auto& suballoc : m_Suballocations)
7166 : {
7167 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
7168 : return (VmaAllocHandle)(suballoc.offset + 1);
7169 : }
7170 : VMA_ASSERT(false && "Should contain at least 1 allocation!");
7171 : return VK_NULL_HANDLE;
7172 : }
7173 :
7174 : VmaAllocHandle VmaBlockMetadata_Generic::GetNextAllocation(VmaAllocHandle prevAlloc) const
7175 : {
7176 : VmaSuballocationList::const_iterator prev = FindAtOffset((VkDeviceSize)prevAlloc - 1);
7177 :
7178 : for (VmaSuballocationList::const_iterator it = ++prev; it != m_Suballocations.end(); ++it)
7179 : {
7180 : if (it->type != VMA_SUBALLOCATION_TYPE_FREE)
7181 : return (VmaAllocHandle)(it->offset + 1);
7182 : }
7183 : return VK_NULL_HANDLE;
7184 : }
7185 :
7186 : void VmaBlockMetadata_Generic::Clear()
7187 : {
7188 : const VkDeviceSize size = GetSize();
7189 :
7190 : VMA_ASSERT(IsVirtual());
7191 : m_FreeCount = 1;
7192 : m_SumFreeSize = size;
7193 : m_Suballocations.clear();
7194 : m_FreeSuballocationsBySize.clear();
7195 :
7196 : VmaSuballocation suballoc = {};
7197 : suballoc.offset = 0;
7198 : suballoc.size = size;
7199 : suballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
7200 : m_Suballocations.push_back(suballoc);
7201 :
7202 : m_FreeSuballocationsBySize.push_back(m_Suballocations.begin());
7203 : }
7204 :
7205 : void VmaBlockMetadata_Generic::SetAllocationUserData(VmaAllocHandle allocHandle, void* userData)
7206 : {
7207 : VmaSuballocation& suballoc = *FindAtOffset((VkDeviceSize)allocHandle - 1);
7208 : suballoc.userData = userData;
7209 : }
7210 :
7211 : void VmaBlockMetadata_Generic::DebugLogAllAllocations() const
7212 : {
7213 : for (const auto& suballoc : m_Suballocations)
7214 : {
7215 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
7216 : DebugLogAllocation(suballoc.offset, suballoc.size, suballoc.userData);
7217 : }
7218 : }
7219 :
7220 : VmaSuballocationList::iterator VmaBlockMetadata_Generic::FindAtOffset(VkDeviceSize offset) const
7221 : {
7222 : VMA_HEAVY_ASSERT(!m_Suballocations.empty());
7223 : const VkDeviceSize last = m_Suballocations.rbegin()->offset;
7224 : if (last == offset)
7225 : return m_Suballocations.rbegin().drop_const();
7226 : const VkDeviceSize first = m_Suballocations.begin()->offset;
7227 : if (first == offset)
7228 : return m_Suballocations.begin().drop_const();
7229 :
7230 : const size_t suballocCount = m_Suballocations.size();
7231 : const VkDeviceSize step = (last - first + m_Suballocations.begin()->size) / suballocCount;
7232 : auto findSuballocation = [&](auto begin, auto end) -> VmaSuballocationList::iterator
7233 : {
7234 : for (auto suballocItem = begin;
7235 : suballocItem != end;
7236 : ++suballocItem)
7237 : {
7238 : if (suballocItem->offset == offset)
7239 : return suballocItem.drop_const();
7240 : }
7241 : VMA_ASSERT(false && "Not found!");
7242 : return m_Suballocations.end().drop_const();
7243 : };
7244 : // If requested offset is closer to the end of range, search from the end
7245 : if (offset - first > suballocCount * step / 2)
7246 : {
7247 : return findSuballocation(m_Suballocations.rbegin(), m_Suballocations.rend());
7248 : }
7249 : return findSuballocation(m_Suballocations.begin(), m_Suballocations.end());
7250 : }
7251 :
7252 : bool VmaBlockMetadata_Generic::ValidateFreeSuballocationList() const
7253 : {
7254 : VkDeviceSize lastSize = 0;
7255 : for (size_t i = 0, count = m_FreeSuballocationsBySize.size(); i < count; ++i)
7256 : {
7257 : const VmaSuballocationList::iterator it = m_FreeSuballocationsBySize[i];
7258 :
7259 : VMA_VALIDATE(it->type == VMA_SUBALLOCATION_TYPE_FREE);
7260 : VMA_VALIDATE(it->size >= lastSize);
7261 : lastSize = it->size;
7262 : }
7263 : return true;
7264 : }
7265 :
7266 : bool VmaBlockMetadata_Generic::CheckAllocation(
7267 : VkDeviceSize allocSize,
7268 : VkDeviceSize allocAlignment,
7269 : VmaSuballocationType allocType,
7270 : VmaSuballocationList::const_iterator suballocItem,
7271 : VmaAllocHandle* pAllocHandle) const
7272 : {
7273 : VMA_ASSERT(allocSize > 0);
7274 : VMA_ASSERT(allocType != VMA_SUBALLOCATION_TYPE_FREE);
7275 : VMA_ASSERT(suballocItem != m_Suballocations.cend());
7276 : VMA_ASSERT(pAllocHandle != VMA_NULL);
7277 :
7278 : const VkDeviceSize debugMargin = GetDebugMargin();
7279 : const VkDeviceSize bufferImageGranularity = GetBufferImageGranularity();
7280 :
7281 : const VmaSuballocation& suballoc = *suballocItem;
7282 : VMA_ASSERT(suballoc.type == VMA_SUBALLOCATION_TYPE_FREE);
7283 :
7284 : // Size of this suballocation is too small for this request: Early return.
7285 : if (suballoc.size < allocSize)
7286 : {
7287 : return false;
7288 : }
7289 :
7290 : // Start from offset equal to beginning of this suballocation.
7291 : VkDeviceSize offset = suballoc.offset + (suballocItem == m_Suballocations.cbegin() ? 0 : GetDebugMargin());
7292 :
7293 : // Apply debugMargin from the end of previous alloc.
7294 : if (debugMargin > 0)
7295 : {
7296 : offset += debugMargin;
7297 : }
7298 :
7299 : // Apply alignment.
7300 : offset = VmaAlignUp(offset, allocAlignment);
7301 :
7302 : // Check previous suballocations for BufferImageGranularity conflicts.
7303 : // Make bigger alignment if necessary.
7304 : if (bufferImageGranularity > 1 && bufferImageGranularity != allocAlignment)
7305 : {
7306 : bool bufferImageGranularityConflict = false;
7307 : VmaSuballocationList::const_iterator prevSuballocItem = suballocItem;
7308 : while (prevSuballocItem != m_Suballocations.cbegin())
7309 : {
7310 : --prevSuballocItem;
7311 : const VmaSuballocation& prevSuballoc = *prevSuballocItem;
7312 : if (VmaBlocksOnSamePage(prevSuballoc.offset, prevSuballoc.size, offset, bufferImageGranularity))
7313 : {
7314 : if (VmaIsBufferImageGranularityConflict(prevSuballoc.type, allocType))
7315 : {
7316 : bufferImageGranularityConflict = true;
7317 : break;
7318 : }
7319 : }
7320 : else
7321 : // Already on previous page.
7322 : break;
7323 : }
7324 : if (bufferImageGranularityConflict)
7325 : {
7326 : offset = VmaAlignUp(offset, bufferImageGranularity);
7327 : }
7328 : }
7329 :
7330 : // Calculate padding at the beginning based on current offset.
7331 : const VkDeviceSize paddingBegin = offset - suballoc.offset;
7332 :
7333 : // Fail if requested size plus margin after is bigger than size of this suballocation.
7334 : if (paddingBegin + allocSize + debugMargin > suballoc.size)
7335 : {
7336 : return false;
7337 : }
7338 :
7339 : // Check next suballocations for BufferImageGranularity conflicts.
7340 : // If conflict exists, allocation cannot be made here.
7341 : if (allocSize % bufferImageGranularity || offset % bufferImageGranularity)
7342 : {
7343 : VmaSuballocationList::const_iterator nextSuballocItem = suballocItem;
7344 : ++nextSuballocItem;
7345 : while (nextSuballocItem != m_Suballocations.cend())
7346 : {
7347 : const VmaSuballocation& nextSuballoc = *nextSuballocItem;
7348 : if (VmaBlocksOnSamePage(offset, allocSize, nextSuballoc.offset, bufferImageGranularity))
7349 : {
7350 : if (VmaIsBufferImageGranularityConflict(allocType, nextSuballoc.type))
7351 : {
7352 : return false;
7353 : }
7354 : }
7355 : else
7356 : {
7357 : // Already on next page.
7358 : break;
7359 : }
7360 : ++nextSuballocItem;
7361 : }
7362 : }
7363 :
7364 : *pAllocHandle = (VmaAllocHandle)(offset + 1);
7365 : // All tests passed: Success. pAllocHandle is already filled.
7366 : return true;
7367 : }
7368 :
7369 : void VmaBlockMetadata_Generic::MergeFreeWithNext(VmaSuballocationList::iterator item)
7370 : {
7371 : VMA_ASSERT(item != m_Suballocations.end());
7372 : VMA_ASSERT(item->type == VMA_SUBALLOCATION_TYPE_FREE);
7373 :
7374 : VmaSuballocationList::iterator nextItem = item;
7375 : ++nextItem;
7376 : VMA_ASSERT(nextItem != m_Suballocations.end());
7377 : VMA_ASSERT(nextItem->type == VMA_SUBALLOCATION_TYPE_FREE);
7378 :
7379 : item->size += nextItem->size;
7380 : --m_FreeCount;
7381 : m_Suballocations.erase(nextItem);
7382 : }
7383 :
7384 : VmaSuballocationList::iterator VmaBlockMetadata_Generic::FreeSuballocation(VmaSuballocationList::iterator suballocItem)
7385 : {
7386 : // Change this suballocation to be marked as free.
7387 : VmaSuballocation& suballoc = *suballocItem;
7388 : suballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
7389 : suballoc.userData = VMA_NULL;
7390 :
7391 : // Update totals.
7392 : ++m_FreeCount;
7393 : m_SumFreeSize += suballoc.size;
7394 :
7395 : // Merge with previous and/or next suballocation if it's also free.
7396 : bool mergeWithNext = false;
7397 : bool mergeWithPrev = false;
7398 :
7399 : VmaSuballocationList::iterator nextItem = suballocItem;
7400 : ++nextItem;
7401 : if ((nextItem != m_Suballocations.end()) && (nextItem->type == VMA_SUBALLOCATION_TYPE_FREE))
7402 : {
7403 : mergeWithNext = true;
7404 : }
7405 :
7406 : VmaSuballocationList::iterator prevItem = suballocItem;
7407 : if (suballocItem != m_Suballocations.begin())
7408 : {
7409 : --prevItem;
7410 : if (prevItem->type == VMA_SUBALLOCATION_TYPE_FREE)
7411 : {
7412 : mergeWithPrev = true;
7413 : }
7414 : }
7415 :
7416 : if (mergeWithNext)
7417 : {
7418 : UnregisterFreeSuballocation(nextItem);
7419 : MergeFreeWithNext(suballocItem);
7420 : }
7421 :
7422 : if (mergeWithPrev)
7423 : {
7424 : UnregisterFreeSuballocation(prevItem);
7425 : MergeFreeWithNext(prevItem);
7426 : RegisterFreeSuballocation(prevItem);
7427 : return prevItem;
7428 : }
7429 : else
7430 : {
7431 : RegisterFreeSuballocation(suballocItem);
7432 : return suballocItem;
7433 : }
7434 : }
7435 :
7436 : void VmaBlockMetadata_Generic::RegisterFreeSuballocation(VmaSuballocationList::iterator item)
7437 : {
7438 : VMA_ASSERT(item->type == VMA_SUBALLOCATION_TYPE_FREE);
7439 : VMA_ASSERT(item->size > 0);
7440 :
7441 : // You may want to enable this validation at the beginning or at the end of
7442 : // this function, depending on what do you want to check.
7443 : VMA_HEAVY_ASSERT(ValidateFreeSuballocationList());
7444 :
7445 : if (m_FreeSuballocationsBySize.empty())
7446 : {
7447 : m_FreeSuballocationsBySize.push_back(item);
7448 : }
7449 : else
7450 : {
7451 : VmaVectorInsertSorted<VmaSuballocationItemSizeLess>(m_FreeSuballocationsBySize, item);
7452 : }
7453 :
7454 : //VMA_HEAVY_ASSERT(ValidateFreeSuballocationList());
7455 : }
7456 :
7457 : void VmaBlockMetadata_Generic::UnregisterFreeSuballocation(VmaSuballocationList::iterator item)
7458 : {
7459 : VMA_ASSERT(item->type == VMA_SUBALLOCATION_TYPE_FREE);
7460 : VMA_ASSERT(item->size > 0);
7461 :
7462 : // You may want to enable this validation at the beginning or at the end of
7463 : // this function, depending on what do you want to check.
7464 : VMA_HEAVY_ASSERT(ValidateFreeSuballocationList());
7465 :
7466 : VmaSuballocationList::iterator* const it = VmaBinaryFindFirstNotLess(
7467 : m_FreeSuballocationsBySize.data(),
7468 : m_FreeSuballocationsBySize.data() + m_FreeSuballocationsBySize.size(),
7469 : item,
7470 : VmaSuballocationItemSizeLess());
7471 : for (size_t index = it - m_FreeSuballocationsBySize.data();
7472 : index < m_FreeSuballocationsBySize.size();
7473 : ++index)
7474 : {
7475 : if (m_FreeSuballocationsBySize[index] == item)
7476 : {
7477 : VmaVectorRemove(m_FreeSuballocationsBySize, index);
7478 : return;
7479 : }
7480 : VMA_ASSERT((m_FreeSuballocationsBySize[index]->size == item->size) && "Not found.");
7481 : }
7482 : VMA_ASSERT(0 && "Not found.");
7483 :
7484 : //VMA_HEAVY_ASSERT(ValidateFreeSuballocationList());
7485 : }
7486 : #endif // _VMA_BLOCK_METADATA_GENERIC_FUNCTIONS
7487 : #endif // _VMA_BLOCK_METADATA_GENERIC
7488 : #endif // #if 0
7489 :
7490 : #ifndef _VMA_BLOCK_METADATA_LINEAR
7491 : /*
7492 : Allocations and their references in internal data structure look like this:
7493 :
7494 : if(m_2ndVectorMode == SECOND_VECTOR_EMPTY):
7495 :
7496 : 0 +-------+
7497 : | |
7498 : | |
7499 : | |
7500 : +-------+
7501 : | Alloc | 1st[m_1stNullItemsBeginCount]
7502 : +-------+
7503 : | Alloc | 1st[m_1stNullItemsBeginCount + 1]
7504 : +-------+
7505 : | ... |
7506 : +-------+
7507 : | Alloc | 1st[1st.size() - 1]
7508 : +-------+
7509 : | |
7510 : | |
7511 : | |
7512 : GetSize() +-------+
7513 :
7514 : if(m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER):
7515 :
7516 : 0 +-------+
7517 : | Alloc | 2nd[0]
7518 : +-------+
7519 : | Alloc | 2nd[1]
7520 : +-------+
7521 : | ... |
7522 : +-------+
7523 : | Alloc | 2nd[2nd.size() - 1]
7524 : +-------+
7525 : | |
7526 : | |
7527 : | |
7528 : +-------+
7529 : | Alloc | 1st[m_1stNullItemsBeginCount]
7530 : +-------+
7531 : | Alloc | 1st[m_1stNullItemsBeginCount + 1]
7532 : +-------+
7533 : | ... |
7534 : +-------+
7535 : | Alloc | 1st[1st.size() - 1]
7536 : +-------+
7537 : | |
7538 : GetSize() +-------+
7539 :
7540 : if(m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK):
7541 :
7542 : 0 +-------+
7543 : | |
7544 : | |
7545 : | |
7546 : +-------+
7547 : | Alloc | 1st[m_1stNullItemsBeginCount]
7548 : +-------+
7549 : | Alloc | 1st[m_1stNullItemsBeginCount + 1]
7550 : +-------+
7551 : | ... |
7552 : +-------+
7553 : | Alloc | 1st[1st.size() - 1]
7554 : +-------+
7555 : | |
7556 : | |
7557 : | |
7558 : +-------+
7559 : | Alloc | 2nd[2nd.size() - 1]
7560 : +-------+
7561 : | ... |
7562 : +-------+
7563 : | Alloc | 2nd[1]
7564 : +-------+
7565 : | Alloc | 2nd[0]
7566 : GetSize() +-------+
7567 :
7568 : */
7569 : class VmaBlockMetadata_Linear : public VmaBlockMetadata
7570 : {
7571 : VMA_CLASS_NO_COPY(VmaBlockMetadata_Linear)
7572 : public:
7573 : VmaBlockMetadata_Linear(const VkAllocationCallbacks* pAllocationCallbacks,
7574 : VkDeviceSize bufferImageGranularity, bool isVirtual);
7575 0 : virtual ~VmaBlockMetadata_Linear() = default;
7576 :
7577 0 : VkDeviceSize GetSumFreeSize() const override { return m_SumFreeSize; }
7578 0 : bool IsEmpty() const override { return GetAllocationCount() == 0; }
7579 0 : VkDeviceSize GetAllocationOffset(VmaAllocHandle allocHandle) const override { return (VkDeviceSize)allocHandle - 1; };
7580 :
7581 : void Init(VkDeviceSize size) override;
7582 : bool Validate() const override;
7583 : size_t GetAllocationCount() const override;
7584 : size_t GetFreeRegionsCount() const override;
7585 :
7586 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const override;
7587 : void AddStatistics(VmaStatistics& inoutStats) const override;
7588 :
7589 : #if VMA_STATS_STRING_ENABLED
7590 : void PrintDetailedMap(class VmaJsonWriter& json) const override;
7591 : #endif
7592 :
7593 : bool CreateAllocationRequest(
7594 : VkDeviceSize allocSize,
7595 : VkDeviceSize allocAlignment,
7596 : bool upperAddress,
7597 : VmaSuballocationType allocType,
7598 : uint32_t strategy,
7599 : VmaAllocationRequest* pAllocationRequest) override;
7600 :
7601 : VkResult CheckCorruption(const void* pBlockData) override;
7602 :
7603 : void Alloc(
7604 : const VmaAllocationRequest& request,
7605 : VmaSuballocationType type,
7606 : void* userData) override;
7607 :
7608 : void Free(VmaAllocHandle allocHandle) override;
7609 : void GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo) override;
7610 : void* GetAllocationUserData(VmaAllocHandle allocHandle) const override;
7611 : VmaAllocHandle GetAllocationListBegin() const override;
7612 : VmaAllocHandle GetNextAllocation(VmaAllocHandle prevAlloc) const override;
7613 : VkDeviceSize GetNextFreeRegionSize(VmaAllocHandle alloc) const override;
7614 : void Clear() override;
7615 : void SetAllocationUserData(VmaAllocHandle allocHandle, void* userData) override;
7616 : void DebugLogAllAllocations() const override;
7617 :
7618 : private:
7619 : /*
7620 : There are two suballocation vectors, used in ping-pong way.
7621 : The one with index m_1stVectorIndex is called 1st.
7622 : The one with index (m_1stVectorIndex ^ 1) is called 2nd.
7623 : 2nd can be non-empty only when 1st is not empty.
7624 : When 2nd is not empty, m_2ndVectorMode indicates its mode of operation.
7625 : */
7626 : typedef VmaVector<VmaSuballocation, VmaStlAllocator<VmaSuballocation>> SuballocationVectorType;
7627 :
7628 : enum SECOND_VECTOR_MODE
7629 : {
7630 : SECOND_VECTOR_EMPTY,
7631 : /*
7632 : Suballocations in 2nd vector are created later than the ones in 1st, but they
7633 : all have smaller offset.
7634 : */
7635 : SECOND_VECTOR_RING_BUFFER,
7636 : /*
7637 : Suballocations in 2nd vector are upper side of double stack.
7638 : They all have offsets higher than those in 1st vector.
7639 : Top of this stack means smaller offsets, but higher indices in this vector.
7640 : */
7641 : SECOND_VECTOR_DOUBLE_STACK,
7642 : };
7643 :
7644 : VkDeviceSize m_SumFreeSize;
7645 : SuballocationVectorType m_Suballocations0, m_Suballocations1;
7646 : uint32_t m_1stVectorIndex;
7647 : SECOND_VECTOR_MODE m_2ndVectorMode;
7648 : // Number of items in 1st vector with hAllocation = null at the beginning.
7649 : size_t m_1stNullItemsBeginCount;
7650 : // Number of other items in 1st vector with hAllocation = null somewhere in the middle.
7651 : size_t m_1stNullItemsMiddleCount;
7652 : // Number of items in 2nd vector with hAllocation = null.
7653 : size_t m_2ndNullItemsCount;
7654 :
7655 0 : SuballocationVectorType& AccessSuballocations1st() { return m_1stVectorIndex ? m_Suballocations1 : m_Suballocations0; }
7656 0 : SuballocationVectorType& AccessSuballocations2nd() { return m_1stVectorIndex ? m_Suballocations0 : m_Suballocations1; }
7657 0 : const SuballocationVectorType& AccessSuballocations1st() const { return m_1stVectorIndex ? m_Suballocations1 : m_Suballocations0; }
7658 0 : const SuballocationVectorType& AccessSuballocations2nd() const { return m_1stVectorIndex ? m_Suballocations0 : m_Suballocations1; }
7659 :
7660 : VmaSuballocation& FindSuballocation(VkDeviceSize offset) const;
7661 : bool ShouldCompact1st() const;
7662 : void CleanupAfterFree();
7663 :
7664 : bool CreateAllocationRequest_LowerAddress(
7665 : VkDeviceSize allocSize,
7666 : VkDeviceSize allocAlignment,
7667 : VmaSuballocationType allocType,
7668 : uint32_t strategy,
7669 : VmaAllocationRequest* pAllocationRequest);
7670 : bool CreateAllocationRequest_UpperAddress(
7671 : VkDeviceSize allocSize,
7672 : VkDeviceSize allocAlignment,
7673 : VmaSuballocationType allocType,
7674 : uint32_t strategy,
7675 : VmaAllocationRequest* pAllocationRequest);
7676 : };
7677 :
7678 : #ifndef _VMA_BLOCK_METADATA_LINEAR_FUNCTIONS
7679 0 : VmaBlockMetadata_Linear::VmaBlockMetadata_Linear(const VkAllocationCallbacks* pAllocationCallbacks,
7680 0 : VkDeviceSize bufferImageGranularity, bool isVirtual)
7681 : : VmaBlockMetadata(pAllocationCallbacks, bufferImageGranularity, isVirtual),
7682 : m_SumFreeSize(0),
7683 0 : m_Suballocations0(VmaStlAllocator<VmaSuballocation>(pAllocationCallbacks)),
7684 0 : m_Suballocations1(VmaStlAllocator<VmaSuballocation>(pAllocationCallbacks)),
7685 : m_1stVectorIndex(0),
7686 : m_2ndVectorMode(SECOND_VECTOR_EMPTY),
7687 : m_1stNullItemsBeginCount(0),
7688 : m_1stNullItemsMiddleCount(0),
7689 0 : m_2ndNullItemsCount(0) {}
7690 :
7691 0 : void VmaBlockMetadata_Linear::Init(VkDeviceSize size)
7692 : {
7693 0 : VmaBlockMetadata::Init(size);
7694 0 : m_SumFreeSize = size;
7695 0 : }
7696 :
7697 0 : bool VmaBlockMetadata_Linear::Validate() const
7698 : {
7699 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
7700 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
7701 :
7702 0 : VMA_VALIDATE(suballocations2nd.empty() == (m_2ndVectorMode == SECOND_VECTOR_EMPTY));
7703 0 : VMA_VALIDATE(!suballocations1st.empty() ||
7704 : suballocations2nd.empty() ||
7705 : m_2ndVectorMode != SECOND_VECTOR_RING_BUFFER);
7706 :
7707 0 : if (!suballocations1st.empty())
7708 : {
7709 : // Null item at the beginning should be accounted into m_1stNullItemsBeginCount.
7710 0 : VMA_VALIDATE(suballocations1st[m_1stNullItemsBeginCount].type != VMA_SUBALLOCATION_TYPE_FREE);
7711 : // Null item at the end should be just pop_back().
7712 0 : VMA_VALIDATE(suballocations1st.back().type != VMA_SUBALLOCATION_TYPE_FREE);
7713 : }
7714 0 : if (!suballocations2nd.empty())
7715 : {
7716 : // Null item at the end should be just pop_back().
7717 0 : VMA_VALIDATE(suballocations2nd.back().type != VMA_SUBALLOCATION_TYPE_FREE);
7718 : }
7719 :
7720 0 : VMA_VALIDATE(m_1stNullItemsBeginCount + m_1stNullItemsMiddleCount <= suballocations1st.size());
7721 0 : VMA_VALIDATE(m_2ndNullItemsCount <= suballocations2nd.size());
7722 :
7723 0 : VkDeviceSize sumUsedSize = 0;
7724 0 : const size_t suballoc1stCount = suballocations1st.size();
7725 0 : const VkDeviceSize debugMargin = GetDebugMargin();
7726 0 : VkDeviceSize offset = 0;
7727 :
7728 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
7729 : {
7730 0 : const size_t suballoc2ndCount = suballocations2nd.size();
7731 0 : size_t nullItem2ndCount = 0;
7732 0 : for (size_t i = 0; i < suballoc2ndCount; ++i)
7733 : {
7734 0 : const VmaSuballocation& suballoc = suballocations2nd[i];
7735 0 : const bool currFree = (suballoc.type == VMA_SUBALLOCATION_TYPE_FREE);
7736 :
7737 0 : VmaAllocation const alloc = (VmaAllocation)suballoc.userData;
7738 0 : if (!IsVirtual())
7739 : {
7740 0 : VMA_VALIDATE(currFree == (alloc == VK_NULL_HANDLE));
7741 : }
7742 0 : VMA_VALIDATE(suballoc.offset >= offset);
7743 :
7744 0 : if (!currFree)
7745 : {
7746 0 : if (!IsVirtual())
7747 : {
7748 0 : VMA_VALIDATE((VkDeviceSize)alloc->GetAllocHandle() == suballoc.offset + 1);
7749 0 : VMA_VALIDATE(alloc->GetSize() == suballoc.size);
7750 : }
7751 0 : sumUsedSize += suballoc.size;
7752 : }
7753 : else
7754 : {
7755 0 : ++nullItem2ndCount;
7756 : }
7757 :
7758 0 : offset = suballoc.offset + suballoc.size + debugMargin;
7759 : }
7760 :
7761 0 : VMA_VALIDATE(nullItem2ndCount == m_2ndNullItemsCount);
7762 : }
7763 :
7764 0 : for (size_t i = 0; i < m_1stNullItemsBeginCount; ++i)
7765 : {
7766 0 : const VmaSuballocation& suballoc = suballocations1st[i];
7767 0 : VMA_VALIDATE(suballoc.type == VMA_SUBALLOCATION_TYPE_FREE &&
7768 : suballoc.userData == VMA_NULL);
7769 : }
7770 :
7771 0 : size_t nullItem1stCount = m_1stNullItemsBeginCount;
7772 :
7773 0 : for (size_t i = m_1stNullItemsBeginCount; i < suballoc1stCount; ++i)
7774 : {
7775 0 : const VmaSuballocation& suballoc = suballocations1st[i];
7776 0 : const bool currFree = (suballoc.type == VMA_SUBALLOCATION_TYPE_FREE);
7777 :
7778 0 : VmaAllocation const alloc = (VmaAllocation)suballoc.userData;
7779 0 : if (!IsVirtual())
7780 : {
7781 0 : VMA_VALIDATE(currFree == (alloc == VK_NULL_HANDLE));
7782 : }
7783 0 : VMA_VALIDATE(suballoc.offset >= offset);
7784 0 : VMA_VALIDATE(i >= m_1stNullItemsBeginCount || currFree);
7785 :
7786 0 : if (!currFree)
7787 : {
7788 0 : if (!IsVirtual())
7789 : {
7790 0 : VMA_VALIDATE((VkDeviceSize)alloc->GetAllocHandle() == suballoc.offset + 1);
7791 0 : VMA_VALIDATE(alloc->GetSize() == suballoc.size);
7792 : }
7793 0 : sumUsedSize += suballoc.size;
7794 : }
7795 : else
7796 : {
7797 0 : ++nullItem1stCount;
7798 : }
7799 :
7800 0 : offset = suballoc.offset + suballoc.size + debugMargin;
7801 : }
7802 0 : VMA_VALIDATE(nullItem1stCount == m_1stNullItemsBeginCount + m_1stNullItemsMiddleCount);
7803 :
7804 0 : if (m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
7805 : {
7806 0 : const size_t suballoc2ndCount = suballocations2nd.size();
7807 0 : size_t nullItem2ndCount = 0;
7808 0 : for (size_t i = suballoc2ndCount; i--; )
7809 : {
7810 0 : const VmaSuballocation& suballoc = suballocations2nd[i];
7811 0 : const bool currFree = (suballoc.type == VMA_SUBALLOCATION_TYPE_FREE);
7812 :
7813 0 : VmaAllocation const alloc = (VmaAllocation)suballoc.userData;
7814 0 : if (!IsVirtual())
7815 : {
7816 0 : VMA_VALIDATE(currFree == (alloc == VK_NULL_HANDLE));
7817 : }
7818 0 : VMA_VALIDATE(suballoc.offset >= offset);
7819 :
7820 0 : if (!currFree)
7821 : {
7822 0 : if (!IsVirtual())
7823 : {
7824 0 : VMA_VALIDATE((VkDeviceSize)alloc->GetAllocHandle() == suballoc.offset + 1);
7825 0 : VMA_VALIDATE(alloc->GetSize() == suballoc.size);
7826 : }
7827 0 : sumUsedSize += suballoc.size;
7828 : }
7829 : else
7830 : {
7831 0 : ++nullItem2ndCount;
7832 : }
7833 :
7834 0 : offset = suballoc.offset + suballoc.size + debugMargin;
7835 : }
7836 :
7837 0 : VMA_VALIDATE(nullItem2ndCount == m_2ndNullItemsCount);
7838 : }
7839 :
7840 0 : VMA_VALIDATE(offset <= GetSize());
7841 0 : VMA_VALIDATE(m_SumFreeSize == GetSize() - sumUsedSize);
7842 :
7843 0 : return true;
7844 : }
7845 :
7846 0 : size_t VmaBlockMetadata_Linear::GetAllocationCount() const
7847 : {
7848 0 : return AccessSuballocations1st().size() - m_1stNullItemsBeginCount - m_1stNullItemsMiddleCount +
7849 0 : AccessSuballocations2nd().size() - m_2ndNullItemsCount;
7850 : }
7851 :
7852 0 : size_t VmaBlockMetadata_Linear::GetFreeRegionsCount() const
7853 : {
7854 : // Function only used for defragmentation, which is disabled for this algorithm
7855 0 : VMA_ASSERT(0);
7856 0 : return SIZE_MAX;
7857 : }
7858 :
7859 0 : void VmaBlockMetadata_Linear::AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const
7860 : {
7861 0 : const VkDeviceSize size = GetSize();
7862 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
7863 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
7864 0 : const size_t suballoc1stCount = suballocations1st.size();
7865 0 : const size_t suballoc2ndCount = suballocations2nd.size();
7866 :
7867 0 : inoutStats.statistics.blockCount++;
7868 0 : inoutStats.statistics.blockBytes += size;
7869 :
7870 0 : VkDeviceSize lastOffset = 0;
7871 :
7872 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
7873 : {
7874 0 : const VkDeviceSize freeSpace2ndTo1stEnd = suballocations1st[m_1stNullItemsBeginCount].offset;
7875 0 : size_t nextAlloc2ndIndex = 0;
7876 0 : while (lastOffset < freeSpace2ndTo1stEnd)
7877 : {
7878 : // Find next non-null allocation or move nextAllocIndex to the end.
7879 0 : while (nextAlloc2ndIndex < suballoc2ndCount &&
7880 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
7881 : {
7882 0 : ++nextAlloc2ndIndex;
7883 : }
7884 :
7885 : // Found non-null allocation.
7886 0 : if (nextAlloc2ndIndex < suballoc2ndCount)
7887 : {
7888 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
7889 :
7890 : // 1. Process free space before this allocation.
7891 0 : if (lastOffset < suballoc.offset)
7892 : {
7893 : // There is free space from lastOffset to suballoc.offset.
7894 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
7895 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
7896 : }
7897 :
7898 : // 2. Process this allocation.
7899 : // There is allocation with suballoc.offset, suballoc.size.
7900 0 : VmaAddDetailedStatisticsAllocation(inoutStats, suballoc.size);
7901 :
7902 : // 3. Prepare for next iteration.
7903 0 : lastOffset = suballoc.offset + suballoc.size;
7904 0 : ++nextAlloc2ndIndex;
7905 : }
7906 : // We are at the end.
7907 : else
7908 : {
7909 : // There is free space from lastOffset to freeSpace2ndTo1stEnd.
7910 0 : if (lastOffset < freeSpace2ndTo1stEnd)
7911 : {
7912 0 : const VkDeviceSize unusedRangeSize = freeSpace2ndTo1stEnd - lastOffset;
7913 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
7914 : }
7915 :
7916 : // End of loop.
7917 0 : lastOffset = freeSpace2ndTo1stEnd;
7918 : }
7919 : }
7920 : }
7921 :
7922 0 : size_t nextAlloc1stIndex = m_1stNullItemsBeginCount;
7923 : const VkDeviceSize freeSpace1stTo2ndEnd =
7924 0 : m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK ? suballocations2nd.back().offset : size;
7925 0 : while (lastOffset < freeSpace1stTo2ndEnd)
7926 : {
7927 : // Find next non-null allocation or move nextAllocIndex to the end.
7928 0 : while (nextAlloc1stIndex < suballoc1stCount &&
7929 0 : suballocations1st[nextAlloc1stIndex].userData == VMA_NULL)
7930 : {
7931 0 : ++nextAlloc1stIndex;
7932 : }
7933 :
7934 : // Found non-null allocation.
7935 0 : if (nextAlloc1stIndex < suballoc1stCount)
7936 : {
7937 0 : const VmaSuballocation& suballoc = suballocations1st[nextAlloc1stIndex];
7938 :
7939 : // 1. Process free space before this allocation.
7940 0 : if (lastOffset < suballoc.offset)
7941 : {
7942 : // There is free space from lastOffset to suballoc.offset.
7943 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
7944 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
7945 : }
7946 :
7947 : // 2. Process this allocation.
7948 : // There is allocation with suballoc.offset, suballoc.size.
7949 0 : VmaAddDetailedStatisticsAllocation(inoutStats, suballoc.size);
7950 :
7951 : // 3. Prepare for next iteration.
7952 0 : lastOffset = suballoc.offset + suballoc.size;
7953 0 : ++nextAlloc1stIndex;
7954 : }
7955 : // We are at the end.
7956 : else
7957 : {
7958 : // There is free space from lastOffset to freeSpace1stTo2ndEnd.
7959 0 : if (lastOffset < freeSpace1stTo2ndEnd)
7960 : {
7961 0 : const VkDeviceSize unusedRangeSize = freeSpace1stTo2ndEnd - lastOffset;
7962 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
7963 : }
7964 :
7965 : // End of loop.
7966 0 : lastOffset = freeSpace1stTo2ndEnd;
7967 : }
7968 : }
7969 :
7970 0 : if (m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
7971 : {
7972 0 : size_t nextAlloc2ndIndex = suballocations2nd.size() - 1;
7973 0 : while (lastOffset < size)
7974 : {
7975 : // Find next non-null allocation or move nextAllocIndex to the end.
7976 0 : while (nextAlloc2ndIndex != SIZE_MAX &&
7977 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
7978 : {
7979 0 : --nextAlloc2ndIndex;
7980 : }
7981 :
7982 : // Found non-null allocation.
7983 0 : if (nextAlloc2ndIndex != SIZE_MAX)
7984 : {
7985 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
7986 :
7987 : // 1. Process free space before this allocation.
7988 0 : if (lastOffset < suballoc.offset)
7989 : {
7990 : // There is free space from lastOffset to suballoc.offset.
7991 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
7992 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
7993 : }
7994 :
7995 : // 2. Process this allocation.
7996 : // There is allocation with suballoc.offset, suballoc.size.
7997 0 : VmaAddDetailedStatisticsAllocation(inoutStats, suballoc.size);
7998 :
7999 : // 3. Prepare for next iteration.
8000 0 : lastOffset = suballoc.offset + suballoc.size;
8001 0 : --nextAlloc2ndIndex;
8002 : }
8003 : // We are at the end.
8004 : else
8005 : {
8006 : // There is free space from lastOffset to size.
8007 0 : if (lastOffset < size)
8008 : {
8009 0 : const VkDeviceSize unusedRangeSize = size - lastOffset;
8010 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusedRangeSize);
8011 : }
8012 :
8013 : // End of loop.
8014 0 : lastOffset = size;
8015 : }
8016 : }
8017 : }
8018 0 : }
8019 :
8020 0 : void VmaBlockMetadata_Linear::AddStatistics(VmaStatistics& inoutStats) const
8021 : {
8022 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8023 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8024 0 : const VkDeviceSize size = GetSize();
8025 0 : const size_t suballoc1stCount = suballocations1st.size();
8026 0 : const size_t suballoc2ndCount = suballocations2nd.size();
8027 :
8028 0 : inoutStats.blockCount++;
8029 0 : inoutStats.blockBytes += size;
8030 0 : inoutStats.allocationBytes += size - m_SumFreeSize;
8031 :
8032 0 : VkDeviceSize lastOffset = 0;
8033 :
8034 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
8035 : {
8036 0 : const VkDeviceSize freeSpace2ndTo1stEnd = suballocations1st[m_1stNullItemsBeginCount].offset;
8037 0 : size_t nextAlloc2ndIndex = m_1stNullItemsBeginCount;
8038 0 : while (lastOffset < freeSpace2ndTo1stEnd)
8039 : {
8040 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8041 0 : while (nextAlloc2ndIndex < suballoc2ndCount &&
8042 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8043 : {
8044 0 : ++nextAlloc2ndIndex;
8045 : }
8046 :
8047 : // Found non-null allocation.
8048 0 : if (nextAlloc2ndIndex < suballoc2ndCount)
8049 : {
8050 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8051 :
8052 : // 1. Process free space before this allocation.
8053 0 : if (lastOffset < suballoc.offset)
8054 : {
8055 : // There is free space from lastOffset to suballoc.offset.
8056 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8057 : }
8058 :
8059 : // 2. Process this allocation.
8060 : // There is allocation with suballoc.offset, suballoc.size.
8061 0 : ++inoutStats.allocationCount;
8062 :
8063 : // 3. Prepare for next iteration.
8064 0 : lastOffset = suballoc.offset + suballoc.size;
8065 0 : ++nextAlloc2ndIndex;
8066 : }
8067 : // We are at the end.
8068 : else
8069 : {
8070 0 : if (lastOffset < freeSpace2ndTo1stEnd)
8071 : {
8072 : // There is free space from lastOffset to freeSpace2ndTo1stEnd.
8073 0 : const VkDeviceSize unusedRangeSize = freeSpace2ndTo1stEnd - lastOffset;
8074 : }
8075 :
8076 : // End of loop.
8077 0 : lastOffset = freeSpace2ndTo1stEnd;
8078 : }
8079 : }
8080 : }
8081 :
8082 0 : size_t nextAlloc1stIndex = m_1stNullItemsBeginCount;
8083 : const VkDeviceSize freeSpace1stTo2ndEnd =
8084 0 : m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK ? suballocations2nd.back().offset : size;
8085 0 : while (lastOffset < freeSpace1stTo2ndEnd)
8086 : {
8087 : // Find next non-null allocation or move nextAllocIndex to the end.
8088 0 : while (nextAlloc1stIndex < suballoc1stCount &&
8089 0 : suballocations1st[nextAlloc1stIndex].userData == VMA_NULL)
8090 : {
8091 0 : ++nextAlloc1stIndex;
8092 : }
8093 :
8094 : // Found non-null allocation.
8095 0 : if (nextAlloc1stIndex < suballoc1stCount)
8096 : {
8097 0 : const VmaSuballocation& suballoc = suballocations1st[nextAlloc1stIndex];
8098 :
8099 : // 1. Process free space before this allocation.
8100 0 : if (lastOffset < suballoc.offset)
8101 : {
8102 : // There is free space from lastOffset to suballoc.offset.
8103 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8104 : }
8105 :
8106 : // 2. Process this allocation.
8107 : // There is allocation with suballoc.offset, suballoc.size.
8108 0 : ++inoutStats.allocationCount;
8109 :
8110 : // 3. Prepare for next iteration.
8111 0 : lastOffset = suballoc.offset + suballoc.size;
8112 0 : ++nextAlloc1stIndex;
8113 : }
8114 : // We are at the end.
8115 : else
8116 : {
8117 0 : if (lastOffset < freeSpace1stTo2ndEnd)
8118 : {
8119 : // There is free space from lastOffset to freeSpace1stTo2ndEnd.
8120 0 : const VkDeviceSize unusedRangeSize = freeSpace1stTo2ndEnd - lastOffset;
8121 : }
8122 :
8123 : // End of loop.
8124 0 : lastOffset = freeSpace1stTo2ndEnd;
8125 : }
8126 : }
8127 :
8128 0 : if (m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8129 : {
8130 0 : size_t nextAlloc2ndIndex = suballocations2nd.size() - 1;
8131 0 : while (lastOffset < size)
8132 : {
8133 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8134 0 : while (nextAlloc2ndIndex != SIZE_MAX &&
8135 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8136 : {
8137 0 : --nextAlloc2ndIndex;
8138 : }
8139 :
8140 : // Found non-null allocation.
8141 0 : if (nextAlloc2ndIndex != SIZE_MAX)
8142 : {
8143 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8144 :
8145 : // 1. Process free space before this allocation.
8146 0 : if (lastOffset < suballoc.offset)
8147 : {
8148 : // There is free space from lastOffset to suballoc.offset.
8149 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8150 : }
8151 :
8152 : // 2. Process this allocation.
8153 : // There is allocation with suballoc.offset, suballoc.size.
8154 0 : ++inoutStats.allocationCount;
8155 :
8156 : // 3. Prepare for next iteration.
8157 0 : lastOffset = suballoc.offset + suballoc.size;
8158 0 : --nextAlloc2ndIndex;
8159 : }
8160 : // We are at the end.
8161 : else
8162 : {
8163 0 : if (lastOffset < size)
8164 : {
8165 : // There is free space from lastOffset to size.
8166 0 : const VkDeviceSize unusedRangeSize = size - lastOffset;
8167 : }
8168 :
8169 : // End of loop.
8170 0 : lastOffset = size;
8171 : }
8172 : }
8173 : }
8174 0 : }
8175 :
8176 : #if VMA_STATS_STRING_ENABLED
8177 0 : void VmaBlockMetadata_Linear::PrintDetailedMap(class VmaJsonWriter& json) const
8178 : {
8179 0 : const VkDeviceSize size = GetSize();
8180 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8181 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8182 0 : const size_t suballoc1stCount = suballocations1st.size();
8183 0 : const size_t suballoc2ndCount = suballocations2nd.size();
8184 :
8185 : // FIRST PASS
8186 :
8187 0 : size_t unusedRangeCount = 0;
8188 0 : VkDeviceSize usedBytes = 0;
8189 :
8190 0 : VkDeviceSize lastOffset = 0;
8191 :
8192 0 : size_t alloc2ndCount = 0;
8193 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
8194 : {
8195 0 : const VkDeviceSize freeSpace2ndTo1stEnd = suballocations1st[m_1stNullItemsBeginCount].offset;
8196 0 : size_t nextAlloc2ndIndex = 0;
8197 0 : while (lastOffset < freeSpace2ndTo1stEnd)
8198 : {
8199 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8200 0 : while (nextAlloc2ndIndex < suballoc2ndCount &&
8201 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8202 : {
8203 0 : ++nextAlloc2ndIndex;
8204 : }
8205 :
8206 : // Found non-null allocation.
8207 0 : if (nextAlloc2ndIndex < suballoc2ndCount)
8208 : {
8209 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8210 :
8211 : // 1. Process free space before this allocation.
8212 0 : if (lastOffset < suballoc.offset)
8213 : {
8214 : // There is free space from lastOffset to suballoc.offset.
8215 0 : ++unusedRangeCount;
8216 : }
8217 :
8218 : // 2. Process this allocation.
8219 : // There is allocation with suballoc.offset, suballoc.size.
8220 0 : ++alloc2ndCount;
8221 0 : usedBytes += suballoc.size;
8222 :
8223 : // 3. Prepare for next iteration.
8224 0 : lastOffset = suballoc.offset + suballoc.size;
8225 0 : ++nextAlloc2ndIndex;
8226 : }
8227 : // We are at the end.
8228 : else
8229 : {
8230 0 : if (lastOffset < freeSpace2ndTo1stEnd)
8231 : {
8232 : // There is free space from lastOffset to freeSpace2ndTo1stEnd.
8233 0 : ++unusedRangeCount;
8234 : }
8235 :
8236 : // End of loop.
8237 0 : lastOffset = freeSpace2ndTo1stEnd;
8238 : }
8239 : }
8240 : }
8241 :
8242 0 : size_t nextAlloc1stIndex = m_1stNullItemsBeginCount;
8243 0 : size_t alloc1stCount = 0;
8244 : const VkDeviceSize freeSpace1stTo2ndEnd =
8245 0 : m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK ? suballocations2nd.back().offset : size;
8246 0 : while (lastOffset < freeSpace1stTo2ndEnd)
8247 : {
8248 : // Find next non-null allocation or move nextAllocIndex to the end.
8249 0 : while (nextAlloc1stIndex < suballoc1stCount &&
8250 0 : suballocations1st[nextAlloc1stIndex].userData == VMA_NULL)
8251 : {
8252 0 : ++nextAlloc1stIndex;
8253 : }
8254 :
8255 : // Found non-null allocation.
8256 0 : if (nextAlloc1stIndex < suballoc1stCount)
8257 : {
8258 0 : const VmaSuballocation& suballoc = suballocations1st[nextAlloc1stIndex];
8259 :
8260 : // 1. Process free space before this allocation.
8261 0 : if (lastOffset < suballoc.offset)
8262 : {
8263 : // There is free space from lastOffset to suballoc.offset.
8264 0 : ++unusedRangeCount;
8265 : }
8266 :
8267 : // 2. Process this allocation.
8268 : // There is allocation with suballoc.offset, suballoc.size.
8269 0 : ++alloc1stCount;
8270 0 : usedBytes += suballoc.size;
8271 :
8272 : // 3. Prepare for next iteration.
8273 0 : lastOffset = suballoc.offset + suballoc.size;
8274 0 : ++nextAlloc1stIndex;
8275 : }
8276 : // We are at the end.
8277 : else
8278 : {
8279 0 : if (lastOffset < size)
8280 : {
8281 : // There is free space from lastOffset to freeSpace1stTo2ndEnd.
8282 0 : ++unusedRangeCount;
8283 : }
8284 :
8285 : // End of loop.
8286 0 : lastOffset = freeSpace1stTo2ndEnd;
8287 : }
8288 : }
8289 :
8290 0 : if (m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8291 : {
8292 0 : size_t nextAlloc2ndIndex = suballocations2nd.size() - 1;
8293 0 : while (lastOffset < size)
8294 : {
8295 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8296 0 : while (nextAlloc2ndIndex != SIZE_MAX &&
8297 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8298 : {
8299 0 : --nextAlloc2ndIndex;
8300 : }
8301 :
8302 : // Found non-null allocation.
8303 0 : if (nextAlloc2ndIndex != SIZE_MAX)
8304 : {
8305 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8306 :
8307 : // 1. Process free space before this allocation.
8308 0 : if (lastOffset < suballoc.offset)
8309 : {
8310 : // There is free space from lastOffset to suballoc.offset.
8311 0 : ++unusedRangeCount;
8312 : }
8313 :
8314 : // 2. Process this allocation.
8315 : // There is allocation with suballoc.offset, suballoc.size.
8316 0 : ++alloc2ndCount;
8317 0 : usedBytes += suballoc.size;
8318 :
8319 : // 3. Prepare for next iteration.
8320 0 : lastOffset = suballoc.offset + suballoc.size;
8321 0 : --nextAlloc2ndIndex;
8322 : }
8323 : // We are at the end.
8324 : else
8325 : {
8326 0 : if (lastOffset < size)
8327 : {
8328 : // There is free space from lastOffset to size.
8329 0 : ++unusedRangeCount;
8330 : }
8331 :
8332 : // End of loop.
8333 0 : lastOffset = size;
8334 : }
8335 : }
8336 : }
8337 :
8338 0 : const VkDeviceSize unusedBytes = size - usedBytes;
8339 0 : PrintDetailedMap_Begin(json, unusedBytes, alloc1stCount + alloc2ndCount, unusedRangeCount);
8340 :
8341 : // SECOND PASS
8342 0 : lastOffset = 0;
8343 :
8344 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
8345 : {
8346 0 : const VkDeviceSize freeSpace2ndTo1stEnd = suballocations1st[m_1stNullItemsBeginCount].offset;
8347 0 : size_t nextAlloc2ndIndex = 0;
8348 0 : while (lastOffset < freeSpace2ndTo1stEnd)
8349 : {
8350 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8351 0 : while (nextAlloc2ndIndex < suballoc2ndCount &&
8352 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8353 : {
8354 0 : ++nextAlloc2ndIndex;
8355 : }
8356 :
8357 : // Found non-null allocation.
8358 0 : if (nextAlloc2ndIndex < suballoc2ndCount)
8359 : {
8360 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8361 :
8362 : // 1. Process free space before this allocation.
8363 0 : if (lastOffset < suballoc.offset)
8364 : {
8365 : // There is free space from lastOffset to suballoc.offset.
8366 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8367 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8368 : }
8369 :
8370 : // 2. Process this allocation.
8371 : // There is allocation with suballoc.offset, suballoc.size.
8372 0 : PrintDetailedMap_Allocation(json, suballoc.offset, suballoc.size, suballoc.userData);
8373 :
8374 : // 3. Prepare for next iteration.
8375 0 : lastOffset = suballoc.offset + suballoc.size;
8376 0 : ++nextAlloc2ndIndex;
8377 : }
8378 : // We are at the end.
8379 : else
8380 : {
8381 0 : if (lastOffset < freeSpace2ndTo1stEnd)
8382 : {
8383 : // There is free space from lastOffset to freeSpace2ndTo1stEnd.
8384 0 : const VkDeviceSize unusedRangeSize = freeSpace2ndTo1stEnd - lastOffset;
8385 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8386 : }
8387 :
8388 : // End of loop.
8389 0 : lastOffset = freeSpace2ndTo1stEnd;
8390 : }
8391 : }
8392 : }
8393 :
8394 0 : nextAlloc1stIndex = m_1stNullItemsBeginCount;
8395 0 : while (lastOffset < freeSpace1stTo2ndEnd)
8396 : {
8397 : // Find next non-null allocation or move nextAllocIndex to the end.
8398 0 : while (nextAlloc1stIndex < suballoc1stCount &&
8399 0 : suballocations1st[nextAlloc1stIndex].userData == VMA_NULL)
8400 : {
8401 0 : ++nextAlloc1stIndex;
8402 : }
8403 :
8404 : // Found non-null allocation.
8405 0 : if (nextAlloc1stIndex < suballoc1stCount)
8406 : {
8407 0 : const VmaSuballocation& suballoc = suballocations1st[nextAlloc1stIndex];
8408 :
8409 : // 1. Process free space before this allocation.
8410 0 : if (lastOffset < suballoc.offset)
8411 : {
8412 : // There is free space from lastOffset to suballoc.offset.
8413 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8414 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8415 : }
8416 :
8417 : // 2. Process this allocation.
8418 : // There is allocation with suballoc.offset, suballoc.size.
8419 0 : PrintDetailedMap_Allocation(json, suballoc.offset, suballoc.size, suballoc.userData);
8420 :
8421 : // 3. Prepare for next iteration.
8422 0 : lastOffset = suballoc.offset + suballoc.size;
8423 0 : ++nextAlloc1stIndex;
8424 : }
8425 : // We are at the end.
8426 : else
8427 : {
8428 0 : if (lastOffset < freeSpace1stTo2ndEnd)
8429 : {
8430 : // There is free space from lastOffset to freeSpace1stTo2ndEnd.
8431 0 : const VkDeviceSize unusedRangeSize = freeSpace1stTo2ndEnd - lastOffset;
8432 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8433 : }
8434 :
8435 : // End of loop.
8436 0 : lastOffset = freeSpace1stTo2ndEnd;
8437 : }
8438 : }
8439 :
8440 0 : if (m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8441 : {
8442 0 : size_t nextAlloc2ndIndex = suballocations2nd.size() - 1;
8443 0 : while (lastOffset < size)
8444 : {
8445 : // Find next non-null allocation or move nextAlloc2ndIndex to the end.
8446 0 : while (nextAlloc2ndIndex != SIZE_MAX &&
8447 0 : suballocations2nd[nextAlloc2ndIndex].userData == VMA_NULL)
8448 : {
8449 0 : --nextAlloc2ndIndex;
8450 : }
8451 :
8452 : // Found non-null allocation.
8453 0 : if (nextAlloc2ndIndex != SIZE_MAX)
8454 : {
8455 0 : const VmaSuballocation& suballoc = suballocations2nd[nextAlloc2ndIndex];
8456 :
8457 : // 1. Process free space before this allocation.
8458 0 : if (lastOffset < suballoc.offset)
8459 : {
8460 : // There is free space from lastOffset to suballoc.offset.
8461 0 : const VkDeviceSize unusedRangeSize = suballoc.offset - lastOffset;
8462 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8463 : }
8464 :
8465 : // 2. Process this allocation.
8466 : // There is allocation with suballoc.offset, suballoc.size.
8467 0 : PrintDetailedMap_Allocation(json, suballoc.offset, suballoc.size, suballoc.userData);
8468 :
8469 : // 3. Prepare for next iteration.
8470 0 : lastOffset = suballoc.offset + suballoc.size;
8471 0 : --nextAlloc2ndIndex;
8472 : }
8473 : // We are at the end.
8474 : else
8475 : {
8476 0 : if (lastOffset < size)
8477 : {
8478 : // There is free space from lastOffset to size.
8479 0 : const VkDeviceSize unusedRangeSize = size - lastOffset;
8480 0 : PrintDetailedMap_UnusedRange(json, lastOffset, unusedRangeSize);
8481 : }
8482 :
8483 : // End of loop.
8484 0 : lastOffset = size;
8485 : }
8486 : }
8487 : }
8488 :
8489 0 : PrintDetailedMap_End(json);
8490 0 : }
8491 : #endif // VMA_STATS_STRING_ENABLED
8492 :
8493 0 : bool VmaBlockMetadata_Linear::CreateAllocationRequest(
8494 : VkDeviceSize allocSize,
8495 : VkDeviceSize allocAlignment,
8496 : bool upperAddress,
8497 : VmaSuballocationType allocType,
8498 : uint32_t strategy,
8499 : VmaAllocationRequest* pAllocationRequest)
8500 : {
8501 0 : VMA_ASSERT(allocSize > 0);
8502 0 : VMA_ASSERT(allocType != VMA_SUBALLOCATION_TYPE_FREE);
8503 0 : VMA_ASSERT(pAllocationRequest != VMA_NULL);
8504 0 : VMA_HEAVY_ASSERT(Validate());
8505 0 : pAllocationRequest->size = allocSize;
8506 0 : return upperAddress ?
8507 : CreateAllocationRequest_UpperAddress(
8508 : allocSize, allocAlignment, allocType, strategy, pAllocationRequest) :
8509 : CreateAllocationRequest_LowerAddress(
8510 0 : allocSize, allocAlignment, allocType, strategy, pAllocationRequest);
8511 : }
8512 :
8513 0 : VkResult VmaBlockMetadata_Linear::CheckCorruption(const void* pBlockData)
8514 : {
8515 0 : VMA_ASSERT(!IsVirtual());
8516 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8517 0 : for (size_t i = m_1stNullItemsBeginCount, count = suballocations1st.size(); i < count; ++i)
8518 : {
8519 0 : const VmaSuballocation& suballoc = suballocations1st[i];
8520 0 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
8521 : {
8522 0 : if (!VmaValidateMagicValue(pBlockData, suballoc.offset + suballoc.size))
8523 : {
8524 0 : VMA_ASSERT(0 && "MEMORY CORRUPTION DETECTED AFTER VALIDATED ALLOCATION!");
8525 0 : return VK_ERROR_UNKNOWN_COPY;
8526 : }
8527 : }
8528 : }
8529 :
8530 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8531 0 : for (size_t i = 0, count = suballocations2nd.size(); i < count; ++i)
8532 : {
8533 0 : const VmaSuballocation& suballoc = suballocations2nd[i];
8534 0 : if (suballoc.type != VMA_SUBALLOCATION_TYPE_FREE)
8535 : {
8536 0 : if (!VmaValidateMagicValue(pBlockData, suballoc.offset + suballoc.size))
8537 : {
8538 0 : VMA_ASSERT(0 && "MEMORY CORRUPTION DETECTED AFTER VALIDATED ALLOCATION!");
8539 0 : return VK_ERROR_UNKNOWN_COPY;
8540 : }
8541 : }
8542 : }
8543 :
8544 0 : return VK_SUCCESS;
8545 : }
8546 :
8547 0 : void VmaBlockMetadata_Linear::Alloc(
8548 : const VmaAllocationRequest& request,
8549 : VmaSuballocationType type,
8550 : void* userData)
8551 : {
8552 0 : const VkDeviceSize offset = (VkDeviceSize)request.allocHandle - 1;
8553 0 : const VmaSuballocation newSuballoc = { offset, request.size, userData, type };
8554 :
8555 0 : switch (request.type)
8556 : {
8557 0 : case VmaAllocationRequestType::UpperAddress:
8558 : {
8559 0 : VMA_ASSERT(m_2ndVectorMode != SECOND_VECTOR_RING_BUFFER &&
8560 : "CRITICAL ERROR: Trying to use linear allocator as double stack while it was already used as ring buffer.");
8561 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8562 0 : suballocations2nd.push_back(newSuballoc);
8563 0 : m_2ndVectorMode = SECOND_VECTOR_DOUBLE_STACK;
8564 : }
8565 0 : break;
8566 0 : case VmaAllocationRequestType::EndOf1st:
8567 : {
8568 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8569 :
8570 0 : VMA_ASSERT(suballocations1st.empty() ||
8571 : offset >= suballocations1st.back().offset + suballocations1st.back().size);
8572 : // Check if it fits before the end of the block.
8573 0 : VMA_ASSERT(offset + request.size <= GetSize());
8574 :
8575 0 : suballocations1st.push_back(newSuballoc);
8576 : }
8577 0 : break;
8578 0 : case VmaAllocationRequestType::EndOf2nd:
8579 : {
8580 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8581 : // New allocation at the end of 2-part ring buffer, so before first allocation from 1st vector.
8582 0 : VMA_ASSERT(!suballocations1st.empty() &&
8583 : offset + request.size <= suballocations1st[m_1stNullItemsBeginCount].offset);
8584 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8585 :
8586 0 : switch (m_2ndVectorMode)
8587 : {
8588 0 : case SECOND_VECTOR_EMPTY:
8589 : // First allocation from second part ring buffer.
8590 0 : VMA_ASSERT(suballocations2nd.empty());
8591 0 : m_2ndVectorMode = SECOND_VECTOR_RING_BUFFER;
8592 0 : break;
8593 0 : case SECOND_VECTOR_RING_BUFFER:
8594 : // 2-part ring buffer is already started.
8595 0 : VMA_ASSERT(!suballocations2nd.empty());
8596 0 : break;
8597 0 : case SECOND_VECTOR_DOUBLE_STACK:
8598 0 : VMA_ASSERT(0 && "CRITICAL ERROR: Trying to use linear allocator as ring buffer while it was already used as double stack.");
8599 0 : break;
8600 0 : default:
8601 0 : VMA_ASSERT(0);
8602 : }
8603 :
8604 0 : suballocations2nd.push_back(newSuballoc);
8605 : }
8606 0 : break;
8607 0 : default:
8608 0 : VMA_ASSERT(0 && "CRITICAL INTERNAL ERROR.");
8609 : }
8610 :
8611 0 : m_SumFreeSize -= newSuballoc.size;
8612 0 : }
8613 :
8614 0 : void VmaBlockMetadata_Linear::Free(VmaAllocHandle allocHandle)
8615 : {
8616 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8617 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8618 0 : VkDeviceSize offset = (VkDeviceSize)allocHandle - 1;
8619 :
8620 0 : if (!suballocations1st.empty())
8621 : {
8622 : // First allocation: Mark it as next empty at the beginning.
8623 0 : VmaSuballocation& firstSuballoc = suballocations1st[m_1stNullItemsBeginCount];
8624 0 : if (firstSuballoc.offset == offset)
8625 : {
8626 0 : firstSuballoc.type = VMA_SUBALLOCATION_TYPE_FREE;
8627 0 : firstSuballoc.userData = VMA_NULL;
8628 0 : m_SumFreeSize += firstSuballoc.size;
8629 0 : ++m_1stNullItemsBeginCount;
8630 0 : CleanupAfterFree();
8631 0 : return;
8632 : }
8633 : }
8634 :
8635 : // Last allocation in 2-part ring buffer or top of upper stack (same logic).
8636 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER ||
8637 0 : m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8638 : {
8639 0 : VmaSuballocation& lastSuballoc = suballocations2nd.back();
8640 0 : if (lastSuballoc.offset == offset)
8641 : {
8642 0 : m_SumFreeSize += lastSuballoc.size;
8643 0 : suballocations2nd.pop_back();
8644 0 : CleanupAfterFree();
8645 0 : return;
8646 0 : }
8647 : }
8648 : // Last allocation in 1st vector.
8649 0 : else if (m_2ndVectorMode == SECOND_VECTOR_EMPTY)
8650 : {
8651 0 : VmaSuballocation& lastSuballoc = suballocations1st.back();
8652 0 : if (lastSuballoc.offset == offset)
8653 : {
8654 0 : m_SumFreeSize += lastSuballoc.size;
8655 0 : suballocations1st.pop_back();
8656 0 : CleanupAfterFree();
8657 0 : return;
8658 : }
8659 : }
8660 :
8661 : VmaSuballocation refSuballoc;
8662 0 : refSuballoc.offset = offset;
8663 : // Rest of members stays uninitialized intentionally for better performance.
8664 :
8665 : // Item from the middle of 1st vector.
8666 : {
8667 : const SuballocationVectorType::iterator it = VmaBinaryFindSorted(
8668 0 : suballocations1st.begin() + m_1stNullItemsBeginCount,
8669 0 : suballocations1st.end(),
8670 : refSuballoc,
8671 0 : VmaSuballocationOffsetLess());
8672 0 : if (it != suballocations1st.end())
8673 : {
8674 0 : it->type = VMA_SUBALLOCATION_TYPE_FREE;
8675 0 : it->userData = VMA_NULL;
8676 0 : ++m_1stNullItemsMiddleCount;
8677 0 : m_SumFreeSize += it->size;
8678 0 : CleanupAfterFree();
8679 0 : return;
8680 : }
8681 : }
8682 :
8683 0 : if (m_2ndVectorMode != SECOND_VECTOR_EMPTY)
8684 : {
8685 : // Item from the middle of 2nd vector.
8686 0 : const SuballocationVectorType::iterator it = m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER ?
8687 0 : VmaBinaryFindSorted(suballocations2nd.begin(), suballocations2nd.end(), refSuballoc, VmaSuballocationOffsetLess()) :
8688 0 : VmaBinaryFindSorted(suballocations2nd.begin(), suballocations2nd.end(), refSuballoc, VmaSuballocationOffsetGreater());
8689 0 : if (it != suballocations2nd.end())
8690 : {
8691 0 : it->type = VMA_SUBALLOCATION_TYPE_FREE;
8692 0 : it->userData = VMA_NULL;
8693 0 : ++m_2ndNullItemsCount;
8694 0 : m_SumFreeSize += it->size;
8695 0 : CleanupAfterFree();
8696 0 : return;
8697 : }
8698 : }
8699 :
8700 0 : VMA_ASSERT(0 && "Allocation to free not found in linear allocator!");
8701 : }
8702 :
8703 0 : void VmaBlockMetadata_Linear::GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo)
8704 : {
8705 0 : outInfo.offset = (VkDeviceSize)allocHandle - 1;
8706 0 : VmaSuballocation& suballoc = FindSuballocation(outInfo.offset);
8707 0 : outInfo.size = suballoc.size;
8708 0 : outInfo.pUserData = suballoc.userData;
8709 0 : }
8710 :
8711 0 : void* VmaBlockMetadata_Linear::GetAllocationUserData(VmaAllocHandle allocHandle) const
8712 : {
8713 0 : return FindSuballocation((VkDeviceSize)allocHandle - 1).userData;
8714 : }
8715 :
8716 0 : VmaAllocHandle VmaBlockMetadata_Linear::GetAllocationListBegin() const
8717 : {
8718 : // Function only used for defragmentation, which is disabled for this algorithm
8719 0 : VMA_ASSERT(0);
8720 0 : return VK_NULL_HANDLE;
8721 : }
8722 :
8723 0 : VmaAllocHandle VmaBlockMetadata_Linear::GetNextAllocation(VmaAllocHandle prevAlloc) const
8724 : {
8725 : // Function only used for defragmentation, which is disabled for this algorithm
8726 0 : VMA_ASSERT(0);
8727 0 : return VK_NULL_HANDLE;
8728 : }
8729 :
8730 0 : VkDeviceSize VmaBlockMetadata_Linear::GetNextFreeRegionSize(VmaAllocHandle alloc) const
8731 : {
8732 : // Function only used for defragmentation, which is disabled for this algorithm
8733 0 : VMA_ASSERT(0);
8734 0 : return 0;
8735 : }
8736 :
8737 0 : void VmaBlockMetadata_Linear::Clear()
8738 : {
8739 0 : m_SumFreeSize = GetSize();
8740 0 : m_Suballocations0.clear();
8741 0 : m_Suballocations1.clear();
8742 : // Leaving m_1stVectorIndex unchanged - it doesn't matter.
8743 0 : m_2ndVectorMode = SECOND_VECTOR_EMPTY;
8744 0 : m_1stNullItemsBeginCount = 0;
8745 0 : m_1stNullItemsMiddleCount = 0;
8746 0 : m_2ndNullItemsCount = 0;
8747 0 : }
8748 :
8749 0 : void VmaBlockMetadata_Linear::SetAllocationUserData(VmaAllocHandle allocHandle, void* userData)
8750 : {
8751 0 : VmaSuballocation& suballoc = FindSuballocation((VkDeviceSize)allocHandle - 1);
8752 0 : suballoc.userData = userData;
8753 0 : }
8754 :
8755 0 : void VmaBlockMetadata_Linear::DebugLogAllAllocations() const
8756 : {
8757 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8758 0 : for (auto it = suballocations1st.begin() + m_1stNullItemsBeginCount; it != suballocations1st.end(); ++it)
8759 0 : if (it->type != VMA_SUBALLOCATION_TYPE_FREE)
8760 0 : DebugLogAllocation(it->offset, it->size, it->userData);
8761 :
8762 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8763 0 : for (auto it = suballocations2nd.begin(); it != suballocations2nd.end(); ++it)
8764 0 : if (it->type != VMA_SUBALLOCATION_TYPE_FREE)
8765 0 : DebugLogAllocation(it->offset, it->size, it->userData);
8766 0 : }
8767 :
8768 0 : VmaSuballocation& VmaBlockMetadata_Linear::FindSuballocation(VkDeviceSize offset) const
8769 : {
8770 0 : const SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8771 0 : const SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8772 :
8773 : VmaSuballocation refSuballoc;
8774 0 : refSuballoc.offset = offset;
8775 : // Rest of members stays uninitialized intentionally for better performance.
8776 :
8777 : // Item from the 1st vector.
8778 : {
8779 : SuballocationVectorType::const_iterator it = VmaBinaryFindSorted(
8780 0 : suballocations1st.begin() + m_1stNullItemsBeginCount,
8781 0 : suballocations1st.end(),
8782 : refSuballoc,
8783 0 : VmaSuballocationOffsetLess());
8784 0 : if (it != suballocations1st.end())
8785 : {
8786 0 : return const_cast<VmaSuballocation&>(*it);
8787 : }
8788 : }
8789 :
8790 0 : if (m_2ndVectorMode != SECOND_VECTOR_EMPTY)
8791 : {
8792 : // Rest of members stays uninitialized intentionally for better performance.
8793 0 : SuballocationVectorType::const_iterator it = m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER ?
8794 0 : VmaBinaryFindSorted(suballocations2nd.begin(), suballocations2nd.end(), refSuballoc, VmaSuballocationOffsetLess()) :
8795 0 : VmaBinaryFindSorted(suballocations2nd.begin(), suballocations2nd.end(), refSuballoc, VmaSuballocationOffsetGreater());
8796 0 : if (it != suballocations2nd.end())
8797 : {
8798 0 : return const_cast<VmaSuballocation&>(*it);
8799 : }
8800 : }
8801 :
8802 0 : VMA_ASSERT(0 && "Allocation not found in linear allocator!");
8803 0 : return const_cast<VmaSuballocation&>(suballocations1st.back()); // Should never occur.
8804 : }
8805 :
8806 0 : bool VmaBlockMetadata_Linear::ShouldCompact1st() const
8807 : {
8808 0 : const size_t nullItemCount = m_1stNullItemsBeginCount + m_1stNullItemsMiddleCount;
8809 0 : const size_t suballocCount = AccessSuballocations1st().size();
8810 0 : return suballocCount > 32 && nullItemCount * 2 >= (suballocCount - nullItemCount) * 3;
8811 : }
8812 :
8813 0 : void VmaBlockMetadata_Linear::CleanupAfterFree()
8814 : {
8815 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8816 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8817 :
8818 0 : if (IsEmpty())
8819 : {
8820 0 : suballocations1st.clear();
8821 0 : suballocations2nd.clear();
8822 0 : m_1stNullItemsBeginCount = 0;
8823 0 : m_1stNullItemsMiddleCount = 0;
8824 0 : m_2ndNullItemsCount = 0;
8825 0 : m_2ndVectorMode = SECOND_VECTOR_EMPTY;
8826 : }
8827 : else
8828 : {
8829 0 : const size_t suballoc1stCount = suballocations1st.size();
8830 0 : const size_t nullItem1stCount = m_1stNullItemsBeginCount + m_1stNullItemsMiddleCount;
8831 0 : VMA_ASSERT(nullItem1stCount <= suballoc1stCount);
8832 :
8833 : // Find more null items at the beginning of 1st vector.
8834 0 : while (m_1stNullItemsBeginCount < suballoc1stCount &&
8835 0 : suballocations1st[m_1stNullItemsBeginCount].type == VMA_SUBALLOCATION_TYPE_FREE)
8836 : {
8837 0 : ++m_1stNullItemsBeginCount;
8838 0 : --m_1stNullItemsMiddleCount;
8839 : }
8840 :
8841 : // Find more null items at the end of 1st vector.
8842 0 : while (m_1stNullItemsMiddleCount > 0 &&
8843 0 : suballocations1st.back().type == VMA_SUBALLOCATION_TYPE_FREE)
8844 : {
8845 0 : --m_1stNullItemsMiddleCount;
8846 0 : suballocations1st.pop_back();
8847 : }
8848 :
8849 : // Find more null items at the end of 2nd vector.
8850 0 : while (m_2ndNullItemsCount > 0 &&
8851 0 : suballocations2nd.back().type == VMA_SUBALLOCATION_TYPE_FREE)
8852 : {
8853 0 : --m_2ndNullItemsCount;
8854 0 : suballocations2nd.pop_back();
8855 : }
8856 :
8857 : // Find more null items at the beginning of 2nd vector.
8858 0 : while (m_2ndNullItemsCount > 0 &&
8859 0 : suballocations2nd[0].type == VMA_SUBALLOCATION_TYPE_FREE)
8860 : {
8861 0 : --m_2ndNullItemsCount;
8862 0 : VmaVectorRemove(suballocations2nd, 0);
8863 : }
8864 :
8865 0 : if (ShouldCompact1st())
8866 : {
8867 0 : const size_t nonNullItemCount = suballoc1stCount - nullItem1stCount;
8868 0 : size_t srcIndex = m_1stNullItemsBeginCount;
8869 0 : for (size_t dstIndex = 0; dstIndex < nonNullItemCount; ++dstIndex)
8870 : {
8871 0 : while (suballocations1st[srcIndex].type == VMA_SUBALLOCATION_TYPE_FREE)
8872 : {
8873 0 : ++srcIndex;
8874 : }
8875 0 : if (dstIndex != srcIndex)
8876 : {
8877 0 : suballocations1st[dstIndex] = suballocations1st[srcIndex];
8878 : }
8879 0 : ++srcIndex;
8880 : }
8881 0 : suballocations1st.resize(nonNullItemCount);
8882 0 : m_1stNullItemsBeginCount = 0;
8883 0 : m_1stNullItemsMiddleCount = 0;
8884 : }
8885 :
8886 : // 2nd vector became empty.
8887 0 : if (suballocations2nd.empty())
8888 : {
8889 0 : m_2ndVectorMode = SECOND_VECTOR_EMPTY;
8890 : }
8891 :
8892 : // 1st vector became empty.
8893 0 : if (suballocations1st.size() - m_1stNullItemsBeginCount == 0)
8894 : {
8895 0 : suballocations1st.clear();
8896 0 : m_1stNullItemsBeginCount = 0;
8897 :
8898 0 : if (!suballocations2nd.empty() && m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
8899 : {
8900 : // Swap 1st with 2nd. Now 2nd is empty.
8901 0 : m_2ndVectorMode = SECOND_VECTOR_EMPTY;
8902 0 : m_1stNullItemsMiddleCount = m_2ndNullItemsCount;
8903 0 : while (m_1stNullItemsBeginCount < suballocations2nd.size() &&
8904 0 : suballocations2nd[m_1stNullItemsBeginCount].type == VMA_SUBALLOCATION_TYPE_FREE)
8905 : {
8906 0 : ++m_1stNullItemsBeginCount;
8907 0 : --m_1stNullItemsMiddleCount;
8908 : }
8909 0 : m_2ndNullItemsCount = 0;
8910 0 : m_1stVectorIndex ^= 1;
8911 : }
8912 : }
8913 : }
8914 :
8915 0 : VMA_HEAVY_ASSERT(Validate());
8916 0 : }
8917 :
8918 0 : bool VmaBlockMetadata_Linear::CreateAllocationRequest_LowerAddress(
8919 : VkDeviceSize allocSize,
8920 : VkDeviceSize allocAlignment,
8921 : VmaSuballocationType allocType,
8922 : uint32_t strategy,
8923 : VmaAllocationRequest* pAllocationRequest)
8924 : {
8925 0 : const VkDeviceSize blockSize = GetSize();
8926 0 : const VkDeviceSize debugMargin = GetDebugMargin();
8927 0 : const VkDeviceSize bufferImageGranularity = GetBufferImageGranularity();
8928 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
8929 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
8930 :
8931 0 : if (m_2ndVectorMode == SECOND_VECTOR_EMPTY || m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8932 : {
8933 : // Try to allocate at the end of 1st vector.
8934 :
8935 0 : VkDeviceSize resultBaseOffset = 0;
8936 0 : if (!suballocations1st.empty())
8937 : {
8938 0 : const VmaSuballocation& lastSuballoc = suballocations1st.back();
8939 0 : resultBaseOffset = lastSuballoc.offset + lastSuballoc.size + debugMargin;
8940 : }
8941 :
8942 : // Start from offset equal to beginning of free space.
8943 0 : VkDeviceSize resultOffset = resultBaseOffset;
8944 :
8945 : // Apply alignment.
8946 0 : resultOffset = VmaAlignUp(resultOffset, allocAlignment);
8947 :
8948 : // Check previous suballocations for BufferImageGranularity conflicts.
8949 : // Make bigger alignment if necessary.
8950 0 : if (bufferImageGranularity > 1 && bufferImageGranularity != allocAlignment && !suballocations1st.empty())
8951 : {
8952 0 : bool bufferImageGranularityConflict = false;
8953 0 : for (size_t prevSuballocIndex = suballocations1st.size(); prevSuballocIndex--; )
8954 : {
8955 0 : const VmaSuballocation& prevSuballoc = suballocations1st[prevSuballocIndex];
8956 0 : if (VmaBlocksOnSamePage(prevSuballoc.offset, prevSuballoc.size, resultOffset, bufferImageGranularity))
8957 : {
8958 0 : if (VmaIsBufferImageGranularityConflict(prevSuballoc.type, allocType))
8959 : {
8960 0 : bufferImageGranularityConflict = true;
8961 0 : break;
8962 : }
8963 : }
8964 : else
8965 : // Already on previous page.
8966 0 : break;
8967 : }
8968 0 : if (bufferImageGranularityConflict)
8969 : {
8970 0 : resultOffset = VmaAlignUp(resultOffset, bufferImageGranularity);
8971 : }
8972 : }
8973 :
8974 0 : const VkDeviceSize freeSpaceEnd = m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK ?
8975 0 : suballocations2nd.back().offset : blockSize;
8976 :
8977 : // There is enough free space at the end after alignment.
8978 0 : if (resultOffset + allocSize + debugMargin <= freeSpaceEnd)
8979 : {
8980 : // Check next suballocations for BufferImageGranularity conflicts.
8981 : // If conflict exists, allocation cannot be made here.
8982 0 : if ((allocSize % bufferImageGranularity || resultOffset % bufferImageGranularity) && m_2ndVectorMode == SECOND_VECTOR_DOUBLE_STACK)
8983 : {
8984 0 : for (size_t nextSuballocIndex = suballocations2nd.size(); nextSuballocIndex--; )
8985 : {
8986 0 : const VmaSuballocation& nextSuballoc = suballocations2nd[nextSuballocIndex];
8987 0 : if (VmaBlocksOnSamePage(resultOffset, allocSize, nextSuballoc.offset, bufferImageGranularity))
8988 : {
8989 0 : if (VmaIsBufferImageGranularityConflict(allocType, nextSuballoc.type))
8990 : {
8991 0 : return false;
8992 : }
8993 : }
8994 : else
8995 : {
8996 : // Already on previous page.
8997 0 : break;
8998 : }
8999 : }
9000 : }
9001 :
9002 : // All tests passed: Success.
9003 0 : pAllocationRequest->allocHandle = (VmaAllocHandle)(resultOffset + 1);
9004 : // pAllocationRequest->item, customData unused.
9005 0 : pAllocationRequest->type = VmaAllocationRequestType::EndOf1st;
9006 0 : return true;
9007 : }
9008 : }
9009 :
9010 : // Wrap-around to end of 2nd vector. Try to allocate there, watching for the
9011 : // beginning of 1st vector as the end of free space.
9012 0 : if (m_2ndVectorMode == SECOND_VECTOR_EMPTY || m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
9013 : {
9014 0 : VMA_ASSERT(!suballocations1st.empty());
9015 :
9016 0 : VkDeviceSize resultBaseOffset = 0;
9017 0 : if (!suballocations2nd.empty())
9018 : {
9019 0 : const VmaSuballocation& lastSuballoc = suballocations2nd.back();
9020 0 : resultBaseOffset = lastSuballoc.offset + lastSuballoc.size + debugMargin;
9021 : }
9022 :
9023 : // Start from offset equal to beginning of free space.
9024 0 : VkDeviceSize resultOffset = resultBaseOffset;
9025 :
9026 : // Apply alignment.
9027 0 : resultOffset = VmaAlignUp(resultOffset, allocAlignment);
9028 :
9029 : // Check previous suballocations for BufferImageGranularity conflicts.
9030 : // Make bigger alignment if necessary.
9031 0 : if (bufferImageGranularity > 1 && bufferImageGranularity != allocAlignment && !suballocations2nd.empty())
9032 : {
9033 0 : bool bufferImageGranularityConflict = false;
9034 0 : for (size_t prevSuballocIndex = suballocations2nd.size(); prevSuballocIndex--; )
9035 : {
9036 0 : const VmaSuballocation& prevSuballoc = suballocations2nd[prevSuballocIndex];
9037 0 : if (VmaBlocksOnSamePage(prevSuballoc.offset, prevSuballoc.size, resultOffset, bufferImageGranularity))
9038 : {
9039 0 : if (VmaIsBufferImageGranularityConflict(prevSuballoc.type, allocType))
9040 : {
9041 0 : bufferImageGranularityConflict = true;
9042 0 : break;
9043 : }
9044 : }
9045 : else
9046 : // Already on previous page.
9047 0 : break;
9048 : }
9049 0 : if (bufferImageGranularityConflict)
9050 : {
9051 0 : resultOffset = VmaAlignUp(resultOffset, bufferImageGranularity);
9052 : }
9053 : }
9054 :
9055 0 : size_t index1st = m_1stNullItemsBeginCount;
9056 :
9057 : // There is enough free space at the end after alignment.
9058 0 : if ((index1st == suballocations1st.size() && resultOffset + allocSize + debugMargin <= blockSize) ||
9059 0 : (index1st < suballocations1st.size() && resultOffset + allocSize + debugMargin <= suballocations1st[index1st].offset))
9060 : {
9061 : // Check next suballocations for BufferImageGranularity conflicts.
9062 : // If conflict exists, allocation cannot be made here.
9063 0 : if (allocSize % bufferImageGranularity || resultOffset % bufferImageGranularity)
9064 : {
9065 0 : for (size_t nextSuballocIndex = index1st;
9066 0 : nextSuballocIndex < suballocations1st.size();
9067 : nextSuballocIndex++)
9068 : {
9069 0 : const VmaSuballocation& nextSuballoc = suballocations1st[nextSuballocIndex];
9070 0 : if (VmaBlocksOnSamePage(resultOffset, allocSize, nextSuballoc.offset, bufferImageGranularity))
9071 : {
9072 0 : if (VmaIsBufferImageGranularityConflict(allocType, nextSuballoc.type))
9073 : {
9074 0 : return false;
9075 : }
9076 : }
9077 : else
9078 : {
9079 : // Already on next page.
9080 0 : break;
9081 : }
9082 : }
9083 : }
9084 :
9085 : // All tests passed: Success.
9086 0 : pAllocationRequest->allocHandle = (VmaAllocHandle)(resultOffset + 1);
9087 0 : pAllocationRequest->type = VmaAllocationRequestType::EndOf2nd;
9088 : // pAllocationRequest->item, customData unused.
9089 0 : return true;
9090 : }
9091 : }
9092 :
9093 0 : return false;
9094 : }
9095 :
9096 0 : bool VmaBlockMetadata_Linear::CreateAllocationRequest_UpperAddress(
9097 : VkDeviceSize allocSize,
9098 : VkDeviceSize allocAlignment,
9099 : VmaSuballocationType allocType,
9100 : uint32_t strategy,
9101 : VmaAllocationRequest* pAllocationRequest)
9102 : {
9103 0 : const VkDeviceSize blockSize = GetSize();
9104 0 : const VkDeviceSize bufferImageGranularity = GetBufferImageGranularity();
9105 0 : SuballocationVectorType& suballocations1st = AccessSuballocations1st();
9106 0 : SuballocationVectorType& suballocations2nd = AccessSuballocations2nd();
9107 :
9108 0 : if (m_2ndVectorMode == SECOND_VECTOR_RING_BUFFER)
9109 : {
9110 0 : VMA_ASSERT(0 && "Trying to use pool with linear algorithm as double stack, while it is already being used as ring buffer.");
9111 0 : return false;
9112 : }
9113 :
9114 : // Try to allocate before 2nd.back(), or end of block if 2nd.empty().
9115 0 : if (allocSize > blockSize)
9116 : {
9117 0 : return false;
9118 : }
9119 0 : VkDeviceSize resultBaseOffset = blockSize - allocSize;
9120 0 : if (!suballocations2nd.empty())
9121 : {
9122 0 : const VmaSuballocation& lastSuballoc = suballocations2nd.back();
9123 0 : resultBaseOffset = lastSuballoc.offset - allocSize;
9124 0 : if (allocSize > lastSuballoc.offset)
9125 : {
9126 0 : return false;
9127 : }
9128 : }
9129 :
9130 : // Start from offset equal to end of free space.
9131 0 : VkDeviceSize resultOffset = resultBaseOffset;
9132 :
9133 0 : const VkDeviceSize debugMargin = GetDebugMargin();
9134 :
9135 : // Apply debugMargin at the end.
9136 0 : if (debugMargin > 0)
9137 : {
9138 0 : if (resultOffset < debugMargin)
9139 : {
9140 0 : return false;
9141 : }
9142 0 : resultOffset -= debugMargin;
9143 : }
9144 :
9145 : // Apply alignment.
9146 0 : resultOffset = VmaAlignDown(resultOffset, allocAlignment);
9147 :
9148 : // Check next suballocations from 2nd for BufferImageGranularity conflicts.
9149 : // Make bigger alignment if necessary.
9150 0 : if (bufferImageGranularity > 1 && bufferImageGranularity != allocAlignment && !suballocations2nd.empty())
9151 : {
9152 0 : bool bufferImageGranularityConflict = false;
9153 0 : for (size_t nextSuballocIndex = suballocations2nd.size(); nextSuballocIndex--; )
9154 : {
9155 0 : const VmaSuballocation& nextSuballoc = suballocations2nd[nextSuballocIndex];
9156 0 : if (VmaBlocksOnSamePage(resultOffset, allocSize, nextSuballoc.offset, bufferImageGranularity))
9157 : {
9158 0 : if (VmaIsBufferImageGranularityConflict(nextSuballoc.type, allocType))
9159 : {
9160 0 : bufferImageGranularityConflict = true;
9161 0 : break;
9162 : }
9163 : }
9164 : else
9165 : // Already on previous page.
9166 0 : break;
9167 : }
9168 0 : if (bufferImageGranularityConflict)
9169 : {
9170 0 : resultOffset = VmaAlignDown(resultOffset, bufferImageGranularity);
9171 : }
9172 : }
9173 :
9174 : // There is enough free space.
9175 0 : const VkDeviceSize endOf1st = !suballocations1st.empty() ?
9176 0 : suballocations1st.back().offset + suballocations1st.back().size :
9177 0 : 0;
9178 0 : if (endOf1st + debugMargin <= resultOffset)
9179 : {
9180 : // Check previous suballocations for BufferImageGranularity conflicts.
9181 : // If conflict exists, allocation cannot be made here.
9182 0 : if (bufferImageGranularity > 1)
9183 : {
9184 0 : for (size_t prevSuballocIndex = suballocations1st.size(); prevSuballocIndex--; )
9185 : {
9186 0 : const VmaSuballocation& prevSuballoc = suballocations1st[prevSuballocIndex];
9187 0 : if (VmaBlocksOnSamePage(prevSuballoc.offset, prevSuballoc.size, resultOffset, bufferImageGranularity))
9188 : {
9189 0 : if (VmaIsBufferImageGranularityConflict(allocType, prevSuballoc.type))
9190 : {
9191 0 : return false;
9192 : }
9193 : }
9194 : else
9195 : {
9196 : // Already on next page.
9197 0 : break;
9198 : }
9199 : }
9200 : }
9201 :
9202 : // All tests passed: Success.
9203 0 : pAllocationRequest->allocHandle = (VmaAllocHandle)(resultOffset + 1);
9204 : // pAllocationRequest->item unused.
9205 0 : pAllocationRequest->type = VmaAllocationRequestType::UpperAddress;
9206 0 : return true;
9207 : }
9208 :
9209 0 : return false;
9210 : }
9211 : #endif // _VMA_BLOCK_METADATA_LINEAR_FUNCTIONS
9212 : #endif // _VMA_BLOCK_METADATA_LINEAR
9213 :
9214 : #if 0
9215 : #ifndef _VMA_BLOCK_METADATA_BUDDY
9216 : /*
9217 : - GetSize() is the original size of allocated memory block.
9218 : - m_UsableSize is this size aligned down to a power of two.
9219 : All allocations and calculations happen relative to m_UsableSize.
9220 : - GetUnusableSize() is the difference between them.
9221 : It is reported as separate, unused range, not available for allocations.
9222 :
9223 : Node at level 0 has size = m_UsableSize.
9224 : Each next level contains nodes with size 2 times smaller than current level.
9225 : m_LevelCount is the maximum number of levels to use in the current object.
9226 : */
9227 : class VmaBlockMetadata_Buddy : public VmaBlockMetadata
9228 : {
9229 : VMA_CLASS_NO_COPY(VmaBlockMetadata_Buddy)
9230 : public:
9231 : VmaBlockMetadata_Buddy(const VkAllocationCallbacks* pAllocationCallbacks,
9232 : VkDeviceSize bufferImageGranularity, bool isVirtual);
9233 : virtual ~VmaBlockMetadata_Buddy();
9234 :
9235 : size_t GetAllocationCount() const override { return m_AllocationCount; }
9236 : VkDeviceSize GetSumFreeSize() const override { return m_SumFreeSize + GetUnusableSize(); }
9237 : bool IsEmpty() const override { return m_Root->type == Node::TYPE_FREE; }
9238 : VkResult CheckCorruption(const void* pBlockData) override { return VK_ERROR_FEATURE_NOT_PRESENT; }
9239 : VkDeviceSize GetAllocationOffset(VmaAllocHandle allocHandle) const override { return (VkDeviceSize)allocHandle - 1; };
9240 : void DebugLogAllAllocations() const override { DebugLogAllAllocationNode(m_Root, 0); }
9241 :
9242 : void Init(VkDeviceSize size) override;
9243 : bool Validate() const override;
9244 :
9245 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const override;
9246 : void AddStatistics(VmaStatistics& inoutStats) const override;
9247 :
9248 : #if VMA_STATS_STRING_ENABLED
9249 : void PrintDetailedMap(class VmaJsonWriter& json, uint32_t mapRefCount) const override;
9250 : #endif
9251 :
9252 : bool CreateAllocationRequest(
9253 : VkDeviceSize allocSize,
9254 : VkDeviceSize allocAlignment,
9255 : bool upperAddress,
9256 : VmaSuballocationType allocType,
9257 : uint32_t strategy,
9258 : VmaAllocationRequest* pAllocationRequest) override;
9259 :
9260 : void Alloc(
9261 : const VmaAllocationRequest& request,
9262 : VmaSuballocationType type,
9263 : void* userData) override;
9264 :
9265 : void Free(VmaAllocHandle allocHandle) override;
9266 : void GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo) override;
9267 : void* GetAllocationUserData(VmaAllocHandle allocHandle) const override;
9268 : VmaAllocHandle GetAllocationListBegin() const override;
9269 : VmaAllocHandle GetNextAllocation(VmaAllocHandle prevAlloc) const override;
9270 : void Clear() override;
9271 : void SetAllocationUserData(VmaAllocHandle allocHandle, void* userData) override;
9272 :
9273 : private:
9274 : static const size_t MAX_LEVELS = 48;
9275 :
9276 : struct ValidationContext
9277 : {
9278 : size_t calculatedAllocationCount = 0;
9279 : size_t calculatedFreeCount = 0;
9280 : VkDeviceSize calculatedSumFreeSize = 0;
9281 : };
9282 : struct Node
9283 : {
9284 : VkDeviceSize offset;
9285 : enum TYPE
9286 : {
9287 : TYPE_FREE,
9288 : TYPE_ALLOCATION,
9289 : TYPE_SPLIT,
9290 : TYPE_COUNT
9291 : } type;
9292 : Node* parent;
9293 : Node* buddy;
9294 :
9295 : union
9296 : {
9297 : struct
9298 : {
9299 : Node* prev;
9300 : Node* next;
9301 : } free;
9302 : struct
9303 : {
9304 : void* userData;
9305 : } allocation;
9306 : struct
9307 : {
9308 : Node* leftChild;
9309 : } split;
9310 : };
9311 : };
9312 :
9313 : // Size of the memory block aligned down to a power of two.
9314 : VkDeviceSize m_UsableSize;
9315 : uint32_t m_LevelCount;
9316 : VmaPoolAllocator<Node> m_NodeAllocator;
9317 : Node* m_Root;
9318 : struct
9319 : {
9320 : Node* front;
9321 : Node* back;
9322 : } m_FreeList[MAX_LEVELS];
9323 :
9324 : // Number of nodes in the tree with type == TYPE_ALLOCATION.
9325 : size_t m_AllocationCount;
9326 : // Number of nodes in the tree with type == TYPE_FREE.
9327 : size_t m_FreeCount;
9328 : // Doesn't include space wasted due to internal fragmentation - allocation sizes are just aligned up to node sizes.
9329 : // Doesn't include unusable size.
9330 : VkDeviceSize m_SumFreeSize;
9331 :
9332 : VkDeviceSize GetUnusableSize() const { return GetSize() - m_UsableSize; }
9333 : VkDeviceSize LevelToNodeSize(uint32_t level) const { return m_UsableSize >> level; }
9334 :
9335 : VkDeviceSize AlignAllocationSize(VkDeviceSize size) const
9336 : {
9337 : if (!IsVirtual())
9338 : {
9339 : size = VmaAlignUp(size, (VkDeviceSize)16);
9340 : }
9341 : return VmaNextPow2(size);
9342 : }
9343 : Node* FindAllocationNode(VkDeviceSize offset, uint32_t& outLevel) const;
9344 : void DeleteNodeChildren(Node* node);
9345 : bool ValidateNode(ValidationContext& ctx, const Node* parent, const Node* curr, uint32_t level, VkDeviceSize levelNodeSize) const;
9346 : uint32_t AllocSizeToLevel(VkDeviceSize allocSize) const;
9347 : void AddNodeToDetailedStatistics(VmaDetailedStatistics& inoutStats, const Node* node, VkDeviceSize levelNodeSize) const;
9348 : // Adds node to the front of FreeList at given level.
9349 : // node->type must be FREE.
9350 : // node->free.prev, next can be undefined.
9351 : void AddToFreeListFront(uint32_t level, Node* node);
9352 : // Removes node from FreeList at given level.
9353 : // node->type must be FREE.
9354 : // node->free.prev, next stay untouched.
9355 : void RemoveFromFreeList(uint32_t level, Node* node);
9356 : void DebugLogAllAllocationNode(Node* node, uint32_t level) const;
9357 :
9358 : #if VMA_STATS_STRING_ENABLED
9359 : void PrintDetailedMapNode(class VmaJsonWriter& json, const Node* node, VkDeviceSize levelNodeSize) const;
9360 : #endif
9361 : };
9362 :
9363 : #ifndef _VMA_BLOCK_METADATA_BUDDY_FUNCTIONS
9364 : VmaBlockMetadata_Buddy::VmaBlockMetadata_Buddy(const VkAllocationCallbacks* pAllocationCallbacks,
9365 : VkDeviceSize bufferImageGranularity, bool isVirtual)
9366 : : VmaBlockMetadata(pAllocationCallbacks, bufferImageGranularity, isVirtual),
9367 : m_NodeAllocator(pAllocationCallbacks, 32), // firstBlockCapacity
9368 : m_Root(VMA_NULL),
9369 : m_AllocationCount(0),
9370 : m_FreeCount(1),
9371 : m_SumFreeSize(0)
9372 : {
9373 : memset(m_FreeList, 0, sizeof(m_FreeList));
9374 : }
9375 :
9376 : VmaBlockMetadata_Buddy::~VmaBlockMetadata_Buddy()
9377 : {
9378 : DeleteNodeChildren(m_Root);
9379 : m_NodeAllocator.Free(m_Root);
9380 : }
9381 :
9382 : void VmaBlockMetadata_Buddy::Init(VkDeviceSize size)
9383 : {
9384 : VmaBlockMetadata::Init(size);
9385 :
9386 : m_UsableSize = VmaPrevPow2(size);
9387 : m_SumFreeSize = m_UsableSize;
9388 :
9389 : // Calculate m_LevelCount.
9390 : const VkDeviceSize minNodeSize = IsVirtual() ? 1 : 16;
9391 : m_LevelCount = 1;
9392 : while (m_LevelCount < MAX_LEVELS &&
9393 : LevelToNodeSize(m_LevelCount) >= minNodeSize)
9394 : {
9395 : ++m_LevelCount;
9396 : }
9397 :
9398 : Node* rootNode = m_NodeAllocator.Alloc();
9399 : rootNode->offset = 0;
9400 : rootNode->type = Node::TYPE_FREE;
9401 : rootNode->parent = VMA_NULL;
9402 : rootNode->buddy = VMA_NULL;
9403 :
9404 : m_Root = rootNode;
9405 : AddToFreeListFront(0, rootNode);
9406 : }
9407 :
9408 : bool VmaBlockMetadata_Buddy::Validate() const
9409 : {
9410 : // Validate tree.
9411 : ValidationContext ctx;
9412 : if (!ValidateNode(ctx, VMA_NULL, m_Root, 0, LevelToNodeSize(0)))
9413 : {
9414 : VMA_VALIDATE(false && "ValidateNode failed.");
9415 : }
9416 : VMA_VALIDATE(m_AllocationCount == ctx.calculatedAllocationCount);
9417 : VMA_VALIDATE(m_SumFreeSize == ctx.calculatedSumFreeSize);
9418 :
9419 : // Validate free node lists.
9420 : for (uint32_t level = 0; level < m_LevelCount; ++level)
9421 : {
9422 : VMA_VALIDATE(m_FreeList[level].front == VMA_NULL ||
9423 : m_FreeList[level].front->free.prev == VMA_NULL);
9424 :
9425 : for (Node* node = m_FreeList[level].front;
9426 : node != VMA_NULL;
9427 : node = node->free.next)
9428 : {
9429 : VMA_VALIDATE(node->type == Node::TYPE_FREE);
9430 :
9431 : if (node->free.next == VMA_NULL)
9432 : {
9433 : VMA_VALIDATE(m_FreeList[level].back == node);
9434 : }
9435 : else
9436 : {
9437 : VMA_VALIDATE(node->free.next->free.prev == node);
9438 : }
9439 : }
9440 : }
9441 :
9442 : // Validate that free lists ar higher levels are empty.
9443 : for (uint32_t level = m_LevelCount; level < MAX_LEVELS; ++level)
9444 : {
9445 : VMA_VALIDATE(m_FreeList[level].front == VMA_NULL && m_FreeList[level].back == VMA_NULL);
9446 : }
9447 :
9448 : return true;
9449 : }
9450 :
9451 : void VmaBlockMetadata_Buddy::AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const
9452 : {
9453 : inoutStats.statistics.blockCount++;
9454 : inoutStats.statistics.blockBytes += GetSize();
9455 :
9456 : AddNodeToDetailedStatistics(inoutStats, m_Root, LevelToNodeSize(0));
9457 :
9458 : const VkDeviceSize unusableSize = GetUnusableSize();
9459 : if (unusableSize > 0)
9460 : VmaAddDetailedStatisticsUnusedRange(inoutStats, unusableSize);
9461 : }
9462 :
9463 : void VmaBlockMetadata_Buddy::AddStatistics(VmaStatistics& inoutStats) const
9464 : {
9465 : inoutStats.blockCount++;
9466 : inoutStats.allocationCount += (uint32_t)m_AllocationCount;
9467 : inoutStats.blockBytes += GetSize();
9468 : inoutStats.allocationBytes += GetSize() - m_SumFreeSize;
9469 : }
9470 :
9471 : #if VMA_STATS_STRING_ENABLED
9472 : void VmaBlockMetadata_Buddy::PrintDetailedMap(class VmaJsonWriter& json, uint32_t mapRefCount) const
9473 : {
9474 : VmaDetailedStatistics stats;
9475 : VmaClearDetailedStatistics(stats);
9476 : AddDetailedStatistics(stats);
9477 :
9478 : PrintDetailedMap_Begin(
9479 : json,
9480 : stats.statistics.blockBytes - stats.statistics.allocationBytes,
9481 : stats.statistics.allocationCount,
9482 : stats.unusedRangeCount,
9483 : mapRefCount);
9484 :
9485 : PrintDetailedMapNode(json, m_Root, LevelToNodeSize(0));
9486 :
9487 : const VkDeviceSize unusableSize = GetUnusableSize();
9488 : if (unusableSize > 0)
9489 : {
9490 : PrintDetailedMap_UnusedRange(json,
9491 : m_UsableSize, // offset
9492 : unusableSize); // size
9493 : }
9494 :
9495 : PrintDetailedMap_End(json);
9496 : }
9497 : #endif // VMA_STATS_STRING_ENABLED
9498 :
9499 : bool VmaBlockMetadata_Buddy::CreateAllocationRequest(
9500 : VkDeviceSize allocSize,
9501 : VkDeviceSize allocAlignment,
9502 : bool upperAddress,
9503 : VmaSuballocationType allocType,
9504 : uint32_t strategy,
9505 : VmaAllocationRequest* pAllocationRequest)
9506 : {
9507 : VMA_ASSERT(!upperAddress && "VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT can be used only with linear algorithm.");
9508 :
9509 : allocSize = AlignAllocationSize(allocSize);
9510 :
9511 : // Simple way to respect bufferImageGranularity. May be optimized some day.
9512 : // Whenever it might be an OPTIMAL image...
9513 : if (allocType == VMA_SUBALLOCATION_TYPE_UNKNOWN ||
9514 : allocType == VMA_SUBALLOCATION_TYPE_IMAGE_UNKNOWN ||
9515 : allocType == VMA_SUBALLOCATION_TYPE_IMAGE_OPTIMAL)
9516 : {
9517 : allocAlignment = VMA_MAX(allocAlignment, GetBufferImageGranularity());
9518 : allocSize = VmaAlignUp(allocSize, GetBufferImageGranularity());
9519 : }
9520 :
9521 : if (allocSize > m_UsableSize)
9522 : {
9523 : return false;
9524 : }
9525 :
9526 : const uint32_t targetLevel = AllocSizeToLevel(allocSize);
9527 : for (uint32_t level = targetLevel; level--; )
9528 : {
9529 : for (Node* freeNode = m_FreeList[level].front;
9530 : freeNode != VMA_NULL;
9531 : freeNode = freeNode->free.next)
9532 : {
9533 : if (freeNode->offset % allocAlignment == 0)
9534 : {
9535 : pAllocationRequest->type = VmaAllocationRequestType::Normal;
9536 : pAllocationRequest->allocHandle = (VmaAllocHandle)(freeNode->offset + 1);
9537 : pAllocationRequest->size = allocSize;
9538 : pAllocationRequest->customData = (void*)(uintptr_t)level;
9539 : return true;
9540 : }
9541 : }
9542 : }
9543 :
9544 : return false;
9545 : }
9546 :
9547 : void VmaBlockMetadata_Buddy::Alloc(
9548 : const VmaAllocationRequest& request,
9549 : VmaSuballocationType type,
9550 : void* userData)
9551 : {
9552 : VMA_ASSERT(request.type == VmaAllocationRequestType::Normal);
9553 :
9554 : const uint32_t targetLevel = AllocSizeToLevel(request.size);
9555 : uint32_t currLevel = (uint32_t)(uintptr_t)request.customData;
9556 :
9557 : Node* currNode = m_FreeList[currLevel].front;
9558 : VMA_ASSERT(currNode != VMA_NULL && currNode->type == Node::TYPE_FREE);
9559 : const VkDeviceSize offset = (VkDeviceSize)request.allocHandle - 1;
9560 : while (currNode->offset != offset)
9561 : {
9562 : currNode = currNode->free.next;
9563 : VMA_ASSERT(currNode != VMA_NULL && currNode->type == Node::TYPE_FREE);
9564 : }
9565 :
9566 : // Go down, splitting free nodes.
9567 : while (currLevel < targetLevel)
9568 : {
9569 : // currNode is already first free node at currLevel.
9570 : // Remove it from list of free nodes at this currLevel.
9571 : RemoveFromFreeList(currLevel, currNode);
9572 :
9573 : const uint32_t childrenLevel = currLevel + 1;
9574 :
9575 : // Create two free sub-nodes.
9576 : Node* leftChild = m_NodeAllocator.Alloc();
9577 : Node* rightChild = m_NodeAllocator.Alloc();
9578 :
9579 : leftChild->offset = currNode->offset;
9580 : leftChild->type = Node::TYPE_FREE;
9581 : leftChild->parent = currNode;
9582 : leftChild->buddy = rightChild;
9583 :
9584 : rightChild->offset = currNode->offset + LevelToNodeSize(childrenLevel);
9585 : rightChild->type = Node::TYPE_FREE;
9586 : rightChild->parent = currNode;
9587 : rightChild->buddy = leftChild;
9588 :
9589 : // Convert current currNode to split type.
9590 : currNode->type = Node::TYPE_SPLIT;
9591 : currNode->split.leftChild = leftChild;
9592 :
9593 : // Add child nodes to free list. Order is important!
9594 : AddToFreeListFront(childrenLevel, rightChild);
9595 : AddToFreeListFront(childrenLevel, leftChild);
9596 :
9597 : ++m_FreeCount;
9598 : ++currLevel;
9599 : currNode = m_FreeList[currLevel].front;
9600 :
9601 : /*
9602 : We can be sure that currNode, as left child of node previously split,
9603 : also fulfills the alignment requirement.
9604 : */
9605 : }
9606 :
9607 : // Remove from free list.
9608 : VMA_ASSERT(currLevel == targetLevel &&
9609 : currNode != VMA_NULL &&
9610 : currNode->type == Node::TYPE_FREE);
9611 : RemoveFromFreeList(currLevel, currNode);
9612 :
9613 : // Convert to allocation node.
9614 : currNode->type = Node::TYPE_ALLOCATION;
9615 : currNode->allocation.userData = userData;
9616 :
9617 : ++m_AllocationCount;
9618 : --m_FreeCount;
9619 : m_SumFreeSize -= request.size;
9620 : }
9621 :
9622 : void VmaBlockMetadata_Buddy::GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo)
9623 : {
9624 : uint32_t level = 0;
9625 : outInfo.offset = (VkDeviceSize)allocHandle - 1;
9626 : const Node* const node = FindAllocationNode(outInfo.offset, level);
9627 : outInfo.size = LevelToNodeSize(level);
9628 : outInfo.pUserData = node->allocation.userData;
9629 : }
9630 :
9631 : void* VmaBlockMetadata_Buddy::GetAllocationUserData(VmaAllocHandle allocHandle) const
9632 : {
9633 : uint32_t level = 0;
9634 : const Node* const node = FindAllocationNode((VkDeviceSize)allocHandle - 1, level);
9635 : return node->allocation.userData;
9636 : }
9637 :
9638 : VmaAllocHandle VmaBlockMetadata_Buddy::GetAllocationListBegin() const
9639 : {
9640 : // Function only used for defragmentation, which is disabled for this algorithm
9641 : return VK_NULL_HANDLE;
9642 : }
9643 :
9644 : VmaAllocHandle VmaBlockMetadata_Buddy::GetNextAllocation(VmaAllocHandle prevAlloc) const
9645 : {
9646 : // Function only used for defragmentation, which is disabled for this algorithm
9647 : return VK_NULL_HANDLE;
9648 : }
9649 :
9650 : void VmaBlockMetadata_Buddy::DeleteNodeChildren(Node* node)
9651 : {
9652 : if (node->type == Node::TYPE_SPLIT)
9653 : {
9654 : DeleteNodeChildren(node->split.leftChild->buddy);
9655 : DeleteNodeChildren(node->split.leftChild);
9656 : const VkAllocationCallbacks* allocationCallbacks = GetAllocationCallbacks();
9657 : m_NodeAllocator.Free(node->split.leftChild->buddy);
9658 : m_NodeAllocator.Free(node->split.leftChild);
9659 : }
9660 : }
9661 :
9662 : void VmaBlockMetadata_Buddy::Clear()
9663 : {
9664 : DeleteNodeChildren(m_Root);
9665 : m_Root->type = Node::TYPE_FREE;
9666 : m_AllocationCount = 0;
9667 : m_FreeCount = 1;
9668 : m_SumFreeSize = m_UsableSize;
9669 : }
9670 :
9671 : void VmaBlockMetadata_Buddy::SetAllocationUserData(VmaAllocHandle allocHandle, void* userData)
9672 : {
9673 : uint32_t level = 0;
9674 : Node* const node = FindAllocationNode((VkDeviceSize)allocHandle - 1, level);
9675 : node->allocation.userData = userData;
9676 : }
9677 :
9678 : VmaBlockMetadata_Buddy::Node* VmaBlockMetadata_Buddy::FindAllocationNode(VkDeviceSize offset, uint32_t& outLevel) const
9679 : {
9680 : Node* node = m_Root;
9681 : VkDeviceSize nodeOffset = 0;
9682 : outLevel = 0;
9683 : VkDeviceSize levelNodeSize = LevelToNodeSize(0);
9684 : while (node->type == Node::TYPE_SPLIT)
9685 : {
9686 : const VkDeviceSize nextLevelNodeSize = levelNodeSize >> 1;
9687 : if (offset < nodeOffset + nextLevelNodeSize)
9688 : {
9689 : node = node->split.leftChild;
9690 : }
9691 : else
9692 : {
9693 : node = node->split.leftChild->buddy;
9694 : nodeOffset += nextLevelNodeSize;
9695 : }
9696 : ++outLevel;
9697 : levelNodeSize = nextLevelNodeSize;
9698 : }
9699 :
9700 : VMA_ASSERT(node != VMA_NULL && node->type == Node::TYPE_ALLOCATION);
9701 : return node;
9702 : }
9703 :
9704 : bool VmaBlockMetadata_Buddy::ValidateNode(ValidationContext& ctx, const Node* parent, const Node* curr, uint32_t level, VkDeviceSize levelNodeSize) const
9705 : {
9706 : VMA_VALIDATE(level < m_LevelCount);
9707 : VMA_VALIDATE(curr->parent == parent);
9708 : VMA_VALIDATE((curr->buddy == VMA_NULL) == (parent == VMA_NULL));
9709 : VMA_VALIDATE(curr->buddy == VMA_NULL || curr->buddy->buddy == curr);
9710 : switch (curr->type)
9711 : {
9712 : case Node::TYPE_FREE:
9713 : // curr->free.prev, next are validated separately.
9714 : ctx.calculatedSumFreeSize += levelNodeSize;
9715 : ++ctx.calculatedFreeCount;
9716 : break;
9717 : case Node::TYPE_ALLOCATION:
9718 : ++ctx.calculatedAllocationCount;
9719 : if (!IsVirtual())
9720 : {
9721 : VMA_VALIDATE(curr->allocation.userData != VMA_NULL);
9722 : }
9723 : break;
9724 : case Node::TYPE_SPLIT:
9725 : {
9726 : const uint32_t childrenLevel = level + 1;
9727 : const VkDeviceSize childrenLevelNodeSize = levelNodeSize >> 1;
9728 : const Node* const leftChild = curr->split.leftChild;
9729 : VMA_VALIDATE(leftChild != VMA_NULL);
9730 : VMA_VALIDATE(leftChild->offset == curr->offset);
9731 : if (!ValidateNode(ctx, curr, leftChild, childrenLevel, childrenLevelNodeSize))
9732 : {
9733 : VMA_VALIDATE(false && "ValidateNode for left child failed.");
9734 : }
9735 : const Node* const rightChild = leftChild->buddy;
9736 : VMA_VALIDATE(rightChild->offset == curr->offset + childrenLevelNodeSize);
9737 : if (!ValidateNode(ctx, curr, rightChild, childrenLevel, childrenLevelNodeSize))
9738 : {
9739 : VMA_VALIDATE(false && "ValidateNode for right child failed.");
9740 : }
9741 : }
9742 : break;
9743 : default:
9744 : return false;
9745 : }
9746 :
9747 : return true;
9748 : }
9749 :
9750 : uint32_t VmaBlockMetadata_Buddy::AllocSizeToLevel(VkDeviceSize allocSize) const
9751 : {
9752 : // I know this could be optimized somehow e.g. by using std::log2p1 from C++20.
9753 : uint32_t level = 0;
9754 : VkDeviceSize currLevelNodeSize = m_UsableSize;
9755 : VkDeviceSize nextLevelNodeSize = currLevelNodeSize >> 1;
9756 : while (allocSize <= nextLevelNodeSize && level + 1 < m_LevelCount)
9757 : {
9758 : ++level;
9759 : currLevelNodeSize >>= 1;
9760 : nextLevelNodeSize >>= 1;
9761 : }
9762 : return level;
9763 : }
9764 :
9765 : void VmaBlockMetadata_Buddy::Free(VmaAllocHandle allocHandle)
9766 : {
9767 : uint32_t level = 0;
9768 : Node* node = FindAllocationNode((VkDeviceSize)allocHandle - 1, level);
9769 :
9770 : ++m_FreeCount;
9771 : --m_AllocationCount;
9772 : m_SumFreeSize += LevelToNodeSize(level);
9773 :
9774 : node->type = Node::TYPE_FREE;
9775 :
9776 : // Join free nodes if possible.
9777 : while (level > 0 && node->buddy->type == Node::TYPE_FREE)
9778 : {
9779 : RemoveFromFreeList(level, node->buddy);
9780 : Node* const parent = node->parent;
9781 :
9782 : m_NodeAllocator.Free(node->buddy);
9783 : m_NodeAllocator.Free(node);
9784 : parent->type = Node::TYPE_FREE;
9785 :
9786 : node = parent;
9787 : --level;
9788 : --m_FreeCount;
9789 : }
9790 :
9791 : AddToFreeListFront(level, node);
9792 : }
9793 :
9794 : void VmaBlockMetadata_Buddy::AddNodeToDetailedStatistics(VmaDetailedStatistics& inoutStats, const Node* node, VkDeviceSize levelNodeSize) const
9795 : {
9796 : switch (node->type)
9797 : {
9798 : case Node::TYPE_FREE:
9799 : VmaAddDetailedStatisticsUnusedRange(inoutStats, levelNodeSize);
9800 : break;
9801 : case Node::TYPE_ALLOCATION:
9802 : VmaAddDetailedStatisticsAllocation(inoutStats, levelNodeSize);
9803 : break;
9804 : case Node::TYPE_SPLIT:
9805 : {
9806 : const VkDeviceSize childrenNodeSize = levelNodeSize / 2;
9807 : const Node* const leftChild = node->split.leftChild;
9808 : AddNodeToDetailedStatistics(inoutStats, leftChild, childrenNodeSize);
9809 : const Node* const rightChild = leftChild->buddy;
9810 : AddNodeToDetailedStatistics(inoutStats, rightChild, childrenNodeSize);
9811 : }
9812 : break;
9813 : default:
9814 : VMA_ASSERT(0);
9815 : }
9816 : }
9817 :
9818 : void VmaBlockMetadata_Buddy::AddToFreeListFront(uint32_t level, Node* node)
9819 : {
9820 : VMA_ASSERT(node->type == Node::TYPE_FREE);
9821 :
9822 : // List is empty.
9823 : Node* const frontNode = m_FreeList[level].front;
9824 : if (frontNode == VMA_NULL)
9825 : {
9826 : VMA_ASSERT(m_FreeList[level].back == VMA_NULL);
9827 : node->free.prev = node->free.next = VMA_NULL;
9828 : m_FreeList[level].front = m_FreeList[level].back = node;
9829 : }
9830 : else
9831 : {
9832 : VMA_ASSERT(frontNode->free.prev == VMA_NULL);
9833 : node->free.prev = VMA_NULL;
9834 : node->free.next = frontNode;
9835 : frontNode->free.prev = node;
9836 : m_FreeList[level].front = node;
9837 : }
9838 : }
9839 :
9840 : void VmaBlockMetadata_Buddy::RemoveFromFreeList(uint32_t level, Node* node)
9841 : {
9842 : VMA_ASSERT(m_FreeList[level].front != VMA_NULL);
9843 :
9844 : // It is at the front.
9845 : if (node->free.prev == VMA_NULL)
9846 : {
9847 : VMA_ASSERT(m_FreeList[level].front == node);
9848 : m_FreeList[level].front = node->free.next;
9849 : }
9850 : else
9851 : {
9852 : Node* const prevFreeNode = node->free.prev;
9853 : VMA_ASSERT(prevFreeNode->free.next == node);
9854 : prevFreeNode->free.next = node->free.next;
9855 : }
9856 :
9857 : // It is at the back.
9858 : if (node->free.next == VMA_NULL)
9859 : {
9860 : VMA_ASSERT(m_FreeList[level].back == node);
9861 : m_FreeList[level].back = node->free.prev;
9862 : }
9863 : else
9864 : {
9865 : Node* const nextFreeNode = node->free.next;
9866 : VMA_ASSERT(nextFreeNode->free.prev == node);
9867 : nextFreeNode->free.prev = node->free.prev;
9868 : }
9869 : }
9870 :
9871 : void VmaBlockMetadata_Buddy::DebugLogAllAllocationNode(Node* node, uint32_t level) const
9872 : {
9873 : switch (node->type)
9874 : {
9875 : case Node::TYPE_FREE:
9876 : break;
9877 : case Node::TYPE_ALLOCATION:
9878 : DebugLogAllocation(node->offset, LevelToNodeSize(level), node->allocation.userData);
9879 : break;
9880 : case Node::TYPE_SPLIT:
9881 : {
9882 : ++level;
9883 : DebugLogAllAllocationNode(node->split.leftChild, level);
9884 : DebugLogAllAllocationNode(node->split.leftChild->buddy, level);
9885 : }
9886 : break;
9887 : default:
9888 : VMA_ASSERT(0);
9889 : }
9890 : }
9891 :
9892 : #if VMA_STATS_STRING_ENABLED
9893 : void VmaBlockMetadata_Buddy::PrintDetailedMapNode(class VmaJsonWriter& json, const Node* node, VkDeviceSize levelNodeSize) const
9894 : {
9895 : switch (node->type)
9896 : {
9897 : case Node::TYPE_FREE:
9898 : PrintDetailedMap_UnusedRange(json, node->offset, levelNodeSize);
9899 : break;
9900 : case Node::TYPE_ALLOCATION:
9901 : PrintDetailedMap_Allocation(json, node->offset, levelNodeSize, node->allocation.userData);
9902 : break;
9903 : case Node::TYPE_SPLIT:
9904 : {
9905 : const VkDeviceSize childrenNodeSize = levelNodeSize / 2;
9906 : const Node* const leftChild = node->split.leftChild;
9907 : PrintDetailedMapNode(json, leftChild, childrenNodeSize);
9908 : const Node* const rightChild = leftChild->buddy;
9909 : PrintDetailedMapNode(json, rightChild, childrenNodeSize);
9910 : }
9911 : break;
9912 : default:
9913 : VMA_ASSERT(0);
9914 : }
9915 : }
9916 : #endif // VMA_STATS_STRING_ENABLED
9917 : #endif // _VMA_BLOCK_METADATA_BUDDY_FUNCTIONS
9918 : #endif // _VMA_BLOCK_METADATA_BUDDY
9919 : #endif // #if 0
9920 :
9921 : #ifndef _VMA_BLOCK_METADATA_TLSF
9922 : // To not search current larger region if first allocation won't succeed and skip to smaller range
9923 : // use with VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT as strategy in CreateAllocationRequest().
9924 : // When fragmentation and reusal of previous blocks doesn't matter then use with
9925 : // VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT for fastest alloc time possible.
9926 : class VmaBlockMetadata_TLSF : public VmaBlockMetadata
9927 : {
9928 : VMA_CLASS_NO_COPY(VmaBlockMetadata_TLSF)
9929 : public:
9930 : VmaBlockMetadata_TLSF(const VkAllocationCallbacks* pAllocationCallbacks,
9931 : VkDeviceSize bufferImageGranularity, bool isVirtual);
9932 : virtual ~VmaBlockMetadata_TLSF();
9933 :
9934 0 : size_t GetAllocationCount() const override { return m_AllocCount; }
9935 0 : size_t GetFreeRegionsCount() const override { return m_BlocksFreeCount + 1; }
9936 0 : VkDeviceSize GetSumFreeSize() const override { return m_BlocksFreeSize + m_NullBlock->size; }
9937 0 : bool IsEmpty() const override { return m_NullBlock->offset == 0; }
9938 0 : VkDeviceSize GetAllocationOffset(VmaAllocHandle allocHandle) const override { return ((Block*)allocHandle)->offset; };
9939 :
9940 : void Init(VkDeviceSize size) override;
9941 : bool Validate() const override;
9942 :
9943 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const override;
9944 : void AddStatistics(VmaStatistics& inoutStats) const override;
9945 :
9946 : #if VMA_STATS_STRING_ENABLED
9947 : void PrintDetailedMap(class VmaJsonWriter& json) const override;
9948 : #endif
9949 :
9950 : bool CreateAllocationRequest(
9951 : VkDeviceSize allocSize,
9952 : VkDeviceSize allocAlignment,
9953 : bool upperAddress,
9954 : VmaSuballocationType allocType,
9955 : uint32_t strategy,
9956 : VmaAllocationRequest* pAllocationRequest) override;
9957 :
9958 : VkResult CheckCorruption(const void* pBlockData) override;
9959 : void Alloc(
9960 : const VmaAllocationRequest& request,
9961 : VmaSuballocationType type,
9962 : void* userData) override;
9963 :
9964 : void Free(VmaAllocHandle allocHandle) override;
9965 : void GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo) override;
9966 : void* GetAllocationUserData(VmaAllocHandle allocHandle) const override;
9967 : VmaAllocHandle GetAllocationListBegin() const override;
9968 : VmaAllocHandle GetNextAllocation(VmaAllocHandle prevAlloc) const override;
9969 : VkDeviceSize GetNextFreeRegionSize(VmaAllocHandle alloc) const override;
9970 : void Clear() override;
9971 : void SetAllocationUserData(VmaAllocHandle allocHandle, void* userData) override;
9972 : void DebugLogAllAllocations() const override;
9973 :
9974 : private:
9975 : // According to original paper it should be preferable 4 or 5:
9976 : // M. Masmano, I. Ripoll, A. Crespo, and J. Real "TLSF: a New Dynamic Memory Allocator for Real-Time Systems"
9977 : // http://www.gii.upv.es/tlsf/files/ecrts04_tlsf.pdf
9978 : static const uint8_t SECOND_LEVEL_INDEX = 5;
9979 : static const uint16_t SMALL_BUFFER_SIZE = 256;
9980 : static const uint32_t INITIAL_BLOCK_ALLOC_COUNT = 16;
9981 : static const uint8_t MEMORY_CLASS_SHIFT = 7;
9982 : static const uint8_t MAX_MEMORY_CLASSES = 65 - MEMORY_CLASS_SHIFT;
9983 :
9984 : class Block
9985 : {
9986 : public:
9987 : VkDeviceSize offset;
9988 : VkDeviceSize size;
9989 : Block* prevPhysical;
9990 : Block* nextPhysical;
9991 :
9992 0 : void MarkFree() { prevFree = VMA_NULL; }
9993 0 : void MarkTaken() { prevFree = this; }
9994 0 : bool IsFree() const { return prevFree != this; }
9995 0 : void*& UserData() { VMA_HEAVY_ASSERT(!IsFree()); return userData; }
9996 0 : Block*& PrevFree() { return prevFree; }
9997 0 : Block*& NextFree() { VMA_HEAVY_ASSERT(IsFree()); return nextFree; }
9998 :
9999 : private:
10000 : Block* prevFree; // Address of the same block here indicates that block is taken
10001 : union
10002 : {
10003 : Block* nextFree;
10004 : void* userData;
10005 : };
10006 : };
10007 :
10008 : size_t m_AllocCount;
10009 : // Total number of free blocks besides null block
10010 : size_t m_BlocksFreeCount;
10011 : // Total size of free blocks excluding null block
10012 : VkDeviceSize m_BlocksFreeSize;
10013 : uint32_t m_IsFreeBitmap;
10014 : uint8_t m_MemoryClasses;
10015 : uint32_t m_InnerIsFreeBitmap[MAX_MEMORY_CLASSES];
10016 : uint32_t m_ListsCount;
10017 : /*
10018 : * 0: 0-3 lists for small buffers
10019 : * 1+: 0-(2^SLI-1) lists for normal buffers
10020 : */
10021 : Block** m_FreeList;
10022 : VmaPoolAllocator<Block> m_BlockAllocator;
10023 : Block* m_NullBlock;
10024 : VmaBlockBufferImageGranularity m_GranularityHandler;
10025 :
10026 : uint8_t SizeToMemoryClass(VkDeviceSize size) const;
10027 : uint16_t SizeToSecondIndex(VkDeviceSize size, uint8_t memoryClass) const;
10028 : uint32_t GetListIndex(uint8_t memoryClass, uint16_t secondIndex) const;
10029 : uint32_t GetListIndex(VkDeviceSize size) const;
10030 :
10031 : void RemoveFreeBlock(Block* block);
10032 : void InsertFreeBlock(Block* block);
10033 : void MergeBlock(Block* block, Block* prev);
10034 :
10035 : Block* FindFreeBlock(VkDeviceSize size, uint32_t& listIndex) const;
10036 : bool CheckBlock(
10037 : Block& block,
10038 : uint32_t listIndex,
10039 : VkDeviceSize allocSize,
10040 : VkDeviceSize allocAlignment,
10041 : VmaSuballocationType allocType,
10042 : VmaAllocationRequest* pAllocationRequest);
10043 : };
10044 :
10045 : #ifndef _VMA_BLOCK_METADATA_TLSF_FUNCTIONS
10046 0 : VmaBlockMetadata_TLSF::VmaBlockMetadata_TLSF(const VkAllocationCallbacks* pAllocationCallbacks,
10047 0 : VkDeviceSize bufferImageGranularity, bool isVirtual)
10048 : : VmaBlockMetadata(pAllocationCallbacks, bufferImageGranularity, isVirtual),
10049 : m_AllocCount(0),
10050 : m_BlocksFreeCount(0),
10051 : m_BlocksFreeSize(0),
10052 : m_IsFreeBitmap(0),
10053 : m_MemoryClasses(0),
10054 : m_ListsCount(0),
10055 : m_FreeList(VMA_NULL),
10056 : m_BlockAllocator(pAllocationCallbacks, INITIAL_BLOCK_ALLOC_COUNT),
10057 : m_NullBlock(VMA_NULL),
10058 0 : m_GranularityHandler(bufferImageGranularity) {}
10059 :
10060 0 : VmaBlockMetadata_TLSF::~VmaBlockMetadata_TLSF()
10061 : {
10062 0 : if (m_FreeList)
10063 0 : vma_delete_array(GetAllocationCallbacks(), m_FreeList, m_ListsCount);
10064 0 : m_GranularityHandler.Destroy(GetAllocationCallbacks());
10065 0 : }
10066 :
10067 0 : void VmaBlockMetadata_TLSF::Init(VkDeviceSize size)
10068 : {
10069 0 : VmaBlockMetadata::Init(size);
10070 :
10071 0 : if (!IsVirtual())
10072 0 : m_GranularityHandler.Init(GetAllocationCallbacks(), size);
10073 :
10074 0 : m_NullBlock = m_BlockAllocator.Alloc();
10075 0 : m_NullBlock->size = size;
10076 0 : m_NullBlock->offset = 0;
10077 0 : m_NullBlock->prevPhysical = VMA_NULL;
10078 0 : m_NullBlock->nextPhysical = VMA_NULL;
10079 0 : m_NullBlock->MarkFree();
10080 0 : m_NullBlock->NextFree() = VMA_NULL;
10081 0 : m_NullBlock->PrevFree() = VMA_NULL;
10082 0 : uint8_t memoryClass = SizeToMemoryClass(size);
10083 0 : uint16_t sli = SizeToSecondIndex(size, memoryClass);
10084 0 : m_ListsCount = (memoryClass == 0 ? 0 : (memoryClass - 1) * (1UL << SECOND_LEVEL_INDEX) + sli) + 1;
10085 0 : if (IsVirtual())
10086 0 : m_ListsCount += 1UL << SECOND_LEVEL_INDEX;
10087 : else
10088 0 : m_ListsCount += 4;
10089 :
10090 0 : m_MemoryClasses = memoryClass + 2;
10091 0 : memset(m_InnerIsFreeBitmap, 0, MAX_MEMORY_CLASSES * sizeof(uint32_t));
10092 :
10093 0 : m_FreeList = vma_new_array(GetAllocationCallbacks(), Block*, m_ListsCount);
10094 0 : memset(m_FreeList, 0, m_ListsCount * sizeof(Block*));
10095 0 : }
10096 :
10097 0 : bool VmaBlockMetadata_TLSF::Validate() const
10098 : {
10099 0 : VMA_VALIDATE(GetSumFreeSize() <= GetSize());
10100 :
10101 0 : VkDeviceSize calculatedSize = m_NullBlock->size;
10102 0 : VkDeviceSize calculatedFreeSize = m_NullBlock->size;
10103 0 : size_t allocCount = 0;
10104 0 : size_t freeCount = 0;
10105 :
10106 : // Check integrity of free lists
10107 0 : for (uint32_t list = 0; list < m_ListsCount; ++list)
10108 : {
10109 0 : Block* block = m_FreeList[list];
10110 0 : if (block != VMA_NULL)
10111 : {
10112 0 : VMA_VALIDATE(block->IsFree());
10113 0 : VMA_VALIDATE(block->PrevFree() == VMA_NULL);
10114 0 : while (block->NextFree())
10115 : {
10116 0 : VMA_VALIDATE(block->NextFree()->IsFree());
10117 0 : VMA_VALIDATE(block->NextFree()->PrevFree() == block);
10118 0 : block = block->NextFree();
10119 : }
10120 : }
10121 : }
10122 :
10123 0 : VkDeviceSize nextOffset = m_NullBlock->offset;
10124 0 : auto validateCtx = m_GranularityHandler.StartValidation(GetAllocationCallbacks(), IsVirtual());
10125 :
10126 0 : VMA_VALIDATE(m_NullBlock->nextPhysical == VMA_NULL);
10127 0 : if (m_NullBlock->prevPhysical)
10128 : {
10129 0 : VMA_VALIDATE(m_NullBlock->prevPhysical->nextPhysical == m_NullBlock);
10130 : }
10131 : // Check all blocks
10132 0 : for (Block* prev = m_NullBlock->prevPhysical; prev != VMA_NULL; prev = prev->prevPhysical)
10133 : {
10134 0 : VMA_VALIDATE(prev->offset + prev->size == nextOffset);
10135 0 : nextOffset = prev->offset;
10136 0 : calculatedSize += prev->size;
10137 :
10138 0 : uint32_t listIndex = GetListIndex(prev->size);
10139 0 : if (prev->IsFree())
10140 : {
10141 0 : ++freeCount;
10142 : // Check if free block belongs to free list
10143 0 : Block* freeBlock = m_FreeList[listIndex];
10144 0 : VMA_VALIDATE(freeBlock != VMA_NULL);
10145 :
10146 0 : bool found = false;
10147 0 : do
10148 : {
10149 0 : if (freeBlock == prev)
10150 0 : found = true;
10151 :
10152 0 : freeBlock = freeBlock->NextFree();
10153 0 : } while (!found && freeBlock != VMA_NULL);
10154 :
10155 0 : VMA_VALIDATE(found);
10156 0 : calculatedFreeSize += prev->size;
10157 : }
10158 : else
10159 : {
10160 0 : ++allocCount;
10161 : // Check if taken block is not on a free list
10162 0 : Block* freeBlock = m_FreeList[listIndex];
10163 0 : while (freeBlock)
10164 : {
10165 0 : VMA_VALIDATE(freeBlock != prev);
10166 0 : freeBlock = freeBlock->NextFree();
10167 : }
10168 :
10169 0 : if (!IsVirtual())
10170 : {
10171 0 : VMA_VALIDATE(m_GranularityHandler.Validate(validateCtx, prev->offset, prev->size));
10172 : }
10173 : }
10174 :
10175 0 : if (prev->prevPhysical)
10176 : {
10177 0 : VMA_VALIDATE(prev->prevPhysical->nextPhysical == prev);
10178 : }
10179 : }
10180 :
10181 0 : if (!IsVirtual())
10182 : {
10183 0 : VMA_VALIDATE(m_GranularityHandler.FinishValidation(validateCtx));
10184 : }
10185 :
10186 0 : VMA_VALIDATE(nextOffset == 0);
10187 0 : VMA_VALIDATE(calculatedSize == GetSize());
10188 0 : VMA_VALIDATE(calculatedFreeSize == GetSumFreeSize());
10189 0 : VMA_VALIDATE(allocCount == m_AllocCount);
10190 0 : VMA_VALIDATE(freeCount == m_BlocksFreeCount);
10191 :
10192 0 : return true;
10193 : }
10194 :
10195 0 : void VmaBlockMetadata_TLSF::AddDetailedStatistics(VmaDetailedStatistics& inoutStats) const
10196 : {
10197 0 : inoutStats.statistics.blockCount++;
10198 0 : inoutStats.statistics.blockBytes += GetSize();
10199 0 : if (m_NullBlock->size > 0)
10200 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, m_NullBlock->size);
10201 :
10202 0 : for (Block* block = m_NullBlock->prevPhysical; block != VMA_NULL; block = block->prevPhysical)
10203 : {
10204 0 : if (block->IsFree())
10205 0 : VmaAddDetailedStatisticsUnusedRange(inoutStats, block->size);
10206 : else
10207 0 : VmaAddDetailedStatisticsAllocation(inoutStats, block->size);
10208 : }
10209 0 : }
10210 :
10211 0 : void VmaBlockMetadata_TLSF::AddStatistics(VmaStatistics& inoutStats) const
10212 : {
10213 0 : inoutStats.blockCount++;
10214 0 : inoutStats.allocationCount += (uint32_t)m_AllocCount;
10215 0 : inoutStats.blockBytes += GetSize();
10216 0 : inoutStats.allocationBytes += GetSize() - GetSumFreeSize();
10217 0 : }
10218 :
10219 : #if VMA_STATS_STRING_ENABLED
10220 0 : void VmaBlockMetadata_TLSF::PrintDetailedMap(class VmaJsonWriter& json) const
10221 : {
10222 0 : size_t blockCount = m_AllocCount + m_BlocksFreeCount;
10223 0 : VmaStlAllocator<Block*> allocator(GetAllocationCallbacks());
10224 0 : VmaVector<Block*, VmaStlAllocator<Block*>> blockList(blockCount, allocator);
10225 :
10226 0 : size_t i = blockCount;
10227 0 : for (Block* block = m_NullBlock->prevPhysical; block != VMA_NULL; block = block->prevPhysical)
10228 : {
10229 0 : blockList[--i] = block;
10230 : }
10231 0 : VMA_ASSERT(i == 0);
10232 :
10233 : VmaDetailedStatistics stats;
10234 0 : VmaClearDetailedStatistics(stats);
10235 0 : AddDetailedStatistics(stats);
10236 :
10237 0 : PrintDetailedMap_Begin(json,
10238 0 : stats.statistics.blockBytes - stats.statistics.allocationBytes,
10239 0 : stats.statistics.allocationCount,
10240 0 : stats.unusedRangeCount);
10241 :
10242 0 : for (; i < blockCount; ++i)
10243 : {
10244 0 : Block* block = blockList[i];
10245 0 : if (block->IsFree())
10246 0 : PrintDetailedMap_UnusedRange(json, block->offset, block->size);
10247 : else
10248 0 : PrintDetailedMap_Allocation(json, block->offset, block->size, block->UserData());
10249 : }
10250 0 : if (m_NullBlock->size > 0)
10251 0 : PrintDetailedMap_UnusedRange(json, m_NullBlock->offset, m_NullBlock->size);
10252 :
10253 0 : PrintDetailedMap_End(json);
10254 0 : }
10255 : #endif
10256 :
10257 0 : bool VmaBlockMetadata_TLSF::CreateAllocationRequest(
10258 : VkDeviceSize allocSize,
10259 : VkDeviceSize allocAlignment,
10260 : bool upperAddress,
10261 : VmaSuballocationType allocType,
10262 : uint32_t strategy,
10263 : VmaAllocationRequest* pAllocationRequest)
10264 : {
10265 0 : VMA_ASSERT(allocSize > 0 && "Cannot allocate empty block!");
10266 0 : VMA_ASSERT(!upperAddress && "VMA_ALLOCATION_CREATE_UPPER_ADDRESS_BIT can be used only with linear algorithm.");
10267 :
10268 : // For small granularity round up
10269 0 : if (!IsVirtual())
10270 0 : m_GranularityHandler.RoundupAllocRequest(allocType, allocSize, allocAlignment);
10271 :
10272 0 : allocSize += GetDebugMargin();
10273 : // Quick check for too small pool
10274 0 : if (allocSize > GetSumFreeSize())
10275 0 : return false;
10276 :
10277 : // If no free blocks in pool then check only null block
10278 0 : if (m_BlocksFreeCount == 0)
10279 0 : return CheckBlock(*m_NullBlock, m_ListsCount, allocSize, allocAlignment, allocType, pAllocationRequest);
10280 :
10281 : // Round up to the next block
10282 0 : VkDeviceSize sizeForNextList = allocSize;
10283 0 : VkDeviceSize smallSizeStep = SMALL_BUFFER_SIZE / (IsVirtual() ? 1 << SECOND_LEVEL_INDEX : 4);
10284 0 : if (allocSize > SMALL_BUFFER_SIZE)
10285 : {
10286 0 : sizeForNextList += (1ULL << (VMA_BITSCAN_MSB(allocSize) - SECOND_LEVEL_INDEX));
10287 : }
10288 0 : else if (allocSize > SMALL_BUFFER_SIZE - smallSizeStep)
10289 0 : sizeForNextList = SMALL_BUFFER_SIZE + 1;
10290 : else
10291 0 : sizeForNextList += smallSizeStep;
10292 :
10293 0 : uint32_t nextListIndex = 0;
10294 0 : uint32_t prevListIndex = 0;
10295 0 : Block* nextListBlock = VMA_NULL;
10296 0 : Block* prevListBlock = VMA_NULL;
10297 :
10298 : // Check blocks according to strategies
10299 0 : if (strategy & VMA_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT)
10300 : {
10301 : // Quick check for larger block first
10302 0 : nextListBlock = FindFreeBlock(sizeForNextList, nextListIndex);
10303 0 : if (nextListBlock != VMA_NULL && CheckBlock(*nextListBlock, nextListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10304 0 : return true;
10305 :
10306 : // If not fitted then null block
10307 0 : if (CheckBlock(*m_NullBlock, m_ListsCount, allocSize, allocAlignment, allocType, pAllocationRequest))
10308 0 : return true;
10309 :
10310 : // Null block failed, search larger bucket
10311 0 : while (nextListBlock)
10312 : {
10313 0 : if (CheckBlock(*nextListBlock, nextListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10314 0 : return true;
10315 0 : nextListBlock = nextListBlock->NextFree();
10316 : }
10317 :
10318 : // Failed again, check best fit bucket
10319 0 : prevListBlock = FindFreeBlock(allocSize, prevListIndex);
10320 0 : while (prevListBlock)
10321 : {
10322 0 : if (CheckBlock(*prevListBlock, prevListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10323 0 : return true;
10324 0 : prevListBlock = prevListBlock->NextFree();
10325 : }
10326 : }
10327 0 : else if (strategy & VMA_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT)
10328 : {
10329 : // Check best fit bucket
10330 0 : prevListBlock = FindFreeBlock(allocSize, prevListIndex);
10331 0 : while (prevListBlock)
10332 : {
10333 0 : if (CheckBlock(*prevListBlock, prevListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10334 0 : return true;
10335 0 : prevListBlock = prevListBlock->NextFree();
10336 : }
10337 :
10338 : // If failed check null block
10339 0 : if (CheckBlock(*m_NullBlock, m_ListsCount, allocSize, allocAlignment, allocType, pAllocationRequest))
10340 0 : return true;
10341 :
10342 : // Check larger bucket
10343 0 : nextListBlock = FindFreeBlock(sizeForNextList, nextListIndex);
10344 0 : while (nextListBlock)
10345 : {
10346 0 : if (CheckBlock(*nextListBlock, nextListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10347 0 : return true;
10348 0 : nextListBlock = nextListBlock->NextFree();
10349 : }
10350 : }
10351 0 : else if (strategy & VMA_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT )
10352 : {
10353 : // Perform search from the start
10354 0 : VmaStlAllocator<Block*> allocator(GetAllocationCallbacks());
10355 0 : VmaVector<Block*, VmaStlAllocator<Block*>> blockList(m_BlocksFreeCount, allocator);
10356 :
10357 0 : size_t i = m_BlocksFreeCount;
10358 0 : for (Block* block = m_NullBlock->prevPhysical; block != VMA_NULL; block = block->prevPhysical)
10359 : {
10360 0 : if (block->IsFree() && block->size >= allocSize)
10361 0 : blockList[--i] = block;
10362 : }
10363 :
10364 0 : for (; i < m_BlocksFreeCount; ++i)
10365 : {
10366 0 : Block& block = *blockList[i];
10367 0 : if (CheckBlock(block, GetListIndex(block.size), allocSize, allocAlignment, allocType, pAllocationRequest))
10368 0 : return true;
10369 : }
10370 :
10371 : // If failed check null block
10372 0 : if (CheckBlock(*m_NullBlock, m_ListsCount, allocSize, allocAlignment, allocType, pAllocationRequest))
10373 0 : return true;
10374 :
10375 : // Whole range searched, no more memory
10376 0 : return false;
10377 : }
10378 : else
10379 : {
10380 : // Check larger bucket
10381 0 : nextListBlock = FindFreeBlock(sizeForNextList, nextListIndex);
10382 0 : while (nextListBlock)
10383 : {
10384 0 : if (CheckBlock(*nextListBlock, nextListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10385 0 : return true;
10386 0 : nextListBlock = nextListBlock->NextFree();
10387 : }
10388 :
10389 : // If failed check null block
10390 0 : if (CheckBlock(*m_NullBlock, m_ListsCount, allocSize, allocAlignment, allocType, pAllocationRequest))
10391 0 : return true;
10392 :
10393 : // Check best fit bucket
10394 0 : prevListBlock = FindFreeBlock(allocSize, prevListIndex);
10395 0 : while (prevListBlock)
10396 : {
10397 0 : if (CheckBlock(*prevListBlock, prevListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10398 0 : return true;
10399 0 : prevListBlock = prevListBlock->NextFree();
10400 : }
10401 : }
10402 :
10403 : // Worst case, full search has to be done
10404 0 : while (++nextListIndex < m_ListsCount)
10405 : {
10406 0 : nextListBlock = m_FreeList[nextListIndex];
10407 0 : while (nextListBlock)
10408 : {
10409 0 : if (CheckBlock(*nextListBlock, nextListIndex, allocSize, allocAlignment, allocType, pAllocationRequest))
10410 0 : return true;
10411 0 : nextListBlock = nextListBlock->NextFree();
10412 : }
10413 : }
10414 :
10415 : // No more memory sadly
10416 0 : return false;
10417 : }
10418 :
10419 0 : VkResult VmaBlockMetadata_TLSF::CheckCorruption(const void* pBlockData)
10420 : {
10421 0 : for (Block* block = m_NullBlock->prevPhysical; block != VMA_NULL; block = block->prevPhysical)
10422 : {
10423 0 : if (!block->IsFree())
10424 : {
10425 0 : if (!VmaValidateMagicValue(pBlockData, block->offset + block->size))
10426 : {
10427 0 : VMA_ASSERT(0 && "MEMORY CORRUPTION DETECTED AFTER VALIDATED ALLOCATION!");
10428 0 : return VK_ERROR_UNKNOWN_COPY;
10429 : }
10430 : }
10431 : }
10432 :
10433 0 : return VK_SUCCESS;
10434 : }
10435 :
10436 0 : void VmaBlockMetadata_TLSF::Alloc(
10437 : const VmaAllocationRequest& request,
10438 : VmaSuballocationType type,
10439 : void* userData)
10440 : {
10441 0 : VMA_ASSERT(request.type == VmaAllocationRequestType::TLSF);
10442 :
10443 : // Get block and pop it from the free list
10444 0 : Block* currentBlock = (Block*)request.allocHandle;
10445 0 : VkDeviceSize offset = request.algorithmData;
10446 0 : VMA_ASSERT(currentBlock != VMA_NULL);
10447 0 : VMA_ASSERT(currentBlock->offset <= offset);
10448 :
10449 0 : if (currentBlock != m_NullBlock)
10450 0 : RemoveFreeBlock(currentBlock);
10451 :
10452 0 : VkDeviceSize debugMargin = GetDebugMargin();
10453 0 : VkDeviceSize misssingAlignment = offset - currentBlock->offset;
10454 :
10455 : // Append missing alignment to prev block or create new one
10456 0 : if (misssingAlignment)
10457 : {
10458 0 : Block* prevBlock = currentBlock->prevPhysical;
10459 0 : VMA_ASSERT(prevBlock != VMA_NULL && "There should be no missing alignment at offset 0!");
10460 :
10461 0 : if (prevBlock->IsFree() && prevBlock->size != debugMargin)
10462 : {
10463 0 : uint32_t oldList = GetListIndex(prevBlock->size);
10464 0 : prevBlock->size += misssingAlignment;
10465 : // Check if new size crosses list bucket
10466 0 : if (oldList != GetListIndex(prevBlock->size))
10467 : {
10468 0 : prevBlock->size -= misssingAlignment;
10469 0 : RemoveFreeBlock(prevBlock);
10470 0 : prevBlock->size += misssingAlignment;
10471 0 : InsertFreeBlock(prevBlock);
10472 : }
10473 : else
10474 0 : m_BlocksFreeSize += misssingAlignment;
10475 : }
10476 : else
10477 : {
10478 0 : Block* newBlock = m_BlockAllocator.Alloc();
10479 0 : currentBlock->prevPhysical = newBlock;
10480 0 : prevBlock->nextPhysical = newBlock;
10481 0 : newBlock->prevPhysical = prevBlock;
10482 0 : newBlock->nextPhysical = currentBlock;
10483 0 : newBlock->size = misssingAlignment;
10484 0 : newBlock->offset = currentBlock->offset;
10485 0 : newBlock->MarkTaken();
10486 :
10487 0 : InsertFreeBlock(newBlock);
10488 : }
10489 :
10490 0 : currentBlock->size -= misssingAlignment;
10491 0 : currentBlock->offset += misssingAlignment;
10492 : }
10493 :
10494 0 : VkDeviceSize size = request.size + debugMargin;
10495 0 : if (currentBlock->size == size)
10496 : {
10497 0 : if (currentBlock == m_NullBlock)
10498 : {
10499 : // Setup new null block
10500 0 : m_NullBlock = m_BlockAllocator.Alloc();
10501 0 : m_NullBlock->size = 0;
10502 0 : m_NullBlock->offset = currentBlock->offset + size;
10503 0 : m_NullBlock->prevPhysical = currentBlock;
10504 0 : m_NullBlock->nextPhysical = VMA_NULL;
10505 0 : m_NullBlock->MarkFree();
10506 0 : m_NullBlock->PrevFree() = VMA_NULL;
10507 0 : m_NullBlock->NextFree() = VMA_NULL;
10508 0 : currentBlock->nextPhysical = m_NullBlock;
10509 0 : currentBlock->MarkTaken();
10510 : }
10511 : }
10512 : else
10513 : {
10514 0 : VMA_ASSERT(currentBlock->size > size && "Proper block already found, shouldn't find smaller one!");
10515 :
10516 : // Create new free block
10517 0 : Block* newBlock = m_BlockAllocator.Alloc();
10518 0 : newBlock->size = currentBlock->size - size;
10519 0 : newBlock->offset = currentBlock->offset + size;
10520 0 : newBlock->prevPhysical = currentBlock;
10521 0 : newBlock->nextPhysical = currentBlock->nextPhysical;
10522 0 : currentBlock->nextPhysical = newBlock;
10523 0 : currentBlock->size = size;
10524 :
10525 0 : if (currentBlock == m_NullBlock)
10526 : {
10527 0 : m_NullBlock = newBlock;
10528 0 : m_NullBlock->MarkFree();
10529 0 : m_NullBlock->NextFree() = VMA_NULL;
10530 0 : m_NullBlock->PrevFree() = VMA_NULL;
10531 0 : currentBlock->MarkTaken();
10532 : }
10533 : else
10534 : {
10535 0 : newBlock->nextPhysical->prevPhysical = newBlock;
10536 0 : newBlock->MarkTaken();
10537 0 : InsertFreeBlock(newBlock);
10538 : }
10539 : }
10540 0 : currentBlock->UserData() = userData;
10541 :
10542 0 : if (debugMargin > 0)
10543 : {
10544 0 : currentBlock->size -= debugMargin;
10545 0 : Block* newBlock = m_BlockAllocator.Alloc();
10546 0 : newBlock->size = debugMargin;
10547 0 : newBlock->offset = currentBlock->offset + currentBlock->size;
10548 0 : newBlock->prevPhysical = currentBlock;
10549 0 : newBlock->nextPhysical = currentBlock->nextPhysical;
10550 0 : newBlock->MarkTaken();
10551 0 : currentBlock->nextPhysical->prevPhysical = newBlock;
10552 0 : currentBlock->nextPhysical = newBlock;
10553 0 : InsertFreeBlock(newBlock);
10554 : }
10555 :
10556 0 : if (!IsVirtual())
10557 0 : m_GranularityHandler.AllocPages((uint8_t)(uintptr_t)request.customData,
10558 : currentBlock->offset, currentBlock->size);
10559 0 : ++m_AllocCount;
10560 0 : }
10561 :
10562 0 : void VmaBlockMetadata_TLSF::Free(VmaAllocHandle allocHandle)
10563 : {
10564 0 : Block* block = (Block*)allocHandle;
10565 0 : Block* next = block->nextPhysical;
10566 0 : VMA_ASSERT(!block->IsFree() && "Block is already free!");
10567 :
10568 0 : if (!IsVirtual())
10569 0 : m_GranularityHandler.FreePages(block->offset, block->size);
10570 0 : --m_AllocCount;
10571 :
10572 0 : VkDeviceSize debugMargin = GetDebugMargin();
10573 0 : if (debugMargin > 0)
10574 : {
10575 0 : RemoveFreeBlock(next);
10576 0 : MergeBlock(next, block);
10577 0 : block = next;
10578 0 : next = next->nextPhysical;
10579 : }
10580 :
10581 : // Try merging
10582 0 : Block* prev = block->prevPhysical;
10583 0 : if (prev != VMA_NULL && prev->IsFree() && prev->size != debugMargin)
10584 : {
10585 0 : RemoveFreeBlock(prev);
10586 0 : MergeBlock(block, prev);
10587 : }
10588 :
10589 0 : if (!next->IsFree())
10590 0 : InsertFreeBlock(block);
10591 0 : else if (next == m_NullBlock)
10592 0 : MergeBlock(m_NullBlock, block);
10593 : else
10594 : {
10595 0 : RemoveFreeBlock(next);
10596 0 : MergeBlock(next, block);
10597 0 : InsertFreeBlock(next);
10598 : }
10599 0 : }
10600 :
10601 0 : void VmaBlockMetadata_TLSF::GetAllocationInfo(VmaAllocHandle allocHandle, VmaVirtualAllocationInfo& outInfo)
10602 : {
10603 0 : Block* block = (Block*)allocHandle;
10604 0 : VMA_ASSERT(!block->IsFree() && "Cannot get allocation info for free block!");
10605 0 : outInfo.offset = block->offset;
10606 0 : outInfo.size = block->size;
10607 0 : outInfo.pUserData = block->UserData();
10608 0 : }
10609 :
10610 0 : void* VmaBlockMetadata_TLSF::GetAllocationUserData(VmaAllocHandle allocHandle) const
10611 : {
10612 0 : Block* block = (Block*)allocHandle;
10613 0 : VMA_ASSERT(!block->IsFree() && "Cannot get user data for free block!");
10614 0 : return block->UserData();
10615 : }
10616 :
10617 0 : VmaAllocHandle VmaBlockMetadata_TLSF::GetAllocationListBegin() const
10618 : {
10619 0 : if (m_AllocCount == 0)
10620 0 : return VK_NULL_HANDLE;
10621 :
10622 0 : for (Block* block = m_NullBlock->prevPhysical; block; block = block->prevPhysical)
10623 : {
10624 0 : if (!block->IsFree())
10625 0 : return (VmaAllocHandle)block;
10626 : }
10627 0 : VMA_ASSERT(false && "If m_AllocCount > 0 then should find any allocation!");
10628 0 : return VK_NULL_HANDLE;
10629 : }
10630 :
10631 0 : VmaAllocHandle VmaBlockMetadata_TLSF::GetNextAllocation(VmaAllocHandle prevAlloc) const
10632 : {
10633 0 : Block* startBlock = (Block*)prevAlloc;
10634 0 : VMA_ASSERT(!startBlock->IsFree() && "Incorrect block!");
10635 :
10636 0 : for (Block* block = startBlock->prevPhysical; block; block = block->prevPhysical)
10637 : {
10638 0 : if (!block->IsFree())
10639 0 : return (VmaAllocHandle)block;
10640 : }
10641 0 : return VK_NULL_HANDLE;
10642 : }
10643 :
10644 0 : VkDeviceSize VmaBlockMetadata_TLSF::GetNextFreeRegionSize(VmaAllocHandle alloc) const
10645 : {
10646 0 : Block* block = (Block*)alloc;
10647 0 : VMA_ASSERT(!block->IsFree() && "Incorrect block!");
10648 :
10649 0 : if (block->prevPhysical)
10650 0 : return block->prevPhysical->IsFree() ? block->prevPhysical->size : 0;
10651 0 : return 0;
10652 : }
10653 :
10654 0 : void VmaBlockMetadata_TLSF::Clear()
10655 : {
10656 0 : m_AllocCount = 0;
10657 0 : m_BlocksFreeCount = 0;
10658 0 : m_BlocksFreeSize = 0;
10659 0 : m_IsFreeBitmap = 0;
10660 0 : m_NullBlock->offset = 0;
10661 0 : m_NullBlock->size = GetSize();
10662 0 : Block* block = m_NullBlock->prevPhysical;
10663 0 : m_NullBlock->prevPhysical = VMA_NULL;
10664 0 : while (block)
10665 : {
10666 0 : Block* prev = block->prevPhysical;
10667 0 : m_BlockAllocator.Free(block);
10668 0 : block = prev;
10669 : }
10670 0 : memset(m_FreeList, 0, m_ListsCount * sizeof(Block*));
10671 0 : memset(m_InnerIsFreeBitmap, 0, m_MemoryClasses * sizeof(uint32_t));
10672 0 : m_GranularityHandler.Clear();
10673 0 : }
10674 :
10675 0 : void VmaBlockMetadata_TLSF::SetAllocationUserData(VmaAllocHandle allocHandle, void* userData)
10676 : {
10677 0 : Block* block = (Block*)allocHandle;
10678 0 : VMA_ASSERT(!block->IsFree() && "Trying to set user data for not allocated block!");
10679 0 : block->UserData() = userData;
10680 0 : }
10681 :
10682 0 : void VmaBlockMetadata_TLSF::DebugLogAllAllocations() const
10683 : {
10684 0 : for (Block* block = m_NullBlock->prevPhysical; block != VMA_NULL; block = block->prevPhysical)
10685 0 : if (!block->IsFree())
10686 0 : DebugLogAllocation(block->offset, block->size, block->UserData());
10687 0 : }
10688 :
10689 0 : uint8_t VmaBlockMetadata_TLSF::SizeToMemoryClass(VkDeviceSize size) const
10690 : {
10691 0 : if (size > SMALL_BUFFER_SIZE)
10692 0 : return VMA_BITSCAN_MSB(size) - MEMORY_CLASS_SHIFT;
10693 0 : return 0;
10694 : }
10695 :
10696 0 : uint16_t VmaBlockMetadata_TLSF::SizeToSecondIndex(VkDeviceSize size, uint8_t memoryClass) const
10697 : {
10698 0 : if (memoryClass == 0)
10699 : {
10700 0 : if (IsVirtual())
10701 0 : return static_cast<uint16_t>((size - 1) / 8);
10702 : else
10703 0 : return static_cast<uint16_t>((size - 1) / 64);
10704 : }
10705 0 : return static_cast<uint16_t>((size >> (memoryClass + MEMORY_CLASS_SHIFT - SECOND_LEVEL_INDEX)) ^ (1U << SECOND_LEVEL_INDEX));
10706 : }
10707 :
10708 0 : uint32_t VmaBlockMetadata_TLSF::GetListIndex(uint8_t memoryClass, uint16_t secondIndex) const
10709 : {
10710 0 : if (memoryClass == 0)
10711 0 : return secondIndex;
10712 :
10713 0 : const uint32_t index = static_cast<uint32_t>(memoryClass - 1) * (1 << SECOND_LEVEL_INDEX) + secondIndex;
10714 0 : if (IsVirtual())
10715 0 : return index + (1 << SECOND_LEVEL_INDEX);
10716 : else
10717 0 : return index + 4;
10718 : }
10719 :
10720 0 : uint32_t VmaBlockMetadata_TLSF::GetListIndex(VkDeviceSize size) const
10721 : {
10722 0 : uint8_t memoryClass = SizeToMemoryClass(size);
10723 0 : return GetListIndex(memoryClass, SizeToSecondIndex(size, memoryClass));
10724 : }
10725 :
10726 0 : void VmaBlockMetadata_TLSF::RemoveFreeBlock(Block* block)
10727 : {
10728 0 : VMA_ASSERT(block != m_NullBlock);
10729 0 : VMA_ASSERT(block->IsFree());
10730 :
10731 0 : if (block->NextFree() != VMA_NULL)
10732 0 : block->NextFree()->PrevFree() = block->PrevFree();
10733 0 : if (block->PrevFree() != VMA_NULL)
10734 0 : block->PrevFree()->NextFree() = block->NextFree();
10735 : else
10736 : {
10737 0 : uint8_t memClass = SizeToMemoryClass(block->size);
10738 0 : uint16_t secondIndex = SizeToSecondIndex(block->size, memClass);
10739 0 : uint32_t index = GetListIndex(memClass, secondIndex);
10740 0 : VMA_ASSERT(m_FreeList[index] == block);
10741 0 : m_FreeList[index] = block->NextFree();
10742 0 : if (block->NextFree() == VMA_NULL)
10743 : {
10744 0 : m_InnerIsFreeBitmap[memClass] &= ~(1U << secondIndex);
10745 0 : if (m_InnerIsFreeBitmap[memClass] == 0)
10746 0 : m_IsFreeBitmap &= ~(1UL << memClass);
10747 : }
10748 : }
10749 0 : block->MarkTaken();
10750 0 : block->UserData() = VMA_NULL;
10751 0 : --m_BlocksFreeCount;
10752 0 : m_BlocksFreeSize -= block->size;
10753 0 : }
10754 :
10755 0 : void VmaBlockMetadata_TLSF::InsertFreeBlock(Block* block)
10756 : {
10757 0 : VMA_ASSERT(block != m_NullBlock);
10758 0 : VMA_ASSERT(!block->IsFree() && "Cannot insert block twice!");
10759 :
10760 0 : uint8_t memClass = SizeToMemoryClass(block->size);
10761 0 : uint16_t secondIndex = SizeToSecondIndex(block->size, memClass);
10762 0 : uint32_t index = GetListIndex(memClass, secondIndex);
10763 0 : VMA_ASSERT(index < m_ListsCount);
10764 0 : block->PrevFree() = VMA_NULL;
10765 0 : block->NextFree() = m_FreeList[index];
10766 0 : m_FreeList[index] = block;
10767 0 : if (block->NextFree() != VMA_NULL)
10768 0 : block->NextFree()->PrevFree() = block;
10769 : else
10770 : {
10771 0 : m_InnerIsFreeBitmap[memClass] |= 1U << secondIndex;
10772 0 : m_IsFreeBitmap |= 1UL << memClass;
10773 : }
10774 0 : ++m_BlocksFreeCount;
10775 0 : m_BlocksFreeSize += block->size;
10776 0 : }
10777 :
10778 0 : void VmaBlockMetadata_TLSF::MergeBlock(Block* block, Block* prev)
10779 : {
10780 0 : VMA_ASSERT(block->prevPhysical == prev && "Cannot merge seperate physical regions!");
10781 0 : VMA_ASSERT(!prev->IsFree() && "Cannot merge block that belongs to free list!");
10782 :
10783 0 : block->offset = prev->offset;
10784 0 : block->size += prev->size;
10785 0 : block->prevPhysical = prev->prevPhysical;
10786 0 : if (block->prevPhysical)
10787 0 : block->prevPhysical->nextPhysical = block;
10788 0 : m_BlockAllocator.Free(prev);
10789 0 : }
10790 :
10791 0 : VmaBlockMetadata_TLSF::Block* VmaBlockMetadata_TLSF::FindFreeBlock(VkDeviceSize size, uint32_t& listIndex) const
10792 : {
10793 0 : uint8_t memoryClass = SizeToMemoryClass(size);
10794 0 : uint32_t innerFreeMap = m_InnerIsFreeBitmap[memoryClass] & (~0U << SizeToSecondIndex(size, memoryClass));
10795 0 : if (!innerFreeMap)
10796 : {
10797 : // Check higher levels for avaiable blocks
10798 0 : uint32_t freeMap = m_IsFreeBitmap & (~0UL << (memoryClass + 1));
10799 0 : if (!freeMap)
10800 0 : return VMA_NULL; // No more memory avaible
10801 :
10802 : // Find lowest free region
10803 0 : memoryClass = VMA_BITSCAN_LSB(freeMap);
10804 0 : innerFreeMap = m_InnerIsFreeBitmap[memoryClass];
10805 0 : VMA_ASSERT(innerFreeMap != 0);
10806 : }
10807 : // Find lowest free subregion
10808 0 : listIndex = GetListIndex(memoryClass, VMA_BITSCAN_LSB(innerFreeMap));
10809 0 : VMA_ASSERT(m_FreeList[listIndex]);
10810 0 : return m_FreeList[listIndex];
10811 : }
10812 :
10813 0 : bool VmaBlockMetadata_TLSF::CheckBlock(
10814 : Block& block,
10815 : uint32_t listIndex,
10816 : VkDeviceSize allocSize,
10817 : VkDeviceSize allocAlignment,
10818 : VmaSuballocationType allocType,
10819 : VmaAllocationRequest* pAllocationRequest)
10820 : {
10821 0 : VMA_ASSERT(block.IsFree() && "Block is already taken!");
10822 :
10823 0 : VkDeviceSize alignedOffset = VmaAlignUp(block.offset, allocAlignment);
10824 0 : if (block.size < allocSize + alignedOffset - block.offset)
10825 0 : return false;
10826 :
10827 : // Check for granularity conflicts
10828 0 : if (!IsVirtual() &&
10829 0 : m_GranularityHandler.CheckConflictAndAlignUp(alignedOffset, allocSize, block.offset, block.size, allocType))
10830 0 : return false;
10831 :
10832 : // Alloc successful
10833 0 : pAllocationRequest->type = VmaAllocationRequestType::TLSF;
10834 0 : pAllocationRequest->allocHandle = (VmaAllocHandle)█
10835 0 : pAllocationRequest->size = allocSize - GetDebugMargin();
10836 0 : pAllocationRequest->customData = (void*)allocType;
10837 0 : pAllocationRequest->algorithmData = alignedOffset;
10838 :
10839 : // Place block at the start of list if it's normal block
10840 0 : if (listIndex != m_ListsCount && block.PrevFree())
10841 : {
10842 0 : block.PrevFree()->NextFree() = block.NextFree();
10843 0 : if (block.NextFree())
10844 0 : block.NextFree()->PrevFree() = block.PrevFree();
10845 0 : block.PrevFree() = VMA_NULL;
10846 0 : block.NextFree() = m_FreeList[listIndex];
10847 0 : m_FreeList[listIndex] = █
10848 0 : if (block.NextFree())
10849 0 : block.NextFree()->PrevFree() = █
10850 : }
10851 :
10852 0 : return true;
10853 : }
10854 : #endif // _VMA_BLOCK_METADATA_TLSF_FUNCTIONS
10855 : #endif // _VMA_BLOCK_METADATA_TLSF
10856 :
10857 : #ifndef _VMA_BLOCK_VECTOR
10858 : /*
10859 : Sequence of VmaDeviceMemoryBlock. Represents memory blocks allocated for a specific
10860 : Vulkan memory type.
10861 :
10862 : Synchronized internally with a mutex.
10863 : */
10864 : class VmaBlockVector
10865 : {
10866 : friend struct VmaDefragmentationContext_T;
10867 : VMA_CLASS_NO_COPY(VmaBlockVector)
10868 : public:
10869 : VmaBlockVector(
10870 : VmaAllocator hAllocator,
10871 : VmaPool hParentPool,
10872 : uint32_t memoryTypeIndex,
10873 : VkDeviceSize preferredBlockSize,
10874 : size_t minBlockCount,
10875 : size_t maxBlockCount,
10876 : VkDeviceSize bufferImageGranularity,
10877 : bool explicitBlockSize,
10878 : uint32_t algorithm,
10879 : float priority,
10880 : VkDeviceSize minAllocationAlignment,
10881 : void* pMemoryAllocateNext);
10882 : ~VmaBlockVector();
10883 :
10884 0 : VmaAllocator GetAllocator() const { return m_hAllocator; }
10885 : VmaPool GetParentPool() const { return m_hParentPool; }
10886 : bool IsCustomPool() const { return m_hParentPool != VMA_NULL; }
10887 0 : uint32_t GetMemoryTypeIndex() const { return m_MemoryTypeIndex; }
10888 0 : VkDeviceSize GetPreferredBlockSize() const { return m_PreferredBlockSize; }
10889 : VkDeviceSize GetBufferImageGranularity() const { return m_BufferImageGranularity; }
10890 0 : uint32_t GetAlgorithm() const { return m_Algorithm; }
10891 0 : bool HasExplicitBlockSize() const { return m_ExplicitBlockSize; }
10892 0 : float GetPriority() const { return m_Priority; }
10893 0 : const void* GetAllocationNextPtr() const { return m_pMemoryAllocateNext; }
10894 : // To be used only while the m_Mutex is locked. Used during defragmentation.
10895 0 : size_t GetBlockCount() const { return m_Blocks.size(); }
10896 : // To be used only while the m_Mutex is locked. Used during defragmentation.
10897 0 : VmaDeviceMemoryBlock* GetBlock(size_t index) const { return m_Blocks[index]; }
10898 0 : VMA_RW_MUTEX &GetMutex() { return m_Mutex; }
10899 :
10900 : VkResult CreateMinBlocks();
10901 : void AddStatistics(VmaStatistics& inoutStats);
10902 : void AddDetailedStatistics(VmaDetailedStatistics& inoutStats);
10903 : bool IsEmpty();
10904 : bool IsCorruptionDetectionEnabled() const;
10905 :
10906 : VkResult Allocate(
10907 : VkDeviceSize size,
10908 : VkDeviceSize alignment,
10909 : const VmaAllocationCreateInfo& createInfo,
10910 : VmaSuballocationType suballocType,
10911 : size_t allocationCount,
10912 : VmaAllocation* pAllocations);
10913 :
10914 : void Free(const VmaAllocation hAllocation);
10915 :
10916 : #if VMA_STATS_STRING_ENABLED
10917 : void PrintDetailedMap(class VmaJsonWriter& json);
10918 : #endif
10919 :
10920 : VkResult CheckCorruption();
10921 :
10922 : private:
10923 : const VmaAllocator m_hAllocator;
10924 : const VmaPool m_hParentPool;
10925 : const uint32_t m_MemoryTypeIndex;
10926 : const VkDeviceSize m_PreferredBlockSize;
10927 : const size_t m_MinBlockCount;
10928 : const size_t m_MaxBlockCount;
10929 : const VkDeviceSize m_BufferImageGranularity;
10930 : const bool m_ExplicitBlockSize;
10931 : const uint32_t m_Algorithm;
10932 : const float m_Priority;
10933 : const VkDeviceSize m_MinAllocationAlignment;
10934 :
10935 : void* const m_pMemoryAllocateNext;
10936 : VMA_RW_MUTEX m_Mutex;
10937 : // Incrementally sorted by sumFreeSize, ascending.
10938 : VmaVector<VmaDeviceMemoryBlock*, VmaStlAllocator<VmaDeviceMemoryBlock*>> m_Blocks;
10939 : uint32_t m_NextBlockId;
10940 : bool m_IncrementalSort = true;
10941 :
10942 0 : void SetIncrementalSort(bool val) { m_IncrementalSort = val; }
10943 :
10944 : VkDeviceSize CalcMaxBlockSi |
