Let user scripts disable thread safety checks

This commit is contained in:
Pedro J. Estébanez 2023-06-08 11:33:35 +02:00
parent 828ec2c5d0
commit 2b001db76e
6 changed files with 27 additions and 2 deletions

View File

@ -39,6 +39,7 @@
#include "core/math/geometry_2d.h" #include "core/math/geometry_2d.h"
#include "core/math/geometry_3d.h" #include "core/math/geometry_3d.h"
#include "core/os/keyboard.h" #include "core/os/keyboard.h"
#include "core/os/thread_safe.h"
#include "core/variant/typed_array.h" #include "core/variant/typed_array.h"
namespace core_bind { namespace core_bind {
@ -1255,6 +1256,11 @@ Variant Thread::wait_to_finish() {
return r; return r;
} }
void Thread::set_thread_safety_checks_enabled(bool p_enabled) {
ERR_FAIL_COND_MSG(::Thread::is_main_thread(), "This call is forbidden on the main thread.");
set_current_thread_safe_for_nodes(!p_enabled);
}
void Thread::_bind_methods() { void Thread::_bind_methods() {
ClassDB::bind_method(D_METHOD("start", "callable", "priority"), &Thread::start, DEFVAL(PRIORITY_NORMAL)); ClassDB::bind_method(D_METHOD("start", "callable", "priority"), &Thread::start, DEFVAL(PRIORITY_NORMAL));
ClassDB::bind_method(D_METHOD("get_id"), &Thread::get_id); ClassDB::bind_method(D_METHOD("get_id"), &Thread::get_id);
@ -1262,6 +1268,8 @@ void Thread::_bind_methods() {
ClassDB::bind_method(D_METHOD("is_alive"), &Thread::is_alive); ClassDB::bind_method(D_METHOD("is_alive"), &Thread::is_alive);
ClassDB::bind_method(D_METHOD("wait_to_finish"), &Thread::wait_to_finish); ClassDB::bind_method(D_METHOD("wait_to_finish"), &Thread::wait_to_finish);
ClassDB::bind_static_method("Thread", D_METHOD("set_thread_safety_checks_enabled", "enabled"), &Thread::set_thread_safety_checks_enabled);
BIND_ENUM_CONSTANT(PRIORITY_LOW); BIND_ENUM_CONSTANT(PRIORITY_LOW);
BIND_ENUM_CONSTANT(PRIORITY_NORMAL); BIND_ENUM_CONSTANT(PRIORITY_NORMAL);
BIND_ENUM_CONSTANT(PRIORITY_HIGH); BIND_ENUM_CONSTANT(PRIORITY_HIGH);

View File

@ -408,6 +408,8 @@ public:
bool is_started() const; bool is_started() const;
bool is_alive() const; bool is_alive() const;
Variant wait_to_finish(); Variant wait_to_finish();
static void set_thread_safety_checks_enabled(bool p_enabled);
}; };
namespace special { namespace special {

View File

@ -358,7 +358,6 @@ void ResourceLoader::_thread_load_function(void *p_userdata) {
if (load_nesting == 0 && mq_override) { if (load_nesting == 0 && mq_override) {
memdelete(mq_override); memdelete(mq_override);
set_current_thread_safe_for_nodes(false);
} }
} }

View File

@ -31,6 +31,7 @@
#include "worker_thread_pool.h" #include "worker_thread_pool.h"
#include "core/os/os.h" #include "core/os/os.h"
#include "core/os/thread_safe.h"
void WorkerThreadPool::Task::free_template_userdata() { void WorkerThreadPool::Task::free_template_userdata() {
ERR_FAIL_COND(!template_userdata); ERR_FAIL_COND(!template_userdata);
@ -178,6 +179,9 @@ void WorkerThreadPool::_process_task(Task *p_task) {
if (post) { if (post) {
task_available_semaphore.post(); task_available_semaphore.post();
} }
// Engine/user tasks can set-and-forget, so we must be sure it's back to normal by the end of the task.
set_current_thread_safe_for_nodes(false);
} }
} }

View File

@ -37,6 +37,19 @@
Returns [code]true[/code] if this [Thread] has been started. Once started, this will return [code]true[/code] until it is joined using [method wait_to_finish]. For checking if a [Thread] is still executing its task, use [method is_alive]. Returns [code]true[/code] if this [Thread] has been started. Once started, this will return [code]true[/code] until it is joined using [method wait_to_finish]. For checking if a [Thread] is still executing its task, use [method is_alive].
</description> </description>
</method> </method>
<method name="set_thread_safety_checks_enabled" qualifiers="static">
<return type="void" />
<param index="0" name="enabled" type="bool" />
<description>
Sets whether the thread safety checks the engine normally performs in methods of certain classes (e.g., [Node]) should happen [b]on the current thread[/b].
The default, for every thread, is that they are enabled (as if called with [param enabled] being [code]true[/code]).
Those checks are conservative. That means that they will only succeed in considering a call thread-safe (and therefore allow it to happen) if the engine can guarantee such safety.
Because of that, there may be cases where the user may want to disable them ([param enabled] being [code]false[/code]) to make certain operations allowed again. By doing so, it becomes the user's responsibility to ensure thread safety (e.g., by using [Mutex]) for those objects that are otherwise protected by the engine.
[b]Note:[/b] This is an advanced usage of the engine. You are advised to use it only if you know what you are doing and there is no safer way.
[b]Note:[/b] This is useful for scripts running on either arbitrary [Thread] objects or tasks submitted to the [WorkerThreadPool]. It doesn't apply to code running during [Node] group processing, where the checks will be always performed.
[b]Note:[/b] Even in the case of having disabled the checks in a [WorkerThreadPool] task, there's no need to re-enable them at the end. The engine will do so.
</description>
</method>
<method name="start"> <method name="start">
<return type="int" enum="Error" /> <return type="int" enum="Error" />
<param index="0" name="callable" type="Callable" /> <param index="0" name="callable" type="Callable" />

View File

@ -2722,7 +2722,6 @@ void RichTextLabel::_thread_function(void *p_userdata) {
_process_line_caches(); _process_line_caches();
updating.store(false); updating.store(false);
call_deferred(SNAME("thread_end")); call_deferred(SNAME("thread_end"));
set_current_thread_safe_for_nodes(false);
} }
void RichTextLabel::_thread_end() { void RichTextLabel::_thread_end() {