peer: ensure the version negotiation goroutine will always exit #1228
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
In this commit, we patch a goroutine leak within the peer struct. This goroutine leak can happen, if the remote side fails to actually finish negotiation the protocol before our timeout ticker ticks. In this case, the goroutine will be blocked on a send, as the channel is unfired. An example trace from a btcd node I had on testnet showed: ``` 3183 @ 0x42e78a 0x42e83e 0x40540b 0x4051a5 0x872f76 0x45bfc1 ``` So, all instances of the goroutine failing to exit due to the remote peer not finishing the p2p version negotiation handshake. Our fix is simple: make the `negotiateErr' channel unbuffered. With this simple change, we ensure that the goroutine will always exit even in the case that the parent goroutine exists due to a timeout. # Please enter the commit message for your changes. Lines starting
jrick
approved these changes
Jul 22, 2018
|
(see decred/dcrd#909, where this exact same improvement was found and applied) |
|
Thanks! When trying to track down an issue (related to |
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.
In this commit, we patch a goroutine leak within the peer struct. This
goroutine leak can happen, if the remote side fails to actually finish
negotiation the protocol before our timeout ticker ticks. In this case,
the goroutine will be blocked on a send, as the channel is unfired. An
example trace from a btcd node I had on testnet showed:
So, all instances of the goroutine failing to exit due to the remote
peer not finishing the p2p version negotiation handshake.
Our fix is simple: make the `negotiateErr' channel unbuffered. With this
simple change, we ensure that the goroutine will always exit even in the
case that the parent goroutine exists due to a timeout. # Please enter
the commit message for your changes. Lines starting