-
Notifications
You must be signed in to change notification settings - Fork 276
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
Open
AmalDevHaridevan
wants to merge
8
commits into
gazebosim:gz-sim9
Choose a base branch
from
AmalDevHaridevan:Amal-python-system-GIL
base: gz-sim9
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
29598fd
Fixed GIL release issue with Python System and Python TestFixture. Si…
AmalDevHaridevan 334b432
Update python/test/python_system_TEST.py
AmalDevHaridevan 8aff92f
Update python_system_TEST.py
AmalDevHaridevan 9df6542
Update gravity.sdf
AmalDevHaridevan ccf90c5
Merge branch 'gz-sim9' into Amal-python-system-GIL
AmalDevHaridevan 1d01094
Merge branch 'gz-sim9' into Amal-python-system-GIL
AmalDevHaridevan 26f69d8
Merge branch 'gz-sim9' into Amal-python-system-GIL
AmalDevHaridevan b5f7862
Merge branch 'gz-sim9' into Amal-python-system-GIL
AmalDevHaridevan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
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, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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 comment
The 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:
src/gz-sim/python/test/testFixture_TEST.Py
src/gz-sim/python/test/python_system_TEST.py
src/gz-sim/python/test/gravity.sdf
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:
python testFixture_TEST.py
and the output was as follows: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.
Since
GIL
is required to run the Python interpreter, this could potentially cause this problem. Based on this assumption, I made the modification by explicitly acquiring and releasingGIL
so that interpreter is not simultaneously used.This is the result of running
python testFixture_TEST.py
after my proposed modifications: