[Cherry-pick][Streaming Generator] Fix a reference leak when a stream is deleted w… #35707
Conversation
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
…ith out of order writes. (ray-project#35591) Currently, when we delete the ObjectRefStream, we have the following logics. Keeps reading the next references If it reaches EoF, finish reading it. If there's no next index, finish reading it. Since all these unconsumed objects have a local reference we call RemoveLocalReferences to remove references. This doesn't work well when the items are written in out of order, For example, see the following example. Write (index 1) -> Delete -> Write (index 0). In this case, Delete thinks there's no references in the stream because it checks index 0 and found there's no references. It stops reading the stream. This works when the ordering of write is ensured, but not when it is not. This PR fixes the issue by instead reading all unconsumed references via GetItemsUnconsumed API. This API will return every references that are not read yet. When the references are written out of order,
zhe-thoughts
approved these changes
May 24, 2023
There was a problem hiding this comment.
Let's pick and be careful of issues. cc @ArturNiederfahrenhorst and @can-anyscale
This was referenced May 25, 2023
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.
…ith out of order writes. (#35591)
Currently, when we delete the ObjectRefStream, we have the following logics.
Keeps reading the next references
If it reaches EoF, finish reading it.
If there's no next index, finish reading it.
Since all these unconsumed objects have a local reference we call RemoveLocalReferences to remove references. This doesn't work well when the items are written in out of order, For example, see the following example.
Write (index 1) -> Delete -> Write (index 0). In this case, Delete thinks there's no references in the stream because it checks index 0 and found there's no references. It stops reading the stream. This works when the ordering of write is ensured, but not when it is not.
This PR fixes the issue by instead reading all unconsumed references via GetItemsUnconsumed API. This API will return every references that are not read yet.
When the references are written out of order,
Why are these changes needed?
Related issue number
#35634
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.