Added exception translator specific mutex used with try_translate_exceptions (#5362)

* Added exception translator specific mutex used with try_translate_exceptions
Fixes #5346

* - Replaced with_internals_for_exception_translator by with_exception_translators
- Incremented PYBIND11_INTERNALS_VERSION
- Added a test

* style: pre-commit fixes

* Fixed formatting and added explicit to ctors

* Addressed PR review comments

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
vfdev 2024-09-17 18:47:20 +02:00 committed by GitHub
parent a7910be630
commit 1d9483ff73
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 96 additions and 21 deletions

View File

@ -50,12 +50,12 @@ inline void try_translate_exceptions() {
- delegate translation to the next translator by throwing a new type of exception. - delegate translation to the next translator by throwing a new type of exception.
*/ */
bool handled = with_internals([&](internals &internals) { bool handled = with_exception_translators(
auto &local_exception_translators = get_local_internals().registered_exception_translators; [&](std::forward_list<ExceptionTranslator> &exception_translators,
std::forward_list<ExceptionTranslator> &local_exception_translators) {
if (detail::apply_exception_translators(local_exception_translators)) { if (detail::apply_exception_translators(local_exception_translators)) {
return true; return true;
} }
auto &exception_translators = internals.registered_exception_translators;
if (detail::apply_exception_translators(exception_translators)) { if (detail::apply_exception_translators(exception_translators)) {
return true; return true;
} }

View File

@ -39,7 +39,11 @@
# if PY_VERSION_HEX >= 0x030C0000 || defined(_MSC_VER) # if PY_VERSION_HEX >= 0x030C0000 || defined(_MSC_VER)
// Version bump for Python 3.12+, before first 3.12 beta release. // Version bump for Python 3.12+, before first 3.12 beta release.
// Version bump for MSVC piggy-backed on PR #4779. See comments there. // Version bump for MSVC piggy-backed on PR #4779. See comments there.
# ifdef Py_GIL_DISABLED
# define PYBIND11_INTERNALS_VERSION 6
# else
# define PYBIND11_INTERNALS_VERSION 5 # define PYBIND11_INTERNALS_VERSION 5
# endif
# else # else
# define PYBIND11_INTERNALS_VERSION 4 # define PYBIND11_INTERNALS_VERSION 4
# endif # endif
@ -177,6 +181,7 @@ static_assert(sizeof(instance_map_shard) % 64 == 0,
struct internals { struct internals {
#ifdef Py_GIL_DISABLED #ifdef Py_GIL_DISABLED
pymutex mutex; pymutex mutex;
pymutex exception_translator_mutex;
#endif #endif
// std::type_index -> pybind11's type information // std::type_index -> pybind11's type information
type_map<type_info *> registered_types_cpp; type_map<type_info *> registered_types_cpp;
@ -643,6 +648,19 @@ inline auto with_internals(const F &cb) -> decltype(cb(get_internals())) {
return cb(internals); return cb(internals);
} }
template <typename F>
inline auto with_exception_translators(const F &cb)
-> decltype(cb(get_internals().registered_exception_translators,
get_local_internals().registered_exception_translators)) {
auto &internals = get_internals();
#ifdef Py_GIL_DISABLED
std::unique_lock<pymutex> lock((internals).exception_translator_mutex);
#endif
auto &local_internals = get_local_internals();
return cb(internals.registered_exception_translators,
local_internals.registered_exception_translators);
}
inline std::uint64_t mix64(std::uint64_t z) { inline std::uint64_t mix64(std::uint64_t z) {
// David Stafford's variant 13 of the MurmurHash3 finalizer popularized // David Stafford's variant 13 of the MurmurHash3 finalizer popularized
// by the SplitMix PRNG. // by the SplitMix PRNG.

View File

@ -2586,9 +2586,11 @@ void implicitly_convertible() {
} }
inline void register_exception_translator(ExceptionTranslator &&translator) { inline void register_exception_translator(ExceptionTranslator &&translator) {
detail::with_internals([&](detail::internals &internals) { detail::with_exception_translators(
internals.registered_exception_translators.push_front( [&](std::forward_list<ExceptionTranslator> &exception_translators,
std::forward<ExceptionTranslator>(translator)); std::forward_list<ExceptionTranslator> &local_exception_translators) {
(void) local_exception_translators;
exception_translators.push_front(std::forward<ExceptionTranslator>(translator));
}); });
} }
@ -2599,10 +2601,11 @@ inline void register_exception_translator(ExceptionTranslator &&translator) {
* the exception. * the exception.
*/ */
inline void register_local_exception_translator(ExceptionTranslator &&translator) { inline void register_local_exception_translator(ExceptionTranslator &&translator) {
detail::with_internals([&](detail::internals &internals) { detail::with_exception_translators(
(void) internals; [&](std::forward_list<ExceptionTranslator> &exception_translators,
detail::get_local_internals().registered_exception_translators.push_front( std::forward_list<ExceptionTranslator> &local_exception_translators) {
std::forward<ExceptionTranslator>(translator)); (void) exception_translators;
local_exception_translators.push_front(std::forward<ExceptionTranslator>(translator));
}); });
} }

View File

@ -0,0 +1,10 @@
from __future__ import annotations
class PythonMyException7(Exception):
def __init__(self, message):
self.message = message
super().__init__(message)
def __str__(self):
return "[PythonMyException7]: " + self.message.a

View File

@ -111,6 +111,16 @@ struct PythonAlreadySetInDestructor {
py::str s; py::str s;
}; };
struct CustomData {
explicit CustomData(const std::string &a) : a(a) {}
std::string a;
};
struct MyException7 {
explicit MyException7(const CustomData &message) : message(message) {}
CustomData message;
};
TEST_SUBMODULE(exceptions, m) { TEST_SUBMODULE(exceptions, m) {
m.def("throw_std_exception", m.def("throw_std_exception",
[]() { throw std::runtime_error("This exception was intentionally thrown."); }); []() { throw std::runtime_error("This exception was intentionally thrown."); });
@ -385,4 +395,33 @@ TEST_SUBMODULE(exceptions, m) {
// m.def("pass_exception_void", [](const py::exception<void>&) {}); // Does not compile. // m.def("pass_exception_void", [](const py::exception<void>&) {}); // Does not compile.
m.def("return_exception_void", []() { return py::exception<void>(); }); m.def("return_exception_void", []() { return py::exception<void>(); });
m.def("throws7", []() {
auto data = CustomData("abc");
throw MyException7(data);
});
py::class_<CustomData>(m, "CustomData", py::module_local())
.def(py::init<const std::string &>())
.def_readwrite("a", &CustomData::a);
PYBIND11_CONSTINIT static py::gil_safe_call_once_and_store<py::object>
PythonMyException7_storage;
PythonMyException7_storage.call_once_and_store_result([&]() {
auto mod = py::module_::import("custom_exceptions");
py::object obj = mod.attr("PythonMyException7");
return obj;
});
py::register_local_exception_translator([](std::exception_ptr p) {
try {
if (p) {
std::rethrow_exception(p);
}
} catch (const MyException7 &e) {
auto exc_type = PythonMyException7_storage.get_stored();
py::object exc_inst = exc_type(e.message);
PyErr_SetObject(PyExc_Exception, exc_inst.ptr());
}
});
} }

View File

@ -3,6 +3,7 @@ from __future__ import annotations
import sys import sys
import pytest import pytest
from custom_exceptions import PythonMyException7
import env import env
import pybind11_cross_module_tests as cm import pybind11_cross_module_tests as cm
@ -195,6 +196,10 @@ def test_custom(msg):
raise RuntimeError("Exception error: caught child from parent") from err raise RuntimeError("Exception error: caught child from parent") from err
assert msg(excinfo.value) == "this is a helper-defined translated exception" assert msg(excinfo.value) == "this is a helper-defined translated exception"
with pytest.raises(PythonMyException7) as excinfo:
m.throws7()
assert msg(excinfo.value) == "[PythonMyException7]: abc"
def test_nested_throws(capture): def test_nested_throws(capture):
"""Tests nested (e.g. C++ -> Python -> C++) exception handling""" """Tests nested (e.g. C++ -> Python -> C++) exception handling"""