2020-01-18 08:38:21 +00:00
|
|
|
/*
|
2020-01-24 13:45:29 +00:00
|
|
|
* Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@serenityos.org>
|
2020-01-18 08:38:21 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2021-05-22 16:47:42 +00:00
|
|
|
#include <LibThreading/Thread.h>
|
2019-11-13 20:49:24 +00:00
|
|
|
#include <pthread.h>
|
2020-12-31 07:57:44 +00:00
|
|
|
#include <string.h>
|
2019-08-25 15:55:56 +00:00
|
|
|
#include <unistd.h>
|
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
namespace Threading {
|
|
|
|
|
|
|
|
Thread::Thread(Function<intptr_t()> action, StringView thread_name)
|
2020-02-02 11:34:39 +00:00
|
|
|
: Core::Object(nullptr)
|
2019-08-25 15:55:56 +00:00
|
|
|
, m_action(move(action))
|
2022-07-11 17:32:29 +00:00
|
|
|
, m_thread_name(thread_name.is_null() ? ""sv : thread_name)
|
2019-08-25 15:55:56 +00:00
|
|
|
{
|
LibThread: Improve semantics of Thread::join, and remove Thread::quit.
Thread::quit was created before the pthread_create_helper in pthread.cpp
that automagically calls pthread_exit from all pthreads after the user's
thread function exits. It is unused, and unecessary now.
Cleanup some logging, and make join return a Result<T, ThreadError>.
This also adds a new type, LibThread::ThreadError as an
AK::DistinctNumeric. Hopefully, this will make it possible to have a
Result<int, ThreadError> and have it compile? It also makes it clear
that the int there is an error at the call site.
By default, the T on join is void, meaning the caller doesn't care about
the return value from the thread.
As Result is a [[nodiscard]] type, also change the current caller of
join to explicitly ignore it.
Move the logging out of join as well, as it's the user's
responsibility whether to log or not.
2021-01-01 03:56:04 +00:00
|
|
|
register_property("thread_name", [&] { return JsonValue { m_thread_name }; });
|
2022-10-16 18:26:12 +00:00
|
|
|
#if defined(AK_OS_SERENITY) || defined(AK_OS_LINUX)
|
|
|
|
// FIXME: Print out a pretty TID for BSD and macOS platforms, too
|
LibThread: Improve semantics of Thread::join, and remove Thread::quit.
Thread::quit was created before the pthread_create_helper in pthread.cpp
that automagically calls pthread_exit from all pthreads after the user's
thread function exits. It is unused, and unecessary now.
Cleanup some logging, and make join return a Result<T, ThreadError>.
This also adds a new type, LibThread::ThreadError as an
AK::DistinctNumeric. Hopefully, this will make it possible to have a
Result<int, ThreadError> and have it compile? It also makes it clear
that the int there is an error at the call site.
By default, the T on join is void, meaning the caller doesn't care about
the return value from the thread.
As Result is a [[nodiscard]] type, also change the current caller of
join to explicitly ignore it.
Move the logging out of join as well, as it's the user's
responsibility whether to log or not.
2021-01-01 03:56:04 +00:00
|
|
|
register_property("tid", [&] { return JsonValue { m_tid }; });
|
2022-10-16 18:26:12 +00:00
|
|
|
#endif
|
2019-08-25 15:55:56 +00:00
|
|
|
}
|
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
Thread::~Thread()
|
2019-08-25 15:55:56 +00:00
|
|
|
{
|
2021-07-02 12:05:07 +00:00
|
|
|
if (m_tid && !m_detached) {
|
LibThread: Improve semantics of Thread::join, and remove Thread::quit.
Thread::quit was created before the pthread_create_helper in pthread.cpp
that automagically calls pthread_exit from all pthreads after the user's
thread function exits. It is unused, and unecessary now.
Cleanup some logging, and make join return a Result<T, ThreadError>.
This also adds a new type, LibThread::ThreadError as an
AK::DistinctNumeric. Hopefully, this will make it possible to have a
Result<int, ThreadError> and have it compile? It also makes it clear
that the int there is an error at the call site.
By default, the T on join is void, meaning the caller doesn't care about
the return value from the thread.
As Result is a [[nodiscard]] type, also change the current caller of
join to explicitly ignore it.
Move the logging out of join as well, as it's the user's
responsibility whether to log or not.
2021-01-01 03:56:04 +00:00
|
|
|
dbgln("Destroying thread \"{}\"({}) while it is still running!", m_thread_name, m_tid);
|
|
|
|
[[maybe_unused]] auto res = join();
|
2019-08-25 15:55:56 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
ErrorOr<void> Thread::set_priority(int priority)
|
2022-11-13 09:23:24 +00:00
|
|
|
{
|
|
|
|
// MacOS has an extra __opaque field, so list initialization will not compile on MacOS Lagom.
|
|
|
|
sched_param scheduling_parameters {};
|
|
|
|
scheduling_parameters.sched_priority = priority;
|
|
|
|
int result = pthread_setschedparam(m_tid, 0, &scheduling_parameters);
|
|
|
|
if (result != 0)
|
|
|
|
return Error::from_errno(result);
|
|
|
|
return {};
|
|
|
|
}
|
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
ErrorOr<int> Thread::get_priority() const
|
2022-11-13 09:23:24 +00:00
|
|
|
{
|
|
|
|
sched_param scheduling_parameters {};
|
|
|
|
int policy;
|
|
|
|
int result = pthread_getschedparam(m_tid, &policy, &scheduling_parameters);
|
|
|
|
if (result != 0)
|
|
|
|
return Error::from_errno(result);
|
|
|
|
return scheduling_parameters.sched_priority;
|
|
|
|
}
|
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
void Thread::start()
|
2019-08-25 15:55:56 +00:00
|
|
|
{
|
2019-11-13 20:49:24 +00:00
|
|
|
int rc = pthread_create(
|
|
|
|
&m_tid,
|
|
|
|
nullptr,
|
|
|
|
[](void* arg) -> void* {
|
|
|
|
Thread* self = static_cast<Thread*>(arg);
|
2021-04-26 17:09:04 +00:00
|
|
|
auto exit_code = self->m_action();
|
2020-09-18 07:49:51 +00:00
|
|
|
self->m_tid = 0;
|
2021-04-26 17:09:04 +00:00
|
|
|
return reinterpret_cast<void*>(exit_code);
|
2019-11-13 20:49:24 +00:00
|
|
|
},
|
|
|
|
static_cast<void*>(this));
|
2019-08-25 15:55:56 +00:00
|
|
|
|
2021-02-23 19:42:32 +00:00
|
|
|
VERIFY(rc == 0);
|
2022-10-16 18:26:12 +00:00
|
|
|
#ifdef AK_OS_SERENITY
|
2019-12-07 19:49:05 +00:00
|
|
|
if (!m_thread_name.is_empty()) {
|
2020-01-11 11:54:30 +00:00
|
|
|
rc = pthread_setname_np(m_tid, m_thread_name.characters());
|
2021-02-23 19:42:32 +00:00
|
|
|
VERIFY(rc == 0);
|
2019-12-07 19:49:05 +00:00
|
|
|
}
|
2022-10-16 18:26:12 +00:00
|
|
|
#endif
|
LibThread: Improve semantics of Thread::join, and remove Thread::quit.
Thread::quit was created before the pthread_create_helper in pthread.cpp
that automagically calls pthread_exit from all pthreads after the user's
thread function exits. It is unused, and unecessary now.
Cleanup some logging, and make join return a Result<T, ThreadError>.
This also adds a new type, LibThread::ThreadError as an
AK::DistinctNumeric. Hopefully, this will make it possible to have a
Result<int, ThreadError> and have it compile? It also makes it clear
that the int there is an error at the call site.
By default, the T on join is void, meaning the caller doesn't care about
the return value from the thread.
As Result is a [[nodiscard]] type, also change the current caller of
join to explicitly ignore it.
Move the logging out of join as well, as it's the user's
responsibility whether to log or not.
2021-01-01 03:56:04 +00:00
|
|
|
dbgln("Started thread \"{}\", tid = {}", m_thread_name, m_tid);
|
2022-07-13 08:33:14 +00:00
|
|
|
m_started = true;
|
2019-08-25 15:55:56 +00:00
|
|
|
}
|
2021-07-02 12:05:07 +00:00
|
|
|
|
2022-11-12 11:54:53 +00:00
|
|
|
void Thread::detach()
|
2021-07-02 12:05:07 +00:00
|
|
|
{
|
|
|
|
VERIFY(!m_detached);
|
|
|
|
|
|
|
|
int rc = pthread_detach(m_tid);
|
|
|
|
VERIFY(rc == 0);
|
|
|
|
|
|
|
|
m_detached = true;
|
|
|
|
}
|
2022-11-12 11:54:53 +00:00
|
|
|
|
|
|
|
}
|