Skip to content

gh-128384: Add locking to warnings.py. #128386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nascheme merged 11 commits into from
Jan 14, 2025
Merged

gh-128384: Add locking to warnings.py. #128386

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
deb659d
Add locking to warnings.py.
nascheme Dec 27, 2024
d5187b3
Rename function, add locking to _filters_mutated().
nascheme Jan 1, 2025
553d04f
Use re-entrant lock for warnings module.
nascheme Jan 1, 2025
4b56ae6
Fix locking for !Py_GIL_DISABLED build.
nascheme Jan 2, 2025
6100ab2
Add blurb.
nascheme Jan 6, 2025
b9db71f
Fix typo.
nascheme Jan 6, 2025
27e3acd
Update Misc/NEWS.d/next/Library/2025-01-06-10-37-27.gh-issue-128384.V…
nascheme Jan 7, 2025
dcdb699
Merge branch 'main' into warnings_lock
nascheme Jan 7, 2025
441b1ae
Use locking for GIL build as well.
nascheme Jan 7, 2025
9bd8875
Update Python/_warnings.c
nascheme Jan 12, 2025
5b19978
Hold lock while assigning self._module methods.
nascheme Jan 14, 2025
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
Prev Previous commit
Next Next commit
Fix locking for !Py_GIL_DISABLED build.
  • Loading branch information
@nascheme
nascheme committed Jan 2, 2025
commit 4b56ae6096b2c23b3740862f7c8f6927cd6f638c
88 changes: 45 additions & 43 deletions Python/_warnings.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,36 @@ get_warnings_attr(PyInterpreterState *interp, PyObject *attr, int try_import)
return obj;
}

static inline void
warnings_lock(PyInterpreterState *interp)
{
#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(interp);
assert(st != NULL);
_PyRecursiveMutex_Lock(&st->lock);
#endif
}

static inline void
warnings_unlock(PyInterpreterState *interp)
{
#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(interp);
assert(st != NULL);
_PyRecursiveMutex_Unlock(&st->lock);
#endif
}

static inline bool
warnings_lock_held(WarningsState *st)
{
#ifdef Py_GIL_DISABLED
return PyMutex_IsLocked(&(st)->lock.mutex);
#else
return true;
#endif
}

/*[clinic input]
_acquire_lock as warnings_acquire_lock

Expand All @@ -245,11 +275,7 @@ warnings_acquire_lock_impl(PyObject *module)
if (interp == NULL) {
return NULL;
}

WarningsState *st = warnings_get_state(interp);
assert(st != NULL);

_PyRecursiveMutex_Lock(&st->lock);
warnings_lock(interp);
Py_RETURN_NONE;
}

Expand All @@ -266,11 +292,7 @@ warnings_release_lock_impl(PyObject *module)
if (interp == NULL) {
return NULL;
}

WarningsState *st = warnings_get_state(interp);
assert(st != NULL);

_PyRecursiveMutex_Unlock(&st->lock);
warnings_unlock(interp);
Py_RETURN_NONE;
}

Expand All @@ -280,7 +302,7 @@ get_once_registry(PyInterpreterState *interp)
WarningsState *st = warnings_get_state(interp);
assert(st != NULL);

assert(PyMutex_IsLocked(&st->lock.mutex));
assert(warnings_lock_held(st));

PyObject *registry = GET_WARNINGS_ATTR(interp, onceregistry, 0);
if (registry == NULL) {
Expand Down Expand Up @@ -308,7 +330,7 @@ get_default_action(PyInterpreterState *interp)
WarningsState *st = warnings_get_state(interp);
assert(st != NULL);

assert(PyMutex_IsLocked(&st->lock.mutex));
assert(warnings_lock_held(st));

PyObject *default_action = GET_WARNINGS_ATTR(interp, defaultaction, 0);
if (default_action == NULL) {
Expand Down Expand Up @@ -340,7 +362,7 @@ get_filter(PyInterpreterState *interp, PyObject *category,
WarningsState *st = warnings_get_state(interp);
assert(st != NULL);

assert(PyMutex_IsLocked(&st->lock.mutex));
assert(warnings_lock_held(st));

PyObject *warnings_filters = GET_WARNINGS_ATTR(interp, filters, 0);
if (warnings_filters == NULL) {
Expand Down Expand Up @@ -440,7 +462,7 @@ already_warned(PyInterpreterState *interp, PyObject *registry, PyObject *key,

WarningsState *st = warnings_get_state(interp);
assert(st != NULL);
assert(PyMutex_IsLocked(&st->lock.mutex));
assert(warnings_lock_held(st));

PyObject *version_obj;
if (PyDict_GetItemRef(registry, &_Py_ID(version), &version_obj) < 0) {
Expand Down Expand Up @@ -1035,15 +1057,10 @@ do_warn(PyObject *message, PyObject *category, Py_ssize_t stack_level,
&filename, &lineno, &module, &registry))
return NULL;

#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(tstate->interp);
assert(st != NULL);
#endif

_PyRecursiveMutex_Lock(&st->lock);
warnings_lock(tstate->interp);
res = warn_explicit(tstate, category, message, filename, lineno, module, registry,
NULL, source);
_PyRecursiveMutex_Unlock(&st->lock);
warnings_unlock(tstate->interp);
Py_DECREF(filename);
Py_DECREF(registry);
Py_DECREF(module);
Expand Down Expand Up @@ -1192,15 +1209,10 @@ warnings_warn_explicit_impl(PyObject *module, PyObject *message,
}
}

#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(tstate->interp);
assert(st != NULL);
#endif

_PyRecursiveMutex_Lock(&st->lock);
warnings_lock(tstate->interp);
returned = warn_explicit(tstate, category, message, filename, lineno,
mod, registry, source_line, sourceobj);
_PyRecursiveMutex_Unlock(&st->lock);
warnings_unlock(tstate->interp);
Py_XDECREF(source_line);
return returned;
}
Expand All @@ -1223,7 +1235,7 @@ warnings_filters_mutated_lock_held_impl(PyObject *module)
assert(st != NULL);

// Note that the lock must be held by the caller.
if (!PyMutex_IsLocked(&st->lock.mutex)) {
if (!warnings_lock_held(st)) {
PyErr_SetString(PyExc_RuntimeError, "warnings lock is not held");
return NULL;
}
Expand Down Expand Up @@ -1347,15 +1359,10 @@ PyErr_WarnExplicitObject(PyObject *category, PyObject *message,
return -1;
}

#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(tstate->interp);
assert(st != NULL);
#endif

_PyRecursiveMutex_Lock(&st->lock);
warnings_lock(tstate->interp);
res = warn_explicit(tstate, category, message, filename, lineno,
module, registry, NULL, NULL);
_PyRecursiveMutex_Unlock(&st->lock);
warnings_unlock(tstate->interp);
if (res == NULL)
return -1;
Py_DECREF(res);
Expand Down Expand Up @@ -1420,15 +1427,10 @@ PyErr_WarnExplicitFormat(PyObject *category,
PyObject *res;
PyThreadState *tstate = get_current_tstate();
if (tstate != NULL) {
#ifdef Py_GIL_DISABLED
WarningsState *st = warnings_get_state(tstate->interp);
assert(st != NULL);
#endif

_PyRecursiveMutex_Lock(&st->lock);
warnings_lock(tstate->interp);
res = warn_explicit(tstate, category, message, filename, lineno,
module, registry, NULL, NULL);
_PyRecursiveMutex_Unlock(&st->lock);
warnings_unlock(tstate->interp);
Py_DECREF(message);
if (res != NULL) {
Py_DECREF(res);
Expand Down