memory.hpp

// Copyright Take Vos 2019-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "math.hpp"
#include "../macros.hpp"
#include "concepts.hpp"
#include "exception.hpp"
#include "terminate.hpp"
#include "cast.hpp"
#include <cstring>
#include <concepts>
#include <memory>
#include <vector>
#include <map>
#include <unordered_map>
#include <type_traits>
#include <bit>
#include <string.h>
 
hi_export_module(hikogui.utility.memory);
 
hi_warning_push();
// C26474: Don't cast between pointer types when the conversion could be implicit (type.1).
// False positive, template with potential two different pointer types.
hi_warning_ignore_msvc(26474);
// C26472: Don't use a static_cast for arithmetic conversions. Use brace initializations... (type.1).
// Can't include cast.hpp for highlevel casts.
hi_warning_ignore_msvc(26472);
 
hi_export namespace hi::inline v1 {

template<template<typename...> typename T, typename... Args>
[[nodiscard]] auto make_unique_ctad(Args &&...args)
{
    using deduced_type = decltype(T{std::forward<Args>(args)...});
    return std::make_unique<deduced_type>(std::forward<Args>(args)...);
}

template<template<typename...> typename T, typename... Args>
[[nodiscard]] auto make_shared_ctad(Args &&...args)
{
    using deduced_type = decltype(T{std::forward<Args>(args)...});
    return std::make_shared<deduced_type>(std::forward<Args>(args)...);
}
 
[[nodiscard]] bool equal_ptr(auto *p1, auto *p2) noexcept
{
    return static_cast<void *>(p1) == static_cast<void *>(p2);
}
 
template<typename T, typename U>
void memswap(T& dst, U& src)
{
    static_assert(sizeof(T) == sizeof(U), "memswap requires both objects of equal size");
    std::byte tmp[sizeof(T)];
    memcpy(tmp, &src, sizeof(T));
    memcpy(&src, &dst, sizeof(U));
    memcpy(&dst, tmp, sizeof(T));
}

template<typename InputIt, typename T>
T *placement_copy(InputIt src, T *dst)
{
    hi_axiom_not_null(dst);
    return new (dst) T(*src);
}

template<typename InputIt, typename T>
void placement_copy(InputIt src_first, InputIt src_last, T *dst_first)
{
    hi_axiom(src_first != dst_first);
    hi_axiom(src_last >= src_first);
 
    auto src = src_first;
    auto dst = dst_first;
    while (src != src_last) {
        placement_copy(src++, dst++);
    }
}

template<typename T>
T *placement_move(T *src, T *dst)
{
    hi_axiom_not_null(src);
    hi_axiom_not_null(dst);
 
    auto dst_ = new (dst) T(std::move(*src));
    std::destroy_at(src);
    return dst_;
}

template<typename T>
void placement_move_within_array(T *src_first, T *src_last, T *dst_first)
{
    hi_axiom(src_last >= src_first);
 
    if (src_first < dst_first) {
        auto dst_last = dst_first + (src_last - src_first);
 
        auto src = src_last;
        auto dst = dst_last;
        while (src != src_first) {
            placement_move(--src, --dst);
        }
 
    } else if (src_first > dst_first) {
        auto src = src_first;
        auto dst = dst_first;
        while (src != src_last) {
            placement_move(src++, dst++);
        }
 
    } else {
        // When src_first and dst_first are equal then no movement is necessary.
        ;
    }
}

template<typename T>
void placement_move(T *src, T *src_last, T *dst)
{
    hi_axiom(src_last >= src);
 
    while (src != src_last) {
        placement_move(src++, dst++);
    }
}

template<typename It, typename... Args>
void construct(It first, It last, Args const&...args)
{
    for (auto it = first; it != last; ++it) {
        std::construct_at(std::addressof(*it), args...);
    }
}

template<typename T>
constexpr bool is_aligned(T *p)
{
    return (reinterpret_cast<ptrdiff_t>(p) % std::alignment_of<T>::value) == 0;
}
 
template<typename T>
constexpr T *ceil(T *ptr, std::size_t alignment) noexcept
{
    auto const aligned_byte_offset = ceil(reinterpret_cast<uintptr_t>(ptr), wide_cast<uintptr_t>(alignment));
    return reinterpret_cast<T *>(aligned_byte_offset);
}
 
template<typename T>
constexpr T *floor(T *ptr, std::size_t alignment) noexcept
{
    auto const aligned_byte_offset = floor(reinterpret_cast<uintptr_t>(ptr), wide_cast<uintptr_t>(alignment));
    return reinterpret_cast<T *>(aligned_byte_offset);
}

inline void *advance_bytes(void *ptr, std::ptrdiff_t distance) noexcept
{
    hi_axiom_not_null(ptr);
    return static_cast<char *>(ptr) + distance;
}

inline void const *advance_bytes(void const *ptr, std::ptrdiff_t distance) noexcept
{
    hi_axiom_not_null(ptr);
    return static_cast<char const *>(ptr) + distance;
}
 
template<typename T>
inline void cleanupWeakPointers(std::vector<std::weak_ptr<T>>& v) noexcept
{
    auto i = v.begin();
    while (i != v.end()) {
        if (i->expired()) {
            i = v.erase(i);
        } else {
            i++;
        }
    }
}
 
template<typename K, typename T>
inline void cleanupWeakPointers(std::unordered_map<K, std::weak_ptr<T>>& v) noexcept
{
    auto i = v.begin();
    while (i != v.end()) {
        if (i->second.expired()) {
            i = v.erase(i);
        } else {
            i++;
        }
    }
}
 
template<typename K, typename T>
inline void cleanupWeakPointers(std::unordered_map<K, std::vector<std::weak_ptr<T>>>& v) noexcept
{
    auto i = v.begin();
    while (i != v.end()) {
        cleanupWeakPointers(i->second);
        if (i->second.size() == 0) {
            i = v.erase(i);
        } else {
            i++;
        }
    }
}
 
template<typename Value, typename Map, typename Key, typename... Args>
inline std::shared_ptr<Value> try_make_shared(Map& map, Key key, Args... args)
{
    std::shared_ptr<Value> value;
 
    auto const i = map.find(key);
    if (i == map.end()) {
        value = std::make_shared<Value>(std::forward<Args>(args)...);
        map.insert_or_assign(key, value);
    } else {
        value = i->second;
    }
    return value;
}

template<numeric T, byte_like B>
[[nodiscard]] constexpr T unaligned_load(B const *src) noexcept
{
    auto r = T{};
 
    if (not std::is_constant_evaluated()) {
        // MSVC, clang and gcc are able to optimize this fully on x86-64.
        std::memcpy(&r, src, sizeof(T));
        return r;
    }
 
    if constexpr (std::endian::native == std::endian::little) {
        for (auto i = sizeof(T); i != 0; --i) {
            if constexpr (sizeof(r) > 1) {
                r <<= 8;
            }
            r |= static_cast<uint8_t>(src[i - 1]);
        }
    } else {
        for (auto i = 0; i != sizeof(T); ++i) {
            if constexpr (sizeof(r) > 1) {
                r <<= 8;
            }
            r |= static_cast<uint8_t>(src[i]);
        }
    }
    return r;
}
 
template<numeric T>
[[nodiscard]] inline T unaligned_load(void const *src) noexcept
{
    return unaligned_load<T>(static_cast<std::byte const *>(src));
}
 
template<numeric T, byte_like B>
constexpr void unaligned_store(T src, B *dst) noexcept
{
    using unsigned_type = std::make_unsigned_t<T>;
 
    auto const src_ = static_cast<unsigned_type>(src);
 
    if (not std::is_constant_evaluated()) {
        std::memcpy(dst, &src, sizeof(T));
        return;
    }
 
    if constexpr (std::endian::native == std::endian::little) {
        for (auto i = 0; i != sizeof(T); ++i) {
            dst[i] = static_cast<B>(src_);
            src_ >>= 8;
        }
    } else {
        for (auto i = sizeof(T); i != 0; --i) {
            dst[i - 1] = static_cast<B>(src_);
            src_ >>= 8;
        }
    }
}
 
template<numeric T>
void unaligned_store(T src, void *dst) noexcept
{
    return unaligned_store(src, reinterpret_cast<std::byte *>(dst));
}
 
template<std::integral T>
hi_force_inline constexpr void store_or(T src, uint8_t *dst) noexcept
{
    hi_axiom_not_null(dst);
 
    using unsigned_type = std::make_unsigned_t<T>;
 
    auto src_ = truncate<unsigned_type>(src);
 
    if (not std::is_constant_evaluated()) {
        decltype(src_) tmp;
        std::memcpy(&tmp, dst, sizeof(T));
        tmp |= src_;
        std::memcpy(dst, &tmp, sizeof(T));
    }
 
    if constexpr (std::endian::native == std::endian::little) {
        for (auto i = 0; i != sizeof(T); ++i) {
            dst[i] |= truncate<uint8_t>(src_);
            src_ >>= 8;
        }
    } else {
        for (auto i = sizeof(T); i != 0; --i) {
            dst[i] |= truncate<uint8_t>(src_);
            src_ >>= 8;
        }
    }
}
 
} // namespace hi::inline v1
 
hi_warning_pop();