#pragma once //////////////////////////////////////////////////////////////////////////////// // The MIT License (MIT) // // Copyright (c) 2018 Nicholas Frechette & Animation Compression Library contributors // // 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 "acl/core/error.h" #include "acl/core/memory_utils.h" #include "acl/core/impl/compiler_utils.h" #include #include #include ACL_IMPL_FILE_PRAGMA_PUSH namespace acl { //////////////////////////////////////////////////////////////////////////////// // A simple memory allocator interface. // // In order to integrate this library into your own code base, you will // need to provide some functions with an allocator instance that derives // from this interface. // // See ansi_allocator.h for an implementation that uses the system malloc/free. //////////////////////////////////////////////////////////////////////////////// class iallocator { public: static constexpr size_t k_default_alignment = 16; iallocator() {} virtual ~iallocator() {} iallocator(const iallocator&) = delete; iallocator& operator=(const iallocator&) = delete; //////////////////////////////////////////////////////////////////////////////// // Allocates memory with the specified size and alignment. // // size: Size in bytes to allocate. // alignment: Alignment to allocate the memory with. virtual void* allocate(size_t size, size_t alignment = k_default_alignment) = 0; //////////////////////////////////////////////////////////////////////////////// // Deallocates previously allocated memory and releases it. // // ptr: A pointer to memory previously allocated or nullptr. // size: Size in bytes of the allocation. This will match the original size requested through 'allocate'. virtual void deallocate(void* ptr, size_t size) = 0; }; ////////////////////////////////////////////////////////////////////////// template allocated_type* allocate_type(iallocator& allocator, args&&... arguments) { allocated_type* ptr = reinterpret_cast(allocator.allocate(sizeof(allocated_type), alignof(allocated_type))); if (acl_impl::is_trivially_default_constructible::value) return ptr; return new(ptr) allocated_type(std::forward(arguments)...); } template allocated_type* allocate_type_aligned(iallocator& allocator, size_t alignment, args&&... arguments) { ACL_ASSERT(is_alignment_valid(alignment), "Invalid alignment: %u. Expected a power of two at least equal to %u", alignment, alignof(allocated_type)); allocated_type* ptr = reinterpret_cast(allocator.allocate(sizeof(allocated_type), alignment)); if (acl_impl::is_trivially_default_constructible::value) return ptr; return new(ptr) allocated_type(std::forward(arguments)...); } template void deallocate_type(iallocator& allocator, allocated_type* ptr) { if (ptr == nullptr) return; if (!std::is_trivially_destructible::value) ptr->~allocated_type(); allocator.deallocate(ptr, sizeof(allocated_type)); } template allocated_type* allocate_type_array(iallocator& allocator, size_t num_elements, args&&... arguments) { allocated_type* ptr = reinterpret_cast(allocator.allocate(sizeof(allocated_type) * num_elements, alignof(allocated_type))); if (acl_impl::is_trivially_default_constructible::value) return ptr; for (size_t element_index = 0; element_index < num_elements; ++element_index) new(&ptr[element_index]) allocated_type(std::forward(arguments)...); return ptr; } template allocated_type* allocate_type_array_aligned(iallocator& allocator, size_t num_elements, size_t alignment, args&&... arguments) { ACL_ASSERT(is_alignment_valid(alignment), "Invalid alignment: %zu. Expected a power of two at least equal to %zu", alignment, alignof(allocated_type)); allocated_type* ptr = reinterpret_cast(allocator.allocate(sizeof(allocated_type) * num_elements, alignment)); if (acl_impl::is_trivially_default_constructible::value) return ptr; for (size_t element_index = 0; element_index < num_elements; ++element_index) new(&ptr[element_index]) allocated_type(std::forward(arguments)...); return ptr; } template void deallocate_type_array(iallocator& allocator, allocated_type* elements, size_t num_elements) { if (elements == nullptr) return; if (!std::is_trivially_destructible::value) { for (size_t element_index = 0; element_index < num_elements; ++element_index) elements[element_index].~allocated_type(); } allocator.deallocate(elements, sizeof(allocated_type) * num_elements); } } ACL_IMPL_FILE_PRAGMA_POP