2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* thread_posix.cpp */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-01-01 11:16:22 +01:00
|
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "thread_posix.h"
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/script_language.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2018-03-20 04:15:27 +01:00
|
|
|
#if (defined(UNIX_ENABLED) || defined(PTHREAD_ENABLED)) && !defined(NO_THREADS)
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-01-09 15:56:31 +01:00
|
|
|
#ifdef PTHREAD_BSD_SET_NAME
|
|
|
|
#include <pthread_np.h>
|
|
|
|
#endif
|
|
|
|
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/os/memory.h"
|
2017-08-23 19:18:38 +02:00
|
|
|
#include "core/safe_refcount.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-01-25 00:25:49 +01:00
|
|
|
static void _thread_id_key_destr_callback(void *p_value) {
|
|
|
|
memdelete(static_cast<Thread::ID *>(p_value));
|
|
|
|
}
|
|
|
|
|
2017-08-23 19:18:38 +02:00
|
|
|
static pthread_key_t _create_thread_id_key() {
|
|
|
|
pthread_key_t key;
|
2019-01-25 00:25:49 +01:00
|
|
|
pthread_key_create(&key, &_thread_id_key_destr_callback);
|
2017-08-23 19:18:38 +02:00
|
|
|
return key;
|
|
|
|
}
|
|
|
|
|
|
|
|
pthread_key_t ThreadPosix::thread_id_key = _create_thread_id_key();
|
|
|
|
Thread::ID ThreadPosix::next_thread_id = 0;
|
|
|
|
|
2017-08-07 12:17:31 +02:00
|
|
|
Thread::ID ThreadPosix::get_id() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
return id;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Thread *ThreadPosix::create_thread_posix() {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
return memnew(ThreadPosix);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void *ThreadPosix::thread_callback(void *userdata) {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ThreadPosix *t = reinterpret_cast<ThreadPosix *>(userdata);
|
2017-08-23 19:18:38 +02:00
|
|
|
t->id = atomic_increment(&next_thread_id);
|
2019-01-25 00:25:49 +01:00
|
|
|
pthread_setspecific(thread_id_key, (void *)memnew(ID(t->id)));
|
2016-06-25 15:40:33 +02:00
|
|
|
|
|
|
|
ScriptServer::thread_enter(); //scripts may need to attach a stack
|
|
|
|
|
2015-12-18 06:58:30 +01:00
|
|
|
t->callback(t->user);
|
2016-06-25 15:40:33 +02:00
|
|
|
|
|
|
|
ScriptServer::thread_exit();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Thread *ThreadPosix::create_func_posix(ThreadCreateCallback p_callback, void *p_user, const Settings &) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ThreadPosix *tr = memnew(ThreadPosix);
|
|
|
|
tr->callback = p_callback;
|
|
|
|
tr->user = p_user;
|
2014-02-10 02:10:30 +01:00
|
|
|
pthread_attr_init(&tr->pthread_attr);
|
2014-02-13 22:03:28 +01:00
|
|
|
pthread_attr_setdetachstate(&tr->pthread_attr, PTHREAD_CREATE_JOINABLE);
|
|
|
|
pthread_attr_setstacksize(&tr->pthread_attr, 256 * 1024);
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
pthread_create(&tr->pthread, &tr->pthread_attr, thread_callback, tr);
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
return tr;
|
|
|
|
}
|
2017-08-07 12:17:31 +02:00
|
|
|
Thread::ID ThreadPosix::get_thread_id_func_posix() {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-01-25 00:25:49 +01:00
|
|
|
void *value = pthread_getspecific(thread_id_key);
|
|
|
|
|
|
|
|
if (value)
|
|
|
|
return *static_cast<ID *>(value);
|
|
|
|
|
|
|
|
ID new_id = atomic_increment(&next_thread_id);
|
|
|
|
pthread_setspecific(thread_id_key, (void *)memnew(ID(new_id)));
|
|
|
|
return new_id;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
void ThreadPosix::wait_to_finish_func_posix(Thread *p_thread) {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
ThreadPosix *tp = static_cast<ThreadPosix *>(p_thread);
|
2014-02-10 02:10:30 +01:00
|
|
|
ERR_FAIL_COND(!tp);
|
2017-03-05 16:44:50 +01:00
|
|
|
ERR_FAIL_COND(tp->pthread == 0);
|
|
|
|
|
|
|
|
pthread_join(tp->pthread, NULL);
|
|
|
|
tp->pthread = 0;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Error ThreadPosix::set_name_func_posix(const String &p_name) {
|
2015-12-17 10:24:27 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#ifdef PTHREAD_NO_RENAME
|
2015-12-22 14:07:35 +01:00
|
|
|
return ERR_UNAVAILABLE;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#else
|
2015-12-22 14:07:35 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#ifdef PTHREAD_RENAME_SELF
|
2015-12-18 06:58:30 +01:00
|
|
|
|
|
|
|
// check if thread is the same as caller
|
|
|
|
int err = pthread_setname_np(p_name.utf8().get_data());
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#else
|
|
|
|
|
2018-10-04 11:09:55 +02:00
|
|
|
pthread_t running_thread = pthread_self();
|
2017-03-05 16:44:50 +01:00
|
|
|
#ifdef PTHREAD_BSD_SET_NAME
|
2016-02-01 00:22:38 +01:00
|
|
|
pthread_set_name_np(running_thread, p_name.utf8().get_data());
|
2016-01-09 15:56:31 +01:00
|
|
|
int err = 0; // Open/FreeBSD ignore errors in this function
|
2017-03-05 16:44:50 +01:00
|
|
|
#else
|
2016-02-01 00:22:38 +01:00
|
|
|
int err = pthread_setname_np(running_thread, p_name.utf8().get_data());
|
2017-03-05 16:44:50 +01:00
|
|
|
#endif // PTHREAD_BSD_SET_NAME
|
2015-12-17 10:24:27 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#endif // PTHREAD_RENAME_SELF
|
2015-12-18 06:58:30 +01:00
|
|
|
|
2015-12-17 10:24:27 +01:00
|
|
|
return err == 0 ? OK : ERR_INVALID_PARAMETER;
|
2015-12-22 14:07:35 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
#endif // PTHREAD_NO_RENAME
|
2015-12-17 10:24:27 +01:00
|
|
|
};
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void ThreadPosix::make_default() {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
create_func = create_func_posix;
|
2017-08-07 12:17:31 +02:00
|
|
|
get_thread_id_func = get_thread_id_func_posix;
|
2017-03-05 16:44:50 +01:00
|
|
|
wait_to_finish_func = wait_to_finish_func_posix;
|
2016-02-01 00:22:38 +01:00
|
|
|
set_name_func = set_name_func_posix;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
ThreadPosix::ThreadPosix() {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
pthread = 0;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
ThreadPosix::~ThreadPosix() {
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|