write::BzDecoder: Fix infinite loop on drop when no data is read or written #118
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
…ritten If writes to the BzDecoder end before it has been fed the entire stream and the output buffer has already been flushed to the wrapped writer, then the Drop implementation will loop forever. On drop, try_finish() is called, which repeatedly tries to write() until BZ_STREAM_END is returned or an error occurs, but neither scenario happens if there's no input nor output data to process. This commit makes try_finish() return an UnexpectedEof error in this scenario. Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
folkertdev
reviewed
Dec 16, 2024
| let _ = self.write(&[])?; | ||
| // The write is effectively a `self.flush()`, but we want to know how many | ||
| // bytes were written. exit if no input was read and no output was written | ||
| if self.write(&[])? == 0 { |
There was a problem hiding this comment.
I removed the self.total_in() == read_before check here because on self.write(&[])? there is no way (unless I'm really missing something) that total_in could change: that empty input buffer is handed to decompress_vec, which ultimately calls BZ2_bzDecompress with an empty input buffer. total_in will not change in that case, how could it?
bjorn3
approved these changes
Dec 16, 2024
|
Thanks for improving the PR and merging it! |
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.
If writes to the
BzDecoderend before it has been fed the entire stream and the output buffer has already been flushed to the wrapped writer, then theDropimplementation will loop forever. On drop,try_finish()is called, which repeatedly tries towrite()untilBZ_STREAM_ENDis returned or an error occurs, but neither scenario happens if there's no input nor output data to process.This commit makes
try_finish()return anUnexpectedEoferror in this scenario.(Also, really happy to see this library found a new maintainer!)