Use runner internal secondary shutdown for runner tasks to avoid deadlock#2799
Open
theodorebugnet wants to merge 1 commit intodevfrom
Open
Use runner internal secondary shutdown for runner tasks to avoid deadlock#2799theodorebugnet wants to merge 1 commit intodevfrom
theodorebugnet wants to merge 1 commit intodevfrom
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
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.
Description
The runner uses an internal secondary shutdown receiver, and when the stop height is reached, the loop in
run_in_process()breaks and sends a signal to the secondary channel; the runner then awaits all of its background handles. Two of the background tasks were not listening to this secondary shutdown: sync status updater and finalized block prefetcher. So if these tasks were running and busy, the runner could get into a deadlock and hang indefinitely.This PR changes them to listen to the secondary channel, so they get cleaned up whenever the runner signals shutdown. It also adds a test which successfully deadlocks if the changes in
runner.rsare reverted.I have updatedCHANGELOG.mdwith a new entry if my PR makes any breaking changes or fixes a bug. If my PR removes a feature or changes its behavior, I provide help for users on how to migrate to the new behavior.I have carefully reviewed all myCargo.tomlchanges before opening the PRs. (Are all new dependencies necessary? Is any module dependency leaked into the full-node (hint: it shouldn't)?)Linked Issues
Testing
Describe how these changes were tested. If you've added new features, have you added unit tests?
Docs
Describe where this code is documented. If it changes a documented interface, have the docs been updated?
Rendered docs are available at
https://sovlabs-ci-rustdoc-artifacts.us-east-1.amazonaws.com/<BRANCH_NAME>/index.html