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(storage): fix race between deregister read version and clear shared buffer #15738

Merged
merged 3 commits into from
Mar 18, 2024

Conversation

wenym1
Copy link
Contributor

@wenym1 wenym1 commented Mar 18, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Resolved the panic in #15703 (comment)

Currently we have an assertion that all read version must have been deregistered when calling clear shared buffer. Read version is deregistered via the drop method of LocalInstanceGuard, which sends a DestroyReadVersion event to event handler. In this way, we don't have to handle the send error when sending the newly created read version back to where made the RegisterReadVersion request.

However, in current code, the following execution flow may have remaining read version when handling clear shared buffer.

- local barrier manager receive build actor request and spawn to task to build actor
- when building actor, enqueue a `RegisterReadVersion` request to event handler channel
- local barrier manager receive a reset request, and then abort the build actor task, and then enqueue the `Clear` command to the event handler channel
- event handler handles the `RegisterReadVersion` request, and fail to send the newly created read version back to actor and return with send error.  `LocalInstanceGuard` is dropped and enqueue a `DestroyReadVersion` event to event handler.
- Since the `Clear` event is enqueued earlier than the `DestroyReadVersion` event, the event handler will handle the `Clear` event first, and then there is an existing read version and triggers the panic.

In this PR, we change to deregister the read version immediately when seeing the send error.

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Copy link
Contributor

@kwannoel kwannoel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

Copy link
Collaborator

@hzxa21 hzxa21 left a comment

Choose a reason for hiding this comment

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

Good catch!

@wenym1 wenym1 added this pull request to the merge queue Mar 18, 2024
Merged via the queue into main with commit 0e8d800 Mar 18, 2024
26 of 27 checks passed
@wenym1 wenym1 deleted the yiming/fix-read-version-destroy-race branch March 18, 2024 08:53
github-actions bot pushed a commit that referenced this pull request Mar 18, 2024
wenym1 added a commit that referenced this pull request Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/fix Bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants