Backport of grpc: fix data race in balancer registration into release/1.15.x#17351
Merged
boxofrad merged 3 commits intorelease/1.15.xfrom May 15, 2023
Conversation
hc-github-team-consul-core
force-pushed
the
backport/boxofrad/thread-safe-balancer-register/strongly-new-jackal
branch
2 times, most recently
from
fd63a22 to
85fbc59
Compare
|
|
github-team-consul-core-pr-approver
approved these changes
May 15, 2023
Collaborator
github-team-consul-core-pr-approver
left a comment
github-team-consul-core-pr-approver
left a comment
There was a problem hiding this comment.
Auto approved Consul Bot automated PR
Registering gRPC balancers is thread-unsafe because they are stored in a global map variable that is accessed without holding a lock. Therefore, it's expected that balancers are registered _once_ at the beginning of your program (e.g. in a package `init` function) and certainly not after you've started dialing connections, etc. > NOTE: this function must only be called during initialization time > (i.e. in an init() function), and is not thread-safe. While this is fine for us in production, it's challenging for tests that spin up multiple agents in-memory. We currently register a balancer per- agent which holds agent-specific state that cannot safely be shared. This commit introduces our own registry that _is_ thread-safe, and implements the Builder interface such that we can call gRPC's `Register` method once, on start-up. It uses the same pattern as our resolver registry where we use the dial target's host (aka "authority"), which is unique per-agent, to determine which builder to use.
boxofrad
force-pushed
the
backport/boxofrad/thread-safe-balancer-register/strongly-new-jackal
branch
from
daf53d0 to
b9cdc79
Compare
boxofrad
deleted the
backport/boxofrad/thread-safe-balancer-register/strongly-new-jackal
branch
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
4 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.
Backport
This PR is auto-generated from #16229 to be assessed for backporting due to the inclusion of the label backport/1.15.
🚨
The person who merged in the original PR is:
@boxofrad
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.
The below text is copied from the body of the original PR.
Description
Registering gRPC balancers is thread-unsafe because they are stored in a global map variable that is accessed without holding a lock. Therefore, it's expected that balancers are registered once at the beginning of your program (e.g. in a package
initfunction) and certainly not after you've started dialing connections, etc.While this is fine for us in production, it's challenging for tests that spin up multiple agents in-memory. We currently register a balancer per-agent which holds agent-specific state that cannot safely be shared.
This commit introduces our own registry that is thread-safe, and implements the
Builderinterface such that we can call gRPC'sRegistermethod once, on start-up. It uses the same pattern as our resolver registry where we use the dial target's host (aka "authority"), which is unique per-agent, to determine which builder to use.Overview of commits