rpcs3/rpcs3/Emu/IdManager.h
2023-10-05 05:07:46 +03:00

842 lines
21 KiB
C++

#pragma once
#include "util/types.hpp"
#include "Utilities/mutex.h"
#include <memory>
#include <vector>
#include <map>
#include <typeinfo>
#include "util/serialization.hpp"
#include "util/fixed_typemap.hpp"
extern stx::manual_typemap<void, 0x20'00000, 128> g_fixed_typemap;
constexpr auto* g_fxo = &g_fixed_typemap;
enum class thread_state : u32;
// Helper namespace
namespace id_manager
{
// Common global mutex
extern shared_mutex g_mutex;
template <typename T>
constexpr std::pair<u32, u32> get_invl_range()
{
return {0, 0};
}
template <typename T> requires requires () { T::id_invl_range; }
constexpr std::pair<u32, u32> get_invl_range()
{
return T::id_invl_range;
}
template <typename T>
consteval bool get_force_lowest_id()
{
return false;
}
template <typename T> requires requires () { bool{T::id_lowest}; }
consteval bool get_force_lowest_id()
{
return T::id_lowest;
}
template <typename T>
concept IdmCompatible = requires () { +T::id_base, +T::id_step, +T::id_count; };
template <typename T>
concept IdmBaseCompatible = (std::is_final_v<T> ? IdmCompatible<T> : !!(requires () { +T::id_step, +T::id_count; }));
template <typename T>
concept IdmSavable = IdmBaseCompatible<T> && T::savestate_init_pos != 0 && (requires () { std::declval<T>().save(std::declval<stx::exact_t<utils::serial&>>()); });
// Last allocated ID for constructors
extern thread_local u32 g_id;
// ID traits
template <typename T>
struct id_traits
{
static_assert(IdmCompatible<T>, "ID object must specify: id_base, id_step, id_count");
static constexpr u32 base = T::id_base; // First ID (N = 0)
static constexpr u32 step = T::id_step; // Any ID: N * id_setp + id_base
static constexpr u32 count = T::id_count; // Limit: N < id_count
static constexpr u32 invalid = -+!base; // Invalid ID sample
static constexpr std::pair<u32, u32> invl_range = get_invl_range<T>();
static constexpr bool uses_lowest_id = get_force_lowest_id<T>();
static_assert(u32{count} && u32{step} && u64{step} * (count - 1) + base < u32{umax} + u64{base != 0 ? 1 : 0}, "ID traits: invalid object range");
// TODO: Add more conditions
static_assert(!invl_range.second || (u64{invl_range.second} + invl_range.first <= 32 /*....*/ ));
};
static constexpr u32 get_index(u32 id, u32 base, u32 step, u32 count, std::pair<u32, u32> invl_range)
{
u32 mask_out = ((1u << invl_range.second) - 1) << invl_range.first;
// Note: if id is lower than base, diff / step will be higher than count
u32 diff = (id & ~mask_out) - base;
if (diff % step)
{
// id is invalid, return invalid index
return count;
}
// Get actual index
return diff / step;
}
// ID traits
template <typename T, typename = void>
struct id_traits_load_func
{
static constexpr std::shared_ptr<void>(*load)(utils::serial&) = [](utils::serial& ar) -> std::shared_ptr<void> { return std::make_shared<T>(stx::exact_t<utils::serial&>(ar)); };
};
template <typename T>
struct id_traits_load_func<T, std::void_t<decltype(&T::load)>>
{
static constexpr std::shared_ptr<void>(*load)(utils::serial&) = [](utils::serial& ar) -> std::shared_ptr<void> { return T::load(stx::exact_t<utils::serial&>(ar)); };
};
template <typename T, typename = void>
struct id_traits_savable_func
{
static constexpr bool(*savable)(void*) = [](void*) -> bool { return true; };
};
template <typename T>
struct id_traits_savable_func<T, std::void_t<decltype(&T::savable)>>
{
static constexpr bool(*savable)(void* ptr) = [](void* ptr) -> bool { return static_cast<const T*>(ptr)->savable(); };
};
struct dummy_construct
{
dummy_construct() {}
dummy_construct(utils::serial&){}
void save(utils::serial&) {}
static constexpr u32 id_base = 1, id_step = 1, id_count = 1;
static constexpr double savestate_init_pos = 0;
};
struct typeinfo;
// Use a vector instead of map to reduce header dependencies in this commonly used header
std::vector<std::pair<u128, typeinfo>>& get_typeinfo_map();
struct typeinfo
{
public:
std::shared_ptr<void>(*load)(utils::serial&);
void(*save)(utils::serial&, void*);
bool(*savable)(void* ptr);
u32 base;
u32 step;
u32 count;
bool uses_lowest_id;
std::pair<u32, u32> invl_range;
// Get type index
template <typename T>
static inline u32 get_index()
{
return stx::typeindex<id_manager::typeinfo, T>();
}
// Unique type ID within the same container: we use id_base if nothing else was specified
template <typename T>
static consteval u32 get_type()
{
return T::id_base;
}
// Specified type ID for containers which their types may be sharing an overlapping IDs range
template <typename T> requires requires () { u32{T::id_type}; }
static consteval u32 get_type()
{
return T::id_type;
}
template <typename T>
static typeinfo make_typeinfo()
{
typeinfo info{};
using C = std::conditional_t<IdmCompatible<T> && IdmSavable<T>, T, dummy_construct>;
using Type = std::conditional_t<IdmCompatible<T>, T, dummy_construct>;
if constexpr (std::is_same_v<C, T>)
{
info =
{
+id_traits_load_func<C>::load,
+[](utils::serial& ar, void* obj) { static_cast<C*>(obj)->save(ar); },
+id_traits_savable_func<C>::savable,
id_traits<C>::base, id_traits<C>::step, id_traits<C>::count, id_traits<C>::uses_lowest_id, id_traits<C>::invl_range,
};
const u128 key = u128{get_type<C>()} << 64 | std::bit_cast<u64>(C::savestate_init_pos);
for (const auto& tinfo : get_typeinfo_map())
{
if (!(tinfo.first ^ key))
{
ensure(!std::memcmp(&info, &tinfo.second, sizeof(info)));
return info;
}
}
// id_base must be unique within all the objects with the same initialization posistion by definition of id_map with multiple types
get_typeinfo_map().emplace_back(key, info);
}
else
{
info =
{
nullptr,
nullptr,
nullptr,
id_traits<Type>::base, id_traits<Type>::step, id_traits<Type>::count, id_traits<Type>::uses_lowest_id, id_traits<Type>::invl_range,
};
}
return info;
}
};
// ID value with additional type stored
class id_key
{
u32 m_value; // ID value
u32 m_base; // ID base (must be unique for each type in the same container)
public:
id_key() = default;
id_key(u32 value, u32 type)
: m_value(value)
, m_base(type)
{
}
u32 value() const
{
return m_value;
}
u32 type() const
{
return m_base;
}
operator u32() const
{
return m_value;
}
};
template <typename T>
struct id_map
{
static_assert(IdmBaseCompatible<T>, "Please specify IDM compatible type.");
std::vector<std::pair<id_key, std::shared_ptr<void>>> vec{}, private_copy{};
shared_mutex mutex{}; // TODO: Use this instead of global mutex
id_map() noexcept
{
// Preallocate memory
vec.reserve(T::id_count);
}
// Order it directly before the source type's position
static constexpr double savestate_init_pos_original = T::savestate_init_pos;
static constexpr double savestate_init_pos = std::bit_cast<double>(std::bit_cast<u64>(savestate_init_pos_original) - 1);
id_map(utils::serial& ar) noexcept requires IdmSavable<T>
{
vec.resize(T::id_count);
u32 i = ar.operator u32();
ensure(i <= T::id_count);
while (--i != umax)
{
// ID, type hash
const u32 id = ar;
const u128 type_init_pos = u128{u32{ar}} << 64 | std::bit_cast<u64>(T::savestate_init_pos);
const typeinfo* info = nullptr;
// Search load functions for the one of this type (see make_typeinfo() for explenation about key composition reasoning)
for (const auto& typeinfo : get_typeinfo_map())
{
if (!(typeinfo.first ^ type_init_pos))
{
info = std::addressof(typeinfo.second);
}
}
ensure(info);
// Construct each object from information collected
// Simulate construction semantics (idm::last_id() value)
g_id = id;
auto& obj = vec[get_index(id, info->base, info->step, info->count, info->invl_range)];
ensure(!obj.second);
obj.first = id_key(id, static_cast<u32>(static_cast<u64>(type_init_pos >> 64)));
obj.second = info->load(ar);
}
}
void save(utils::serial& ar) requires IdmSavable<T>
{
u32 obj_count = 0;
usz obj_count_offs = ar.data.size();
// To be patched at the end of the function
ar(obj_count);
for (const auto& p : vec)
{
if (!p.second) continue;
const u128 type_init_pos = u128{p.first.type()} << 64 | std::bit_cast<u64>(T::savestate_init_pos);
const typeinfo* info = nullptr;
// Search load functions for the one of this type (see make_typeinfo() for explenation about key composition reasoning)
for (const auto& typeinfo : get_typeinfo_map())
{
if (!(typeinfo.first ^ type_init_pos))
{
ensure(!std::exchange(info, std::addressof(typeinfo.second)));
}
}
// Save each object with needed information
if (info && info->savable(p.second.get()))
{
ar(p.first.value(), p.first.type());
info->save(ar, p.second.get());
obj_count++;
}
}
// Patch object count
std::memcpy(ar.data.data() + obj_count_offs, &obj_count, sizeof(obj_count));
}
id_map& operator=(thread_state state) noexcept requires (std::is_assignable_v<T&, thread_state>)
{
if (private_copy.empty())
{
reader_lock lock(g_mutex);
// Save all entries
private_copy = vec;
}
// Signal or join threads
for (const auto& [key, ptr] : private_copy)
{
if (ptr)
{
*static_cast<T*>(ptr.get()) = state;
}
}
return *this;
}
};
}
// Object manager for emulated process. Multiple objects of specified arbitrary type are given unique IDs.
class idm
{
template <typename T>
static constexpr u32 get_index(u32 id)
{
using traits = id_manager::id_traits<T>;
return id_manager::get_index(id, traits::base, traits::step, traits::count, traits::invl_range);
}
// Helper
template <typename F>
struct function_traits;
template <typename F, typename R, typename A1, typename A2>
struct function_traits<R (F::*)(A1, A2&) const>
{
using object_type = A2;
using result_type = R;
};
template <typename F, typename R, typename A1, typename A2>
struct function_traits<R (F::*)(A1, A2&)>
{
using object_type = A2;
using result_type = R;
};
// Helper type: pointer + return value propagated
template <typename T, typename RT>
struct return_pair
{
std::shared_ptr<T> ptr;
RT ret;
explicit operator bool() const
{
return ptr.operator bool();
}
T& operator*() const
{
return *ptr;
}
T* operator->() const
{
return ptr.get();
}
};
// Unsafe specialization (not refcounted)
template <typename T, typename RT>
struct return_pair<T*, RT>
{
T* ptr;
RT ret;
explicit operator bool() const
{
return ptr != nullptr;
}
T& operator*() const
{
return *ptr;
}
T* operator->() const
{
return ptr;
}
};
using map_data = std::pair<id_manager::id_key, std::shared_ptr<void>>;
// Prepare new ID (returns nullptr if out of resources)
static map_data* allocate_id(std::vector<map_data>& vec, u32 type_id, u32 dst_id, u32 base, u32 step, u32 count, bool uses_lowest_id, std::pair<u32, u32> invl_range);
// Get object by internal index if exists (additionally check type if types are not equal)
template <typename T, typename Type>
static map_data* find_index(u32 index, u32 id)
{
static_assert(PtrSame<T, Type>, "Invalid ID type combination");
auto& vec = g_fxo->get<id_manager::id_map<T>>().vec;
if (index >= vec.size())
{
return nullptr;
}
auto& data = vec[index];
if (data.second)
{
if (std::is_same<T, Type>::value || data.first.type() == get_type<Type>())
{
if (!id_manager::id_traits<Type>::invl_range.second || data.first.value() == id)
{
return &data;
}
}
}
return nullptr;
}
// Find ID
template <typename T, typename Type>
static map_data* find_id(u32 id)
{
static_assert(PtrSame<T, Type>, "Invalid ID type combination");
const u32 index = get_index<Type>(id);
return find_index<T, Type>(index, id);
}
// Allocate new ID (or use fixed ID) and assign the object from the provider()
template <typename T, typename Type, typename F>
static map_data* create_id(F&& provider, u32 id = id_manager::id_traits<Type>::invalid)
{
static_assert(PtrSame<T, Type>, "Invalid ID type combination");
// ID traits
using traits = id_manager::id_traits<Type>;
// Ensure make_typeinfo() is used for this type
[[maybe_unused]] auto& td = stx::typedata<id_manager::typeinfo, Type>();
// Allocate new id
std::lock_guard lock(id_manager::g_mutex);
auto& map = g_fxo->get<id_manager::id_map<T>>();
if (auto* place = allocate_id(map.vec, get_type<Type>(), id, traits::base, traits::step, traits::count, traits::uses_lowest_id, traits::invl_range))
{
// Get object, store it
place->second = provider();
if (place->second)
{
return place;
}
}
return nullptr;
}
public:
// Remove all objects of a type
template <typename T>
static inline void clear()
{
std::lock_guard lock(id_manager::g_mutex);
g_fxo->get<id_manager::id_map<T>>().vec.clear();
}
// Get last ID (updated in create_id/allocate_id)
static inline u32 last_id()
{
return id_manager::g_id;
}
// Get type ID that is meant to be unique within the same container
template <typename T>
static consteval u32 get_type()
{
return id_manager::typeinfo::get_type<T>();
}
// Add a new ID of specified type with specified constructor arguments (returns object or nullptr)
template <typename T, typename Make = T, typename... Args> requires (std::is_constructible_v<Make, Args&&...>)
static inline std::shared_ptr<Make> make_ptr(Args&&... args)
{
if (auto pair = create_id<T, Make>([&] { return std::make_shared<Make>(std::forward<Args>(args)...); }))
{
return {pair->second, static_cast<Make*>(pair->second.get())};
}
return nullptr;
}
// Add a new ID of specified type with specified constructor arguments (returns id)
template <typename T, typename Make = T, typename... Args> requires (std::is_constructible_v<Make, Args&&...>)
static inline u32 make(Args&&... args)
{
if (auto pair = create_id<T, Make>([&] { return std::make_shared<Make>(std::forward<Args>(args)...); }))
{
return pair->first;
}
return id_manager::id_traits<Make>::invalid;
}
// Add a new ID for an object returned by provider()
template <typename T, typename Made = T, typename F> requires (std::is_invocable_v<F&&>)
static inline u32 import(F&& provider, u32 id = id_manager::id_traits<Made>::invalid)
{
if (auto pair = create_id<T, Made>(std::forward<F>(provider), id))
{
return pair->first;
}
return id_manager::id_traits<Made>::invalid;
}
// Add a new ID for an existing object provided (returns new id)
template <typename T, typename Made = T>
static inline u32 import_existing(std::shared_ptr<T> ptr, u32 id = id_manager::id_traits<Made>::invalid)
{
return import<T, Made>([&] { return std::move(ptr); }, id);
}
// Access the ID record without locking (unsafe)
template <typename T, typename Get = T>
static inline map_data* find_unlocked(u32 id)
{
return find_id<T, Get>(id);
}
// Check the ID without locking (can be called from other method)
template <typename T, typename Get = T>
static inline Get* check_unlocked(u32 id)
{
if (const auto found = find_id<T, Get>(id))
{
return static_cast<Get*>(found->second.get());
}
return nullptr;
}
// Check the ID
template <typename T, typename Get = T>
static inline Get* check(u32 id)
{
reader_lock lock(id_manager::g_mutex);
return check_unlocked<T, Get>(id);
}
// Check the ID, access object under shared lock
template <typename T, typename Get = T, typename F, typename FRT = std::invoke_result_t<F, Get&>>
static inline std::conditional_t<std::is_void_v<FRT>, Get*, return_pair<Get*, FRT>> check(u32 id, F&& func)
{
const u32 index = get_index<Get>(id);
if (index >= id_manager::id_traits<Get>::count)
{
return {};
}
reader_lock lock(id_manager::g_mutex);
if (const auto found = find_index<T, Get>(index, id))
{
const auto ptr = static_cast<Get*>(found->second.get());
if constexpr (!std::is_void_v<FRT>)
{
return return_pair<Get*, FRT>{ptr, func(*ptr)};
}
else
{
func(*ptr);
return ptr;
}
}
return {};
}
// Get the object without locking (can be called from other method)
template <typename T, typename Get = T>
static inline std::shared_ptr<Get> get_unlocked(u32 id)
{
const auto found = find_id<T, Get>(id);
if (found == nullptr) [[unlikely]]
{
return nullptr;
}
return std::static_pointer_cast<Get>(found->second);
}
// Get the object
template <typename T, typename Get = T>
static inline std::shared_ptr<Get> get(u32 id)
{
reader_lock lock(id_manager::g_mutex);
return get_unlocked<T, Get>(id);
}
// Get the object, access object under reader lock
template <typename T, typename Get = T, typename F, typename FRT = std::invoke_result_t<F, Get&>>
static inline std::conditional_t<std::is_void_v<FRT>, std::shared_ptr<Get>, return_pair<Get, FRT>> get(u32 id, F&& func)
{
const u32 index = get_index<Get>(id);
if (index >= id_manager::id_traits<Get>::count)
{
return {nullptr};
}
reader_lock lock(id_manager::g_mutex);
const auto found = find_index<T, Get>(index, id);
if (found == nullptr) [[unlikely]]
{
return {nullptr};
}
const auto ptr = static_cast<Get*>(found->second.get());
if constexpr (std::is_void_v<FRT>)
{
func(*ptr);
return {found->second, ptr};
}
else
{
return {{found->second, ptr}, func(*ptr)};
}
}
static constexpr std::false_type unlocked{};
// Access all objects of specified type. Returns the number of objects processed.
// If function result evaluates to true, stop and return the object and the value.
template <typename T, typename... Get, typename F, typename Lock = std::true_type>
static inline auto select(F&& func, Lock = {})
{
static_assert((PtrSame<T, Get> && ...), "Invalid ID type combination");
[[maybe_unused]] std::conditional_t<!!Lock(), reader_lock, const shared_mutex&> lock(id_manager::g_mutex);
using func_traits = function_traits<decltype(&decltype(std::function(std::declval<F>()))::operator())>;
using object_type = typename func_traits::object_type;
using result_type = typename func_traits::result_type;
static_assert(PtrSame<object_type, T>, "Invalid function argument type combination");
std::conditional_t<std::is_void_v<result_type>, u32, return_pair<object_type, result_type>> result{};
for (auto& id : g_fxo->get<id_manager::id_map<T>>().vec)
{
if (auto ptr = static_cast<object_type*>(id.second.get()))
{
if (sizeof...(Get) == 0 || ((id.first.type() == get_type<Get>()) || ...))
{
if constexpr (std::is_void_v<result_type>)
{
func(id.first, *ptr);
result++;
}
else if ((result.ret = func(id.first, *ptr)))
{
result.ptr = {id.second, ptr};
break;
}
}
}
}
return result;
}
// Remove the ID
template <typename T, typename Get = T>
static inline bool remove(u32 id)
{
std::shared_ptr<void> ptr;
{
std::lock_guard lock(id_manager::g_mutex);
if (const auto found = find_id<T, Get>(id))
{
ptr = std::move(found->second);
}
else
{
return false;
}
}
return true;
}
// Remove the ID if matches the weak/shared ptr
template <typename T, typename Get = T, typename Ptr>
static inline bool remove_verify(u32 id, Ptr sptr)
{
std::shared_ptr<void> ptr;
{
std::lock_guard lock(id_manager::g_mutex);
if (const auto found = find_id<T, Get>(id); found &&
(!found->second.owner_before(sptr) && !sptr.owner_before(found->second)))
{
ptr = std::move(found->second);
}
else
{
return false;
}
}
return true;
}
// Remove the ID and return the object
template <typename T, typename Get = T>
static inline std::shared_ptr<Get> withdraw(u32 id)
{
std::shared_ptr<Get> ptr;
{
std::lock_guard lock(id_manager::g_mutex);
if (const auto found = find_id<T, Get>(id))
{
ptr = std::static_pointer_cast<Get>(::as_rvalue(std::move(found->second)));
}
}
return ptr;
}
// Remove the ID after accessing the object under writer lock, return the object and propagate return value
template <typename T, typename Get = T, typename F, typename FRT = std::invoke_result_t<F, Get&>>
static inline std::conditional_t<std::is_void_v<FRT>, std::shared_ptr<Get>, return_pair<Get, FRT>> withdraw(u32 id, F&& func)
{
const u32 index = get_index<Get>(id);
if (index >= id_manager::id_traits<Get>::count)
{
return {nullptr};
}
std::unique_lock lock(id_manager::g_mutex);
if (const auto found = find_index<T, Get>(index, id))
{
const auto _ptr = static_cast<Get*>(found->second.get());
if constexpr (std::is_void_v<FRT>)
{
func(*_ptr);
return std::static_pointer_cast<Get>(::as_rvalue(std::move(found->second)));
}
else
{
FRT ret = func(*_ptr);
if (ret)
{
// If return value evaluates to true, don't delete the object (error code)
return {{found->second, _ptr}, std::move(ret)};
}
return {std::static_pointer_cast<Get>(::as_rvalue(std::move(found->second))), std::move(ret)};
}
}
return {nullptr};
}
};