common/almalloc.h

   1 #ifndef AL_MALLOC_H
   2 #define AL_MALLOC_H
   3
   4 #include <algorithm>
   5 #include <cstddef>
   6 #include <limits>
   7 #include <new>
   8 #include <type_traits>
   9 #include <utility>
  10 #include <variant>
  11
  12
  13 namespace gsl {
  14 template<typename T> using owner = T;
  15 }
  16
  17
  18 #define DISABLE_ALLOC                                                         \
  19     void *operator new(size_t) = delete;                                      \
  20     void *operator new[](size_t) = delete;                                    \
  21     void operator delete(void*) noexcept = delete;                            \
  22     void operator delete[](void*) noexcept = delete;
  23
  24
  25 enum FamCount : size_t { };
  26
  27 #define DEF_FAM_NEWDEL(T, FamMem)                                             \
  28     static constexpr size_t Sizeof(size_t count) noexcept                     \
  29     {                                                                         \
  30         static_assert(&Sizeof == &T::Sizeof,                                  \
  31             "Incorrect container type specified");                            \
  32         return std::max(decltype(FamMem)::Sizeof(count, offsetof(T, FamMem)), \
  33             sizeof(T));                                                       \
  34     }                                                                         \
  35                                                                               \
  36     gsl::owner<void*> operator new(size_t /*size*/, FamCount count)           \
  37     {                                                                         \
  38         const auto alignment = std::align_val_t{alignof(T)};                  \
  39         return ::operator new[](T::Sizeof(count), alignment);                 \
  40     }                                                                         \
  41     void operator delete(gsl::owner<void*> block, FamCount) noexcept          \
  42     { ::operator delete[](block, std::align_val_t{alignof(T)}); }             \
  43     void operator delete(gsl::owner<void*> block) noexcept                    \
  44     { ::operator delete[](block, std::align_val_t{alignof(T)}); }             \
  45     void *operator new[](size_t /*size*/) = delete;                           \
  46     void operator delete[](void* /*block*/) = delete;
  47
  48
  49 namespace al {
  50
  51 template<typename T, std::size_t AlignV=alignof(T)>
  52 struct allocator {
  53     static constexpr auto Alignment = std::max(AlignV, alignof(T));
  54     static constexpr auto AlignVal = std::align_val_t{Alignment};
  55
  56     using value_type = std::remove_cv_t<std::remove_reference_t<T>>;
  57     using reference = value_type&;
  58     using const_reference = const value_type&;
  59     using pointer = value_type*;
  60     using const_pointer = const value_type*;
  61     using size_type = std::size_t;
  62     using difference_type = std::ptrdiff_t;
  63     using is_always_equal = std::true_type;
  64
  65     template<typename U, std::enable_if_t<alignof(U) <= Alignment,bool> = true>
  66     struct rebind {
  67         using other = allocator<U,Alignment>;
  68     };
  69
  70     constexpr explicit allocator() noexcept = default;
  71     template<typename U, std::size_t N>
  72     constexpr explicit allocator(const allocator<U,N>&) noexcept
  73     { static_assert(Alignment == allocator<U,N>::Alignment); }
  74
  75     gsl::owner<T*> allocate(std::size_t n)
  76     {
  77         if(n > std::numeric_limits<std::size_t>::max()/sizeof(T)) throw std::bad_alloc();
  78         return static_cast<gsl::owner<T*>>(::operator new[](n*sizeof(T), AlignVal));
  79     }
  80     void deallocate(gsl::owner<T*> p, std::size_t) noexcept
  81     { ::operator delete[](gsl::owner<void*>{p}, AlignVal); }
  82 };
  83 template<typename T, std::size_t N, typename U, std::size_t M>
  84 constexpr bool operator==(const allocator<T,N>&, const allocator<U,M>&) noexcept
  85 { return allocator<T,N>::Alignment == allocator<U,M>::Alignment; }
  86 template<typename T, std::size_t N, typename U, std::size_t M>
  87 constexpr bool operator!=(const allocator<T,N>&, const allocator<U,M>&) noexcept
  88 { return allocator<T,N>::Alignment != allocator<U,M>::Alignment; }
  89
  90
  91 template<typename T>
  92 constexpr T *to_address(T *p) noexcept
  93 {
  94     static_assert(!std::is_function<T>::value, "Can't be a function type");
  95     return p;
  96 }
  97
  98 template<typename T>
  99 constexpr auto to_address(const T &p) noexcept
 100 {
 101     return ::al::to_address(p.operator->());
 102 }
 103
 104
 105 template<typename T, typename ...Args>
 106 constexpr T* construct_at(T *ptr, Args&& ...args)
 107     noexcept(std::is_nothrow_constructible_v<T, Args...>)
 108 {
 109     /* NOLINTBEGIN(cppcoreguidelines-owning-memory) construct_at doesn't
 110      * necessarily handle the address from an owner, while placement new
 111      * expects to.
 112      */
 113     return ::new(static_cast<void*>(ptr)) T{std::forward<Args>(args)...};
 114     /* NOLINTEND(cppcoreguidelines-owning-memory) */
 115 }
 116
 117
 118 template<typename SP, typename PT, typename ...Args>
 119 class out_ptr_t {
 120     static_assert(!std::is_same_v<PT,void*>);
 121
 122     SP &mRes;
 123     std::variant<PT,void*> mPtr{};
 124
 125 public:
 126     out_ptr_t(SP &res) : mRes{res} { }
 127     ~out_ptr_t()
 128     {
 129         auto set_res = [this](auto &ptr)
 130         { mRes.reset(static_cast<PT>(ptr)); };
 131         std::visit(set_res, mPtr);
 132     }
 133     out_ptr_t(const out_ptr_t&) = delete;
 134     out_ptr_t& operator=(const out_ptr_t&) = delete;
 135
 136     operator PT*() noexcept
 137     { return &std::get<PT>(mPtr); }
 138
 139     operator void**() noexcept
 140     { return &mPtr.template emplace<void*>(); }
 141 };
 142
 143 template<typename T=void, typename SP, typename ...Args>
 144 auto out_ptr(SP &res)
 145 {
 146     using ptype = typename SP::element_type*;
 147     return out_ptr_t<SP,ptype>{res};
 148 }
 149
 150 } // namespace al
 151
 152 #endif /* AL_MALLOC_H */