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

Fix potential deadlock in health streamer #17261

Merged

Conversation

GuptaManan100
Copy link
Member

Description

While we fixed a couple of deadlocks in #17230, one was left pending. It was found while testing for deadlocks in #17238.

The deadlock is similar to the ones fixed in #17230, it was occurring between MakePrimary and the reload. The fix employed is to let go of the lock once it is not required instead of defering its unlocking.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Manan Gupta <manan@planetscale.com>
Copy link
Contributor

vitess-bot bot commented Nov 20, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Nov 20, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Nov 20, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 20, 2024
Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.39%. Comparing base (2c6e053) to head (eadb128).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17261   +/-   ##
=======================================
  Coverage   67.39%   67.39%           
=======================================
  Files        1570     1573    +3     
  Lines      252970   253060   +90     
=======================================
+ Hits       170484   170559   +75     
- Misses      82486    82501   +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@mdlayher
Copy link
Member

If we're able, you could consider swapping this for the fairly new atomic.Bool in Go to eliminate this lock all together!

@arthurschreiber
Copy link
Contributor

arthurschreiber commented Nov 20, 2024

If we're able, you could consider swapping this for the fairly new atomic.Bool in Go to eliminate this lock all together!

I don't think that's possible here, because we depend on a consistent view over multiple fields (isServingPrimary, state).

Copy link
Contributor

@arthurschreiber arthurschreiber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mdlayher
Copy link
Member

mdlayher commented Nov 20, 2024

If a consistent view over multiple fields is necessary then https://pkg.go.dev/sync/atomic#Pointer with a struct is also an option. No strong feelings, just wanted to offer a suggestion to eliminate the lock.

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@GuptaManan100 GuptaManan100 merged commit 0b51839 into vitessio:main Nov 21, 2024
111 of 114 checks passed
@GuptaManan100 GuptaManan100 deleted the fix-healthstreamer-deadlock branch November 21, 2024 06:37
vitess-bot pushed a commit that referenced this pull request Nov 21, 2024
Signed-off-by: Manan Gupta <manan@planetscale.com>
vitess-bot pushed a commit that referenced this pull request Nov 21, 2024
Signed-off-by: Manan Gupta <manan@planetscale.com>
vitess-bot pushed a commit that referenced this pull request Nov 21, 2024
Signed-off-by: Manan Gupta <manan@planetscale.com>
GuptaManan100 pushed a commit that referenced this pull request Nov 21, 2024
…7269)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
GuptaManan100 pushed a commit that referenced this pull request Nov 21, 2024
…7268)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
GuptaManan100 pushed a commit that referenced this pull request Nov 21, 2024
…7270)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
rvrangel pushed a commit to rvrangel/vitess that referenced this pull request Nov 21, 2024
Signed-off-by: Manan Gupta <manan@planetscale.com>
rvrangel pushed a commit to rvrangel/vitess that referenced this pull request Nov 21, 2024
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 Component: VTTablet Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants