af8941e6a8
Vulkan has a pluggable memory allocation feature, which allows internal driver allocations to be done by the client application provided allocator. Vulkan uses this for more client application allocations done inside the driver, but can also do it for more internal oriented allocations. VK_ALLOCATION_CALLBACKS initializes allocation callbacks for host allocations. The macro creates a local static variable with the name vk_allocation_callbacks that can be passed to vulkan API functions that expect const VkAllocationCallbacks *pAllocator. When WITH_VULKAN_GUARDEDALLOC=Off the memory allocation implemented in the vulkan device driver is used for both internal and application oriented memory operations. For now this would help during the development of Vulkan backend to detect hidden memory leaks that are hidden inside the driver part of the stack. In a later stage we need to measure the overhead and if this should become the default behavior. Pull Request #104434
65 lines
2.2 KiB
C++
65 lines
2.2 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2023 Blender Foundation. All rights reserved. */
|
|
|
|
/** \file
|
|
* \ingroup gpu
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef __APPLE__
|
|
# include <MoltenVK/vk_mvk_moltenvk.h>
|
|
#else
|
|
# include <vulkan/vulkan.h>
|
|
#endif
|
|
|
|
namespace blender::gpu {
|
|
|
|
/**
|
|
* `VK_ALLOCATION_CALLBACKS` initializes allocation callbacks for host allocations.
|
|
* The macro creates a local static variable with the name `vk_allocation_callbacks`
|
|
* that can be passed to vulkan API functions that expect
|
|
* `const VkAllocationCallbacks *pAllocator`.
|
|
*
|
|
* When Blender is compiled with `WITH_VULKAN_GUARDEDALLOC` this will use
|
|
* `MEM_guardedalloc` for host allocations that the driver does on behalf
|
|
* of blender. More internal allocations are still being allocated via the
|
|
* implemention inside the vulkan device driver.
|
|
*
|
|
* When `WITH_VULKAN_GUARDEDALLOC=Off` the memory allocation implemented
|
|
* in the vulkan device driver is used for both internal and application
|
|
* focussed memory operations.
|
|
*/
|
|
|
|
#ifdef WITH_VULKAN_GUARDEDALLOC
|
|
void *vk_memory_allocation(void *user_data,
|
|
size_t size,
|
|
size_t alignment,
|
|
VkSystemAllocationScope scope);
|
|
void *vk_memory_reallocation(
|
|
void *user_data, void *original, size_t size, size_t alignment, VkSystemAllocationScope scope);
|
|
void vk_memory_free(void *user_data, void *memory);
|
|
|
|
constexpr VkAllocationCallbacks vk_allocation_callbacks_init(const char *name)
|
|
{
|
|
VkAllocationCallbacks callbacks = {};
|
|
callbacks.pUserData = const_cast<char *>(name);
|
|
callbacks.pfnAllocation = vk_memory_allocation;
|
|
callbacks.pfnReallocation = vk_memory_reallocation;
|
|
callbacks.pfnFree = vk_memory_free;
|
|
callbacks.pfnInternalAllocation = nullptr;
|
|
callbacks.pfnInternalFree = nullptr;
|
|
return callbacks;
|
|
}
|
|
|
|
# define VK_ALLOCATION_CALLBACKS \
|
|
static constexpr const VkAllocationCallbacks vk_allocation_callbacks_ = \
|
|
vk_allocation_callbacks_init(__func__); \
|
|
static constexpr const VkAllocationCallbacks *vk_allocation_callbacks = &vk_allocation_callbacks_;
|
|
#else
|
|
# define VK_ALLOCATION_CALLBACKS \
|
|
static constexpr const VkAllocationCallbacks *vk_allocation_callbacks = nullptr;
|
|
#endif
|
|
|
|
} // namespace blender::gpu
|