gh-114271: Make `_thread.ThreadHandle` thread-safe in free-threaded builds by mpage · Pull Request #115190 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Include/internal/pycore_lock.h
91 changes: 47 additions & 44 deletions Lib/test/test_thread.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ def task():
with threading_helper.wait_threads_exit():
handle = thread.start_joinable_thread(task)
handle.join()
with self.assertRaisesRegex(ValueError, "not joinable"):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is interesting... our docs already claim that threads can be joined multiple times. So I wonder why this existing test logic was previously explicitly checking for an error here.

In this sense this change aligns with what our docs claim so a behavior change here could be seen as a bugfix. I do not expect anyone to be depending on subsequent join()s of a thread raising regardless.

handle.join()
# Subsequent join() calls should succeed
handle.join()

def test_joinable_not_joined(self):
handle_destroyed = thread.allocate_lock()
Expand Down Expand Up @@ -233,58 +233,61 @@ def task():
with self.assertRaisesRegex(RuntimeError, "Cannot join current thread"):
raise errors[0]

def test_detach_from_self(self):
errors = []
handles = []
start_joinable_thread_returned = thread.allocate_lock()
start_joinable_thread_returned.acquire()
thread_detached = thread.allocate_lock()
thread_detached.acquire()
def test_join_then_self_join(self):
# make sure we can't deadlock in the following scenario with
Comment thread
mpage marked this conversation as resolved.
# threads t0 and t1 (see comment in `ThreadHandle_join()` for more
# details):
#
# - t0 joins t1
# - t1 self joins
def make_lock():
lock = thread.allocate_lock()
lock.acquire()
return lock

error = None
self_joiner_handle = None
self_joiner_started = make_lock()
self_joiner_barrier = make_lock()
def self_joiner():
nonlocal error

self_joiner_started.release()
self_joiner_barrier.acquire()

def task():
start_joinable_thread_returned.acquire()
try:
handles[0].detach()
self_joiner_handle.join()
except Exception as e:
errors.append(e)
finally:
thread_detached.release()
error = e

joiner_started = make_lock()
def joiner():
joiner_started.release()
self_joiner_handle.join()

with threading_helper.wait_threads_exit():
handle = thread.start_joinable_thread(task)
handles.append(handle)
start_joinable_thread_returned.release()
thread_detached.acquire()
with self.assertRaisesRegex(ValueError, "not joinable"):
handle.join()
self_joiner_handle = thread.start_joinable_thread(self_joiner)
# Wait for the self-joining thread to start
self_joiner_started.acquire()

assert len(errors) == 0
# Start the thread that joins the self-joiner
joiner_handle = thread.start_joinable_thread(joiner)

def test_detach_then_join(self):
lock = thread.allocate_lock()
lock.acquire()
# Wait for the joiner to start
joiner_started.acquire()

def task():
lock.acquire()
# Not great, but I don't think there's a deterministic way to make
Comment thread
gpshead marked this conversation as resolved.
# sure that the self-joining thread has been joined.
time.sleep(0.1)

with threading_helper.wait_threads_exit():
handle = thread.start_joinable_thread(task)
# detach() returns even though the thread is blocked on lock
handle.detach()
# join() then cannot be called anymore
with self.assertRaisesRegex(ValueError, "not joinable"):
handle.join()
lock.release()

def test_join_then_detach(self):
def task():
pass
# Unblock the self-joiner
self_joiner_barrier.release()

with threading_helper.wait_threads_exit():
handle = thread.start_joinable_thread(task)
handle.join()
with self.assertRaisesRegex(ValueError, "not joinable"):
handle.detach()
self_joiner_handle.join()
joiner_handle.join()

with self.assertRaisesRegex(RuntimeError, "Cannot join current thread"):
raise error


class Barrier:
Expand Down
24 changes: 7 additions & 17 deletions Lib/threading.py
Loading