Fix deadlock when writing more bytes to stream buffer than it's size #94
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
Add necessary checks when sending data to the stream/message buffer in order to avoid a task deadlock when attempting to write a longer stream/message than the underlying buffer can write.
simonbeaudoin0935
changed the title
n9wxu
approved these changes
Aug 10, 2020
Contributor
n9wxu
left a comment
n9wxu
left a comment
There was a problem hiding this comment.
This change only affects the situation where too much is written to the buffer. All current working code should be unaffected by this change.
Contributor
Author
Exactly |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
xStreamBufferSend deadlock avoidance when sending too much data
Description
Add necessary checks when sending data to the stream/message buffer in order to avoid a task deadlock when attempting to write a longer stream/message than the underlying buffer can write.
In the case of the stream buffer, if the user tries to write more bytes than supported, the added code will truncate the stream and adapt the 'xRequiredSpace' variable to the size of the buffer. The user will be able to deal with this scenario by wrapping the call to 'xStreamBufferSend' in appropriate looping code.
In the case of the message buffer, as opposed to stream buffer, there is no choice but to write the whole message (plus a uint32_t for it's length). In this case, the added code will do that 0 will be returned.
A possible touch up to this pull request would be an added error return code for that scenario.
Nevertheless, the deadlock is avoided in both case.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.