Fixup thread-owned lambda bookkeeping on thread exit (take 2)

This commit is contained in:
Pedro J. Estébanez 2023-11-22 23:20:49 +01:00
parent f26328e9a3
commit bfe66ab7cd
3 changed files with 129 additions and 17 deletions

View File

@ -132,6 +132,8 @@ public:
data->erase(this); data->erase(this);
} }
void transfer_to_back(List<T, A> *p_dst_list);
_FORCE_INLINE_ Element() {} _FORCE_INLINE_ Element() {}
}; };
@ -762,4 +764,41 @@ public:
} }
}; };
template <class T, class A>
void List<T, A>::Element::transfer_to_back(List<T, A> *p_dst_list) {
// Detach from current.
if (data->first == this) {
data->first = data->first->next_ptr;
}
if (data->last == this) {
data->last = data->last->prev_ptr;
}
if (prev_ptr) {
prev_ptr->next_ptr = next_ptr;
}
if (next_ptr) {
next_ptr->prev_ptr = prev_ptr;
}
data->size_cache--;
// Attach to the back of the new one.
if (!p_dst_list->_data) {
p_dst_list->_data = memnew_allocator(_Data, A);
p_dst_list->_data->first = this;
p_dst_list->_data->last = nullptr;
p_dst_list->_data->size_cache = 0;
prev_ptr = nullptr;
} else {
p_dst_list->_data->last->next_ptr = this;
prev_ptr = p_dst_list->_data->last;
}
p_dst_list->_data->last = this;
next_ptr = nullptr;
data = p_dst_list->_data;
p_dst_list->_data->size_cache++;
}
#endif // LIST_H #endif // LIST_H

View File

@ -1391,36 +1391,54 @@ String GDScript::debug_get_script_name(const Ref<Script> &p_script) {
} }
#endif #endif
thread_local GDScript::UpdatableFuncPtr GDScript::func_ptrs_to_update_thread_local; GDScript::UpdatableFuncPtr GDScript::func_ptrs_to_update_main_thread;
thread_local GDScript::UpdatableFuncPtr *GDScript::func_ptrs_to_update_thread_local = nullptr;
GDScript::UpdatableFuncPtrElement GDScript::_add_func_ptr_to_update(GDScriptFunction **p_func_ptr_ptr) { GDScript::UpdatableFuncPtrElement GDScript::_add_func_ptr_to_update(GDScriptFunction **p_func_ptr_ptr) {
UpdatableFuncPtrElement result = {}; UpdatableFuncPtrElement result = {};
{ {
MutexLock lock(func_ptrs_to_update_thread_local.mutex); MutexLock lock(func_ptrs_to_update_thread_local->mutex);
result.element = func_ptrs_to_update_thread_local.ptrs.push_back(p_func_ptr_ptr); result.element = func_ptrs_to_update_thread_local->ptrs.push_back(p_func_ptr_ptr);
result.mutex = &func_ptrs_to_update_thread_local.mutex; result.func_ptr = func_ptrs_to_update_thread_local;
if (likely(func_ptrs_to_update_thread_local.initialized)) { if (likely(func_ptrs_to_update_thread_local->initialized)) {
return result; return result;
} }
func_ptrs_to_update_thread_local.initialized = true; func_ptrs_to_update_thread_local->initialized = true;
} }
MutexLock lock(func_ptrs_to_update_mutex); MutexLock lock(func_ptrs_to_update_mutex);
func_ptrs_to_update.push_back(&func_ptrs_to_update_thread_local); func_ptrs_to_update.push_back(func_ptrs_to_update_thread_local);
func_ptrs_to_update_thread_local->rc++;
return result; return result;
} }
void GDScript::_remove_func_ptr_to_update(const UpdatableFuncPtrElement p_func_ptr_element) { void GDScript::_remove_func_ptr_to_update(const UpdatableFuncPtrElement &p_func_ptr_element) {
ERR_FAIL_NULL(p_func_ptr_element.element); ERR_FAIL_NULL(p_func_ptr_element.element);
ERR_FAIL_NULL(p_func_ptr_element.mutex); ERR_FAIL_NULL(p_func_ptr_element.func_ptr);
MutexLock lock(*p_func_ptr_element.mutex); MutexLock lock(p_func_ptr_element.func_ptr->mutex);
p_func_ptr_element.element->erase(); p_func_ptr_element.element->erase();
} }
void GDScript::_fixup_thread_function_bookkeeping() {
// Transfer the ownership of these update items to the main thread,
// because the current one is dying, leaving theirs orphan, dangling.
DEV_ASSERT(!Thread::is_main_thread());
MutexLock lock(func_ptrs_to_update_main_thread.mutex);
MutexLock lock2(func_ptrs_to_update_thread_local->mutex);
while (!func_ptrs_to_update_thread_local->ptrs.is_empty()) {
List<GDScriptFunction **>::Element *E = func_ptrs_to_update_thread_local->ptrs.front();
E->transfer_to_back(&func_ptrs_to_update_main_thread.ptrs);
func_ptrs_to_update_thread_local->transferred = true;
}
}
void GDScript::clear(ClearData *p_clear_data) { void GDScript::clear(ClearData *p_clear_data) {
if (clearing) { if (clearing) {
return; return;
@ -1441,9 +1459,27 @@ void GDScript::clear(ClearData *p_clear_data) {
{ {
MutexLock outer_lock(func_ptrs_to_update_mutex); MutexLock outer_lock(func_ptrs_to_update_mutex);
for (UpdatableFuncPtr *updatable : func_ptrs_to_update) { for (UpdatableFuncPtr *updatable : func_ptrs_to_update) {
MutexLock inner_lock(updatable->mutex); bool destroy = false;
for (GDScriptFunction **func_ptr_ptr : updatable->ptrs) { {
*func_ptr_ptr = nullptr; MutexLock inner_lock(updatable->mutex);
if (updatable->transferred) {
func_ptrs_to_update_main_thread.mutex.lock();
}
for (GDScriptFunction **func_ptr_ptr : updatable->ptrs) {
*func_ptr_ptr = nullptr;
}
DEV_ASSERT(updatable->rc != 0);
updatable->rc--;
if (updatable->rc == 0) {
destroy = true;
}
if (updatable->transferred) {
func_ptrs_to_update_main_thread.mutex.unlock();
}
}
if (destroy) {
DEV_ASSERT(updatable != &func_ptrs_to_update_main_thread);
memdelete(updatable);
} }
} }
} }
@ -2065,6 +2101,27 @@ void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
named_globals.erase(p_name); named_globals.erase(p_name);
} }
void GDScriptLanguage::thread_enter() {
GDScript::func_ptrs_to_update_thread_local = memnew(GDScript::UpdatableFuncPtr);
}
void GDScriptLanguage::thread_exit() {
GDScript::_fixup_thread_function_bookkeeping();
bool destroy = false;
{
MutexLock lock(GDScript::func_ptrs_to_update_thread_local->mutex);
DEV_ASSERT(GDScript::func_ptrs_to_update_thread_local->rc != 0);
GDScript::func_ptrs_to_update_thread_local->rc--;
if (GDScript::func_ptrs_to_update_thread_local->rc == 0) {
destroy = true;
}
}
if (destroy) {
memdelete(GDScript::func_ptrs_to_update_thread_local);
}
}
void GDScriptLanguage::init() { void GDScriptLanguage::init() {
//populate global constants //populate global constants
int gcc = CoreConstants::get_global_constant_count(); int gcc = CoreConstants::get_global_constant_count();
@ -2097,6 +2154,8 @@ void GDScriptLanguage::init() {
_add_global(E.name, E.ptr); _add_global(E.name, E.ptr);
} }
GDScript::func_ptrs_to_update_thread_local = &GDScript::func_ptrs_to_update_main_thread;
#ifdef TESTS_ENABLED #ifdef TESTS_ENABLED
GDScriptTests::GDScriptTestRunner::handle_cmdline(); GDScriptTests::GDScriptTestRunner::handle_cmdline();
#endif #endif
@ -2146,6 +2205,8 @@ void GDScriptLanguage::finish() {
} }
script_list.clear(); script_list.clear();
function_list.clear(); function_list.clear();
DEV_ASSERT(GDScript::func_ptrs_to_update_main_thread.rc == 1);
} }
void GDScriptLanguage::profiling_start() { void GDScriptLanguage::profiling_start() {

View File

@ -121,18 +121,25 @@ class GDScript : public Script {
struct UpdatableFuncPtr { struct UpdatableFuncPtr {
List<GDScriptFunction **> ptrs; List<GDScriptFunction **> ptrs;
Mutex mutex; Mutex mutex;
bool initialized = false; bool initialized : 1;
bool transferred : 1;
uint32_t rc = 1;
UpdatableFuncPtr() :
initialized(false), transferred(false) {}
}; };
struct UpdatableFuncPtrElement { struct UpdatableFuncPtrElement {
List<GDScriptFunction **>::Element *element = nullptr; List<GDScriptFunction **>::Element *element = nullptr;
Mutex *mutex = nullptr; UpdatableFuncPtr *func_ptr = nullptr;
}; };
static thread_local UpdatableFuncPtr func_ptrs_to_update_thread_local; static UpdatableFuncPtr func_ptrs_to_update_main_thread;
static thread_local UpdatableFuncPtr *func_ptrs_to_update_thread_local;
List<UpdatableFuncPtr *> func_ptrs_to_update; List<UpdatableFuncPtr *> func_ptrs_to_update;
Mutex func_ptrs_to_update_mutex; Mutex func_ptrs_to_update_mutex;
UpdatableFuncPtrElement _add_func_ptr_to_update(GDScriptFunction **p_func_ptr_ptr); UpdatableFuncPtrElement _add_func_ptr_to_update(GDScriptFunction **p_func_ptr_ptr);
static void _remove_func_ptr_to_update(const UpdatableFuncPtrElement p_func_ptr_element); static void _remove_func_ptr_to_update(const UpdatableFuncPtrElement &p_func_ptr_element);
static void _fixup_thread_function_bookkeeping();
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
// For static data storage during hot-reloading. // For static data storage during hot-reloading.
@ -554,6 +561,11 @@ public:
virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override; virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override;
virtual void remove_named_global_constant(const StringName &p_name) override; virtual void remove_named_global_constant(const StringName &p_name) override;
/* MULTITHREAD FUNCTIONS */
virtual void thread_enter() override;
virtual void thread_exit() override;
/* DEBUGGER FUNCTIONS */ /* DEBUGGER FUNCTIONS */
virtual String debug_get_error() const override; virtual String debug_get_error() const override;