1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-31 17:48:12 +00:00

LibThreading: Overhaul thread behavior with ThreadState

This replaces all state-related variables with a single ThreadState.
These are simplified over what the Kernel has, but capture all
userspace-available thread state.

Locking the state behind an atomic and using proper atomic operations
also gets rid of quite some deadlocks and race conditions that have
existed around m_tid and others beforehand.

In terms of behavior, this introduces the following changes:
- All thread state mishandling (e.g. joining a detached thread) crashes
  the program. Mishandling thread state is a severe kind of concurrency
  bug that might also be indeterministic, so letting it silently
  disappear with the return value of pthread_ APIs is a bad idea. The
  thread state can always be checked beforehand to ensure that no crash
  happens.
- Destructing a still-running thread will crash in AK/Function, so the
  Thread destructor issues its own warning for debugging purposes.
- Thread issues warnings before crashes in many places to aid
  concurrency debugging (the most difficult kind of debugging).
- Joining dead but not detached threads is legal, as per POSIX APIs.
- The thread ID is never reset to 0 after the thread has been started
  and subsequently been assigned a valid thread ID. The thread's exit
  state is still obtainable.
- Detaching threads that are about to exit is considered a programming
  bug and will often (not always, as we can't catch all execution
  sequences involved in such a situation) crash the program on purpose.
  If you want to detach a thread that will definitely exit on its own,
  you have to prevent it from exiting before detach() was called (e.g.
  with an "exit requested" flag).
This commit is contained in:
kleines Filmröllchen 2022-11-12 14:13:40 +01:00 committed by Andrew Kaster
parent 601ede331b
commit 2fcb713037
2 changed files with 68 additions and 13 deletions

View file

@ -7,6 +7,7 @@
#pragma once
#include <AK/Assertions.h>
#include <AK/DeprecatedString.h>
#include <AK/DistinctNumeric.h>
#include <AK/Function.h>
@ -49,35 +50,46 @@ public:
ErrorOr<void> set_priority(int priority);
ErrorOr<int> get_priority() const;
// Only callable in the Startable state.
void start();
// Only callable in the Running state.
void detach();
// Only callable in the Running or Exited states.
template<typename T = void>
Result<T, ThreadError> join();
DeprecatedString thread_name() const;
pthread_t tid() const;
ThreadState state() const;
bool is_started() const;
bool needs_to_be_joined() const;
bool has_exited() const;
private:
explicit Thread(Function<intptr_t()> action, StringView thread_name = {});
Function<intptr_t()> m_action;
pthread_t m_tid { 0 };
DeprecatedString m_thread_name;
bool m_detached { false };
bool m_started { false };
Atomic<ThreadState> m_state { ThreadState::Startable };
};
template<typename T>
Result<T, ThreadError> Thread::join()
{
VERIFY(needs_to_be_joined());
void* thread_return = nullptr;
int rc = pthread_join(m_tid, &thread_return);
if (rc != 0) {
return ThreadError { rc };
}
m_tid = 0;
// The other thread has now stopped running, so a TOCTOU bug is not possible.
// (If you call join from two different threads, you're doing something *very* wrong anyways.)
VERIFY(m_state == ThreadState::Exited);
m_state = ThreadState::Joined;
if constexpr (IsVoid<T>)
return {};
else
@ -98,7 +110,7 @@ template<>
struct AK::Formatter<Threading::ThreadState> : AK::Formatter<FormatString> {
ErrorOr<void> format(FormatBuilder& builder, Threading::ThreadState state)
{
String name = "";
DeprecatedString name = "";
switch (state) {
case Threading::ThreadState::Detached:
name = "Detached";