Files
snmalloc/src/pal/pal_concept.h
Nathaniel Filardo cfa996692f Correct PAL Concept
The test for NoAllocation/AlignedAllocation/neither was broken and this was
undetected until the sandbox demo came into being with its NoAllocation PAL
instance.  (Sadly, this remained undetected for so long because we can't
routinely build with C++20 because std::atomic_t<>'s initialization rules
changed in ways that make us require oodles and oodles of RAM at compile time.
This patch has been validated with -j1 on a machine with lots of RAM.)

Separately, it's possible that we end up here without `using namespace std`,
which seems like overkill.  So just use `std::size_t` ourselves within the PAL
Concept definition.
2021-04-07 18:06:18 +01:00

104 lines
3.2 KiB
C++

#pragma once
#ifdef __cpp_concepts
# include "../ds/concept.h"
# include "pal_consts.h"
# include <utility>
namespace snmalloc
{
/**
* PALs must advertize the bit vector of their supported features and the
* platform's page size. This concept enforces that these are indeed
* constants that fit in the desired types. (This is subtly different from
* saying that they are the required types; C++ may handle constants without
* much regard for their claimed type.)
*/
template<typename PAL>
concept ConceptPAL_static_members = requires()
{
typename std::integral_constant<uint64_t, PAL::pal_features>;
typename std::integral_constant<std::size_t, PAL::page_size>;
};
/**
* PALs expose an error reporting function which takes a const C string.
*/
template<typename PAL>
concept ConceptPAL_error = requires(const char* const str)
{
{ PAL::error(str) } -> ConceptSame<void>;
};
/**
* PALs expose a basic library of memory operations.
*/
template<typename PAL>
concept ConceptPAL_memops = requires(void* vp, std::size_t sz)
{
{ PAL::notify_not_using(vp, sz) } noexcept -> ConceptSame<void>;
{ PAL::template notify_using<NoZero>(vp, sz) } noexcept
-> ConceptSame<void>;
{ PAL::template notify_using<YesZero>(vp, sz) } noexcept
-> ConceptSame<void>;
{ PAL::template zero<false>(vp, sz) } noexcept -> ConceptSame<void>;
{ PAL::template zero<true>(vp, sz) } noexcept -> ConceptSame<void>;
};
/**
* Absent any feature flags, the PAL must support a crude primitive allocator
*/
template<typename PAL>
concept ConceptPAL_reserve_at_least =
requires(PAL p, void* vp, std::size_t sz)
{
{ PAL::reserve_at_least(sz) } noexcept
-> ConceptSame<std::pair<void*, std::size_t>>;
};
/**
* Some PALs expose a richer allocator which understands aligned allocations
*/
template<typename PAL>
concept ConceptPAL_reserve_aligned = requires(std::size_t sz)
{
{ PAL::template reserve_aligned<true>(sz) } noexcept -> ConceptSame<void*>;
{ PAL::template reserve_aligned<false>(sz) } noexcept
-> ConceptSame<void*>;
};
/**
* Some PALs can provide memory pressure callbacks.
*/
template<typename PAL>
concept ConceptPAL_mem_low_notify = requires(PalNotificationObject* pno)
{
{ PAL::expensive_low_memory_check() } -> ConceptSame<bool>;
{ PAL::register_for_low_memory_callback(pno) } -> ConceptSame<void>;
};
/**
* PALs ascribe to the conjunction of several concepts. These are broken
* out by the shape of the requires() quantifiers required and by any
* requisite claimed pal_features. PALs not claiming particular features
* are, naturally, not bound by the corresponding concept.
*/
template<typename PAL>
concept ConceptPAL =
ConceptPAL_static_members<PAL> &&
ConceptPAL_error<PAL> &&
ConceptPAL_memops<PAL> &&
(!pal_supports<LowMemoryNotification, PAL> ||
ConceptPAL_mem_low_notify<PAL>) &&
(pal_supports<NoAllocation, PAL> ||
(pal_supports<AlignedAllocation, PAL> &&
ConceptPAL_reserve_aligned<PAL>) ||
(!pal_supports<AlignedAllocation, PAL> &&
ConceptPAL_reserve_at_least<PAL>));
} // namespace snmalloc
#endif