bpo-19466: Py_Finalize() clears daemon threads earlier (GH-18848)

Clear the frames of daemon threads earlier during the Python shutdown to
call objects destructors. So "unclosed file" resource warnings are now
emitted for daemon threads in a more reliable way.

Cleanup _PyThreadState_DeleteExcept() code: rename "garbage" to
"list".
This commit is contained in:
Victor Stinner 2020-03-09 23:37:49 +01:00 committed by GitHub
parent 8e9c47a947
commit 9ad58acbe8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 70 additions and 7 deletions

View File

@ -759,6 +759,51 @@ class ThreadTests(BaseTestCase):
# Daemon threads must never add it to _shutdown_locks. # Daemon threads must never add it to _shutdown_locks.
self.assertNotIn(tstate_lock, threading._shutdown_locks) self.assertNotIn(tstate_lock, threading._shutdown_locks)
def test_locals_at_exit(self):
# bpo-19466: thread locals must not be deleted before destructors
# are called
rc, out, err = assert_python_ok("-c", """if 1:
import threading
class Atexit:
def __del__(self):
print("thread_dict.atexit = %r" % thread_dict.atexit)
thread_dict = threading.local()
thread_dict.atexit = "value"
atexit = Atexit()
""")
self.assertEqual(out.rstrip(), b"thread_dict.atexit = 'value'")
def test_warnings_at_exit(self):
# bpo-19466: try to call most destructors at Python shutdown before
# destroying Python thread states
filename = __file__
rc, out, err = assert_python_ok("-Wd", "-c", """if 1:
import time
import threading
from test import support
def open_sleep():
# a warning will be emitted when the open file will be
# destroyed (without being explicitly closed) while the daemon
# thread is destroyed
fileobj = open(%a, 'rb')
start_event.set()
time.sleep(support.LONG_TIMEOUT)
start_event = threading.Event()
thread = threading.Thread(target=open_sleep, daemon=True)
thread.start()
# wait until the thread started
start_event.wait()
""" % filename)
self.assertRegex(err.rstrip(),
b"^sys:1: ResourceWarning: unclosed file ")
class ThreadJoinOnShutdown(BaseTestCase): class ThreadJoinOnShutdown(BaseTestCase):

View File

@ -0,0 +1,3 @@
Clear the frames of daemon threads earlier during the Python shutdown to
call objects destructors. So "unclosed file" resource warnings are now
emitted for daemon threads in a more reliable way.

View File

@ -1373,6 +1373,16 @@ Py_FinalizeEx(void)
runtime->initialized = 0; runtime->initialized = 0;
runtime->core_initialized = 0; runtime->core_initialized = 0;
/* Destroy the state of all threads of the interpreter, except of the
current thread. In practice, only daemon threads should still be alive,
except if wait_for_thread_shutdown() has been cancelled by CTRL+C.
Clear frames of other threads to call objects destructors. Destructors
will be called in the current Python thread. Since
_PyRuntimeState_SetFinalizing() has been called, no other Python thread
can take the GIL at this point: if they try, they will exit
immediately. */
_PyThreadState_DeleteExcept(runtime, tstate);
/* Flush sys.stdout and sys.stderr */ /* Flush sys.stdout and sys.stderr */
if (flush_std_files() < 0) { if (flush_std_files() < 0) {
status = -1; status = -1;

View File

@ -895,25 +895,30 @@ void
_PyThreadState_DeleteExcept(_PyRuntimeState *runtime, PyThreadState *tstate) _PyThreadState_DeleteExcept(_PyRuntimeState *runtime, PyThreadState *tstate)
{ {
PyInterpreterState *interp = tstate->interp; PyInterpreterState *interp = tstate->interp;
PyThreadState *p, *next, *garbage;
HEAD_LOCK(runtime); HEAD_LOCK(runtime);
/* Remove all thread states, except tstate, from the linked list of /* Remove all thread states, except tstate, from the linked list of
thread states. This will allow calling PyThreadState_Clear() thread states. This will allow calling PyThreadState_Clear()
without holding the lock. */ without holding the lock. */
garbage = interp->tstate_head; PyThreadState *list = interp->tstate_head;
if (garbage == tstate) if (list == tstate) {
garbage = tstate->next; list = tstate->next;
if (tstate->prev) }
if (tstate->prev) {
tstate->prev->next = tstate->next; tstate->prev->next = tstate->next;
if (tstate->next) }
if (tstate->next) {
tstate->next->prev = tstate->prev; tstate->next->prev = tstate->prev;
}
tstate->prev = tstate->next = NULL; tstate->prev = tstate->next = NULL;
interp->tstate_head = tstate; interp->tstate_head = tstate;
HEAD_UNLOCK(runtime); HEAD_UNLOCK(runtime);
/* Clear and deallocate all stale thread states. Even if this /* Clear and deallocate all stale thread states. Even if this
executes Python code, we should be safe since it executes executes Python code, we should be safe since it executes
in the current thread, not one of the stale threads. */ in the current thread, not one of the stale threads. */
for (p = garbage; p; p = next) { PyThreadState *p, *next;
for (p = list; p; p = next) {
next = p->next; next = p->next;
PyThreadState_Clear(p); PyThreadState_Clear(p);
PyMem_RawFree(p); PyMem_RawFree(p);