gh-87135: threading.Lock: Raise rather than hang on Python finalization by encukou · Pull Request #135991 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion Doc/library/exceptions.rst
5 changes: 5 additions & 0 deletions Include/internal/pycore_lock.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ typedef enum _PyLockFlags {

// Fail if interrupted by a signal while waiting on the lock.
_PY_FAIL_IF_INTERRUPTED = 4,

// Locking & unlocking this lock requires attached thread state.
// If locking returns PY_LOCK_FAILURE, a Python exception *may* be raised.
// (Intended for use with _PY_LOCK_HANDLE_SIGNALS and _PY_LOCK_DETACH.)
_PY_LOCK_PYTHONLOCK = 8,
} _PyLockFlags;

// Lock a mutex with an optional timeout and additional options. See
Expand Down
55 changes: 55 additions & 0 deletions Lib/test/test_threading.py
Original file line number Diff line number Diff line change
Expand Up @@ -1247,6 +1247,61 @@ def __del__(self):
self.assertEqual(err, b"")
self.assertIn(b"all clear", out)

@support.subTests('lock_class_name', ['Lock', 'RLock'])
def test_acquire_daemon_thread_lock_in_finalization(self, lock_class_name):
# gh-123940: Py_Finalize() prevents other threads from running Python
# code (and so, releasing locks), so acquiring a locked lock can not
# succeed.
# We raise an exception rather than hang.
code = textwrap.dedent(f"""
import threading
import time

thread_started_event = threading.Event()

lock = threading.{lock_class_name}()
def loop():
if {lock_class_name!r} == 'RLock':
lock.acquire()
with lock:
thread_started_event.set()
while True:
time.sleep(1)

uncontested_lock = threading.{lock_class_name}()

class Cycle:
def __init__(self):
self.self_ref = self
self.thr = threading.Thread(
target=loop, daemon=True)
self.thr.start()
thread_started_event.wait()

def __del__(self):
assert self.thr.is_alive()

# We *can* acquire an unlocked lock
uncontested_lock.acquire()
if {lock_class_name!r} == 'RLock':
uncontested_lock.acquire()

# Acquiring a locked one fails
try:
lock.acquire()
except PythonFinalizationError:
assert self.thr.is_alive()
print('got the correct exception!')

# Cycle holds a reference to itself, which ensures it is
# cleaned up during the GC that runs after daemon threads
# have been forced to exit during finalization.
Cycle()
""")
rc, out, err = assert_python_ok("-c", code)
self.assertEqual(err, b"")
self.assertIn(b"got the correct exception", out)

def test_start_new_thread_failed(self):
# gh-109746: if Python fails to start newly created thread
# due to failure of underlying PyThread_start_new_thread() call,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Acquiring a :class:`threading.Lock` or :class:`threading.RLock` at interpreter
shutdown will raise :exc:`PythonFinalizationError` if Python can determine
that it would otherwise deadlock.
18 changes: 14 additions & 4 deletions Modules/_threadmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -834,9 +834,14 @@ lock_PyThread_acquire_lock(PyObject *op, PyObject *args, PyObject *kwds)
return NULL;
}

PyLockStatus r = _PyMutex_LockTimed(&self->lock, timeout,
_PY_LOCK_HANDLE_SIGNALS | _PY_LOCK_DETACH);
PyLockStatus r = _PyMutex_LockTimed(
&self->lock, timeout,
_PY_LOCK_PYTHONLOCK | _PY_LOCK_HANDLE_SIGNALS | _PY_LOCK_DETACH);
if (r == PY_LOCK_INTR) {
assert(PyErr_Occurred());
return NULL;
}
if (r == PY_LOCK_FAILURE && PyErr_Occurred()) {
return NULL;
}

Expand Down Expand Up @@ -1054,9 +1059,14 @@ rlock_acquire(PyObject *op, PyObject *args, PyObject *kwds)
return NULL;
}

PyLockStatus r = _PyRecursiveMutex_LockTimed(&self->lock, timeout,
_PY_LOCK_HANDLE_SIGNALS | _PY_LOCK_DETACH);
PyLockStatus r = _PyRecursiveMutex_LockTimed(
&self->lock, timeout,
_PY_LOCK_PYTHONLOCK | _PY_LOCK_HANDLE_SIGNALS | _PY_LOCK_DETACH);
if (r == PY_LOCK_INTR) {
assert(PyErr_Occurred());
return NULL;
}
if (r == PY_LOCK_FAILURE && PyErr_Occurred()) {
return NULL;
}

Expand Down
12 changes: 12 additions & 0 deletions Python/lock.c
Loading