Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-23.1: server: avoid a race in the server controller #108457

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Aug 9, 2023

Backport 1/1 commits from #108401 on behalf of @knz.

/cc @cockroachdb/release


Co-authored with @lidorcarmel

Prior to this patch, the Go race detector was complaining about racy concurrent accesses to serverStateUsingChannels.server, via (*serverStateUsingChannels) getServer() and (*channelOrchestrator) startControlledServer().

These racy accesses happened to be safe because the writes and reads to that field were correctly ordered around updates to an atomic bool (the started field). However, the race detector is not sufficiently sophisticated to detect this ordering and satisfy itself that the state transition can only happen once.

In order to silence the race detector (with no change in correctness), this patch replaces the atomic bool by a mutex, whose access semantics are properly understood by the race detector.

This change incidentally makes the code slightly easier to read and understand.

Supersedes #108371.
Fixes #107930.
Epic: CRDB-28893


Release justification: avoids test flakes

Prior to this patch, the Go race detector was complaining about racy
concurrent accesses to `serverStateUsingChannels.server`, via
`(*serverStateUsingChannels) getServer()` and `(*channelOrchestrator)
startControlledServer()`.

These racy accesses happened to be safe because the writes and reads
to that field were correctly ordered around updates to an atomic
bool (the `started` field). However, the race detector is not
sufficiently sophisticated to detect this ordering and satisfy itself
that the state transition can only happen once.

In order to silence the race detector (with no change in correctness),
this patch replaces the atomic bool by a mutex, whose access semantics
are properly understood by the race detector.

This change incidentally makes the code slightly easier to read and
understand.

Co-authored-by: Lidor Carmel <[email protected]>
@blathers-crl blathers-crl bot requested a review from a team as a code owner August 9, 2023 16:29
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-108401 branch from 779bf47 to aead4dd Compare August 9, 2023 16:29
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Aug 9, 2023
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-108401 branch from 574024e to f9b09ab Compare August 9, 2023 16:29
@blathers-crl
Copy link
Author

blathers-crl bot commented Aug 9, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl
Copy link
Author

blathers-crl bot commented Aug 9, 2023

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@knz knz merged commit 5e738e0 into release-23.1 Aug 9, 2023
@knz knz deleted the blathers/backport-release-23.1-108401 branch August 9, 2023 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants