-
Notifications
You must be signed in to change notification settings - Fork 280
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.
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
Fixed GIL release issue with Python System and Python TestFixture. #2618
base: gz-sim9
Are you sure you want to change the base?
Changes from 5 commits
29598fd
334b432
8aff92f
9df6542
ccf90c5
1d01094
26f69d8
b5f7862
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -56,7 +56,14 @@ defineSimTestFixture(pybind11::object module) | |
[](TestFixture* self, std::function<void( | ||
const UpdateInfo &, EntityComponentManager &)> _cb) | ||
{ | ||
// Add explicit scoped acquire and release of GIL, so that Python Systems | ||
// can be executed | ||
// This acquire and release is only required from the PythonSystem code | ||
// However, adding this here may prevent undefined or unintended behaviors | ||
// in future | ||
pybind11::gil_scoped_acquire gil; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We have not run into this issue with our python systems in the examples. Are you doing something specific that's causing a problem? It would be great if we can pin down the actual problem There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi azeey, Yes. I will explain the issue in detail. The following files from my branch are required to reproduce the issue:
The goal is to run the Server in Python, with an SDF model that contains a Python system plugin. I executed the following command before my proposed modifications:
Specifically, the error is this:
I wasn't sure how to debug this issue, however, I realized that a probable issue could be the Python system and the Python TestFixture are most likely trying to simultaneously execute. This is the result of running
|
||
self->OnPreUpdate(_cb); | ||
pybind11::gil_scoped_release gilr; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this necessary? I thought the scoped lock above would automatically release when going out of scope |
||
} | ||
), | ||
pybind11::return_value_policy::reference, | ||
|
@@ -67,7 +74,9 @@ defineSimTestFixture(pybind11::object module) | |
[](TestFixture* self, std::function<void( | ||
const UpdateInfo &, EntityComponentManager &)> _cb) | ||
{ | ||
pybind11::gil_scoped_acquire gil; | ||
self->OnUpdate(_cb); | ||
pybind11::gil_scoped_release gilr; | ||
} | ||
), | ||
pybind11::return_value_policy::reference, | ||
|
@@ -78,7 +87,9 @@ defineSimTestFixture(pybind11::object module) | |
[](TestFixture* self, std::function<void( | ||
const UpdateInfo &, const EntityComponentManager &)> _cb) | ||
{ | ||
pybind11::gil_scoped_acquire gil; | ||
self->OnPostUpdate(_cb); | ||
pybind11::gil_scoped_release gilr; | ||
} | ||
), | ||
pybind11::return_value_policy::reference, | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would it be possible to use the |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
#!/usr/bin/env python3 | ||
# Copyright (C) 2024 Open Source Robotics Foundation | ||
|
||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
|
||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
from gz_test_deps.math import Vector3d | ||
from gz_test_deps.sim import Model, Link | ||
import random | ||
|
||
|
||
class TestSystem(object): | ||
def __init__(self): | ||
self.id = random.randint(1, 100) | ||
|
||
def configure(self, entity, sdf, ecm, event_mgr): | ||
self.model = Model(entity) | ||
self.link = Link(self.model.canonical_link(ecm)) | ||
print("Configured on", entity) | ||
print("sdf name:", sdf.get_name()) | ||
self.force = sdf.get_double("force") | ||
print(f"Applying {self.force} N on link {self.link.name(ecm)}") | ||
|
||
def pre_update(self, info, ecm): | ||
if info.paused: | ||
return | ||
|
||
if info.iterations % 3000 == 0: | ||
self.link.add_world_force( | ||
ecm, Vector3d(0, 0, self.force), | ||
Vector3d(random.random(), random.random(), 0)) | ||
|
||
|
||
def get_system(): | ||
return TestSystem() | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think need more |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -194,14 +194,21 @@ void PythonSystemLoader::CallPythonMethod(py::object _method, Args &&..._args) | |
void PythonSystemLoader::PreUpdate(const UpdateInfo &_info, | ||
EntityComponentManager &_ecm) | ||
{ | ||
// Add explicit scoped acquire and release of GIL, so that Python | ||
// Systems can be executed.This acquire and release is only required | ||
// from the PythonSystem code | ||
py::gil_scoped_acquire gil; | ||
CallPythonMethod(this->preUpdateMethod, _info, &_ecm); | ||
py::gil_scoped_release gilr; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not necessary since |
||
} | ||
|
||
////////////////////////////////////////////////// | ||
void PythonSystemLoader::Update(const UpdateInfo &_info, | ||
EntityComponentManager &_ecm) | ||
{ | ||
py::gil_scoped_acquire gil; | ||
CallPythonMethod(this->updateMethod, _info, &_ecm); | ||
py::gil_scoped_release gilr; | ||
} | ||
|
||
////////////////////////////////////////////////// | ||
|
@@ -210,6 +217,7 @@ void PythonSystemLoader::PostUpdate(const UpdateInfo &_info, | |
{ | ||
py::gil_scoped_acquire gil; | ||
CallPythonMethod(this->postUpdateMethod, _info, &_ecm); | ||
py::gil_scoped_release gilr; | ||
} | ||
////////////////////////////////////////////////// | ||
void PythonSystemLoader::Reset(const UpdateInfo &_info, | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we apply the changes in
PythonSystemLoader
, we shouldn't need any change in this file. Can you revert?