vulkan-wsi-layer/util/custom_allocator.cpp
Normunds Rieksts af2af23333 Ensure allocations happen through custom allocators
Document instance_private_data and device_private_data.

Add additional utility containers (util::unordered_set,
util::unordered_map) that ensure that the storage containers
we use allow the use of the Vulkan allocation callbacks.
Additionally, ensure that these allocations don't throw in
case host runs out of memory but rather return the appropriate
Vulkan error code.
Also keep a copy the allocators so they can be used in other layer
functionality to facilitate following the Vulkan specification around
memory allocation.

Add additional utility util::optional that currently makes it easier
to handle errors in the containers described above.

Fix some small issues with the vkCreateInstance/vkCreateDevice
handling and ensure that vkDestroyDevice is called in the layer
handler.

Change-Id: Ic9d8ece405c82e743a2c016cc3dabf984cf77fc1
Signed-off-by: Normunds Rieksts <normunds.rieksts@arm.com>
2021-06-28 11:51:33 +01:00

81 lines
2.5 KiB
C++

/*
* Copyright (c) 2020-2021 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#include "custom_allocator.hpp"
extern "C" {
static void *default_allocation(void *, size_t size, size_t, VkSystemAllocationScope)
{
return malloc(size);
}
static void *default_reallocation(void *, void *pOriginal, size_t size, size_t, VkSystemAllocationScope)
{
return realloc(pOriginal, size);
}
static void default_free(void *, void *pMemory)
{
free(pMemory);
}
}
namespace util
{
const allocator& allocator::get_generic()
{
static allocator generic{ VK_SYSTEM_ALLOCATION_SCOPE_COMMAND, nullptr };
return generic;
}
allocator::allocator(const allocator &other, VkSystemAllocationScope new_scope, const VkAllocationCallbacks *callbacks)
: allocator{ new_scope, callbacks == nullptr ? other.get_original_callbacks() : callbacks }
{
}
/* If callbacks is already populated by vulkan then use those specified as default. */
allocator::allocator(VkSystemAllocationScope scope, const VkAllocationCallbacks *callbacks)
{
m_scope = scope;
if (callbacks != nullptr)
{
m_callbacks = *callbacks;
}
else
{
m_callbacks = {};
m_callbacks.pfnAllocation = default_allocation;
m_callbacks.pfnReallocation = default_reallocation;
m_callbacks.pfnFree = default_free;
}
}
const VkAllocationCallbacks *allocator::get_original_callbacks() const
{
return m_callbacks.pfnAllocation == default_allocation ? nullptr : &m_callbacks;
}
} /* namespace util */