/* * libfud * Copyright 2024 Dominick Allen * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef FUD_ALLOCATOR_HPP #define FUD_ALLOCATOR_HPP #include "fud_result.hpp" #include "fud_status.hpp" #include namespace fud { /** \brief The default allocation function for globalFudAllocator. */ extern std::byte* fudAlloc(size_t size); /** \brief The default deallocation function for globalFudAllocator. */ extern void fudFree(std::byte* ptr); // NOLINTBEGIN(cppcoreguidelines-special-member-functions) class alignas(std::max_align_t) Allocator { public: virtual ~Allocator() = default; virtual Result allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) = 0; virtual void deallocate(std::byte* pointer, size_t bytes) = 0; [[nodiscard]] virtual bool isEqual(const Allocator& rhs) const = 0; }; constexpr bool operator==(const Allocator& lhs, const Allocator& rhs) { return &lhs == &rhs; } class FudAllocator : public Allocator { public: ~FudAllocator() override = default; Result allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) override; void deallocate(std::byte* pointer, size_t bytes) override; [[nodiscard]] bool isEqual(const Allocator& rhs) const override; }; // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) extern FudAllocator globalFudAllocator; class NullAllocator : public Allocator { public: ~NullAllocator() override = default; Result allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) override; void deallocate(std::byte* pointer, size_t bytes) override; [[nodiscard]] bool isEqual(const Allocator& rhs) const override; }; // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) extern NullAllocator globalNullAllocator; template class SimpleStackAllocator final : public Allocator { private: // NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays) std::byte m_memory[Size]{}; size_t m_allocated{0}; public: ~SimpleStackAllocator() final = default; Result allocate(size_t bytes, size_t alignment = alignof(std::max_align_t)) final { using RetType = Result; static_cast(alignment); if (bytes > Size - m_allocated) { return RetType::error(FudStatus::AllocFailure); } auto* data = m_memory + m_allocated; m_allocated += bytes; return RetType::okay(data); } void deallocate(std::byte* pointer, size_t bytes) final { if (pointer + bytes != m_memory + m_allocated) { m_allocated = Size; return; } m_allocated -= bytes; } [[nodiscard]] bool isEqual(const Allocator& rhs) const final { return &rhs == this; } }; } // namespace fud // NOLINTEND(cppcoreguidelines-special-member-functions) #endif