Fix Pipeline reference leak in PythonFunction. #5668
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Michal Zientkiewicz <[email protected]>
mzient
commented
Oct 8, 2024
Comment on lines
55
to
58
| if _Pipeline.current(): | ||
| self._pipeline = weakref.ref(_Pipeline.current()) | ||
| else: | ||
| self._pipeline = None |
There was a problem hiding this comment.
We do a very similar thing in ops._OperatorInstance.
|
CI MESSAGE: [19141292]: BUILD STARTED |
stiepan
approved these changes
Oct 8, 2024
szalpal
approved these changes
Oct 8, 2024
…ThreadPool. Signed-off-by: Michał Zientkiewicz <[email protected]>
mzient
commented
Oct 8, 2024
Comment on lines
-652
to
-673
| def verify_pipeline(pipeline, input): | ||
| assert pipeline is Pipeline.current() | ||
| return input | ||
|
|
||
|
|
||
| def test_current_pipeline(): | ||
| pipe1 = Pipeline(13, 4, 0) | ||
| with pipe1: | ||
| dummy = types.Constant(numpy.ones((1))) | ||
| output = fn.python_function(dummy, function=lambda inp: verify_pipeline(pipe1, inp)) | ||
| pipe1.set_outputs(output) | ||
|
|
||
| pipe2 = Pipeline(6, 2, 0) | ||
| with pipe2: | ||
| dummy = types.Constant(numpy.ones((1))) | ||
| output = fn.python_function(dummy, function=lambda inp: verify_pipeline(pipe2, inp)) | ||
| pipe2.set_outputs(output) | ||
|
|
||
| pipe1.build() | ||
| pipe2.build() | ||
| pipe1.run() | ||
| pipe2.run() |
There was a problem hiding this comment.
- It's illegal to capture the pipeline.
- Now there's a stub in pipeline.current - not the same object, so the test is invalid.
|
CI MESSAGE: [19155838]: BUILD STARTED |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
CI MESSAGE: [19155838]: BUILD FAILED |
|
CI MESSAGE: [19141292]: BUILD FAILED |
Signed-off-by: Michal Zientkiewicz <[email protected]>
|
CI MESSAGE: [19172437]: BUILD STARTED |
stiepan
approved these changes
Oct 9, 2024
szalpal
approved these changes
Oct 9, 2024
mdabek-nvidia
approved these changes
Oct 9, 2024
|
CI MESSAGE: [19172437]: BUILD PASSED |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Category:
Bug fix (non-breaking change which fixes an issue)
Description:
This PR removes a back-link from PythonFunction operator to the pipeline, which caused the pipeline to not be properly shut down and leaking resources.
For backward compatibility, a pipeline stub is exposed, carrying the same properties as the original pipeline, but with the native pipeline removed and functions depending on the native pipeline short-circuited to throw an exception.
Additional information:
Affected modules and functionalities:
PythonFunction and its flavors
It's officially illegal now to hold a reference to the Pipeline in PythonFunction's
function. Some tests that depended on that were removed.Key points relevant for the review:
N/A
Tests:
Checklist
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A