Skip to content

Fix deadlock in embedded pipelines on python 3.8+ that didn't occur in 3.6 #1838

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

Open
mattdawkins wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix deadlock in embedded pipelines on python 3.8+ that didn't occur in 3.6 #1838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 23 additions & 11 deletions python/kwiver/sprokit/adapters/embedded_pipeline.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,29 +55,41 @@ PYBIND11_MODULE(embedded_pipeline, m)
ksp::embedded_pipeline_trampoline> ep(m, "EmbeddedPipeline");
ep.def(init<>())
.def("build_pipeline", &ksp::build_pipeline,
call_guard<kwiver::vital::python::gil_scoped_release>(),
arg("desc_file"),
arg("def_dir") = "")
.def("send", &kwiver::embedded_pipeline::send)
.def("send_end_of_input", &kwiver::embedded_pipeline::send_end_of_input)
.def("receive", &kwiver::embedded_pipeline::receive)
.def("full", &kwiver::embedded_pipeline::full)
.def("empty", &kwiver::embedded_pipeline::empty)
.def("send", &kwiver::embedded_pipeline::send,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("send_end_of_input", &kwiver::embedded_pipeline::send_end_of_input,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("receive", &kwiver::embedded_pipeline::receive,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("full", &kwiver::embedded_pipeline::full,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("empty", &kwiver::embedded_pipeline::empty,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("at_end", &kwiver::embedded_pipeline::at_end)
.def("start", &kwiver::embedded_pipeline::start)
.def("wait", &kwiver::embedded_pipeline::wait)
.def("stop", &kwiver::embedded_pipeline::stop)
.def("start", &kwiver::embedded_pipeline::start,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("wait", &kwiver::embedded_pipeline::wait,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("stop", &kwiver::embedded_pipeline::stop,
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("input_port_names", &kwiver::embedded_pipeline::input_port_names)
.def("output_port_names", &kwiver::embedded_pipeline::output_port_names)
.def("input_adapter_connected",
&ksp::wrap_embedded_pipeline::input_adapter_connected)
.def("output_adapter_connected",
&ksp::wrap_embedded_pipeline::output_adapter_connected)
.def("connect_input_adapter",
static_cast<bool (kwiver::embedded_pipeline::*)()>(&ksp::wrap_embedded_pipeline::connect_input_adapter))
static_cast<bool (kwiver::embedded_pipeline::*)()>(&ksp::wrap_embedded_pipeline::connect_input_adapter),
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("connect_output_adapter",
static_cast<bool (kwiver::embedded_pipeline::*)()>(&ksp::wrap_embedded_pipeline::connect_output_adapter))
static_cast<bool (kwiver::embedded_pipeline::*)()>(&ksp::wrap_embedded_pipeline::connect_output_adapter),
call_guard<kwiver::vital::python::gil_scoped_release>())
.def("update_config",
static_cast<void (kwiver::embedded_pipeline::*)(kwiver::vital::config_block_sptr)>(&ksp::wrap_embedded_pipeline::update_config))
static_cast<void (kwiver::embedded_pipeline::*)(kwiver::vital::config_block_sptr)>(&ksp::wrap_embedded_pipeline::update_config),
call_guard<kwiver::vital::python::gil_scoped_release>())
;
ep.doc() = R"(
Python bindings for kwiver::embedded_pipeline
Expand Down
20 changes: 13 additions & 7 deletions python/kwiver/vital/modules/module_helpers.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ namespace py = pybind11;
*/
void check_and_initialize_python_interpretor()
{
static bool initialized = false;

// Check if a python interpreter already exists so we don't clobber sys.argv
// (e.g. if sprokit is initialized from python)
if (!Py_IsInitialized())
Expand All @@ -38,16 +40,20 @@ void check_and_initialize_python_interpretor()
// Set Python interpeter attribute: sys.argv = []
// parameters are: (argc, argv, updatepath)
PySys_SetArgvEx(0, NULL, 0);
}

if (!PyEval_ThreadsInitialized())
{
// In Python 3.7+, threads are always initialized after Py_Initialize(),
// so PyEval_ThreadsInitialized() always returns true. We need to
// initialize pybind11 internals and release the GIL ourselves.
if (!initialized)
{
// Let pybind11 initialize threads and set up its internal data structures
pybind11::detail::get_internals();
initialized = true;
{
// Let pybind11 initialize threads and set up its internal data structures
pybind11::detail::get_internals();
}
// Release the GIL so other threads can acquire it
PyEval_SaveThread();
}
// Release the GIL
PyEval_SaveThread();
}
}

Expand Down