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

refactor(storage): make HummockVersion a generic struct #18478

Merged
merged 3 commits into from
Sep 12, 2024

Conversation

zwang28
Copy link
Contributor

@zwang28 zwang28 commented Sep 10, 2024

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

What's changed and what's your intention?

The in-memory HummockVersion struct has many interdependent sub types, e.g. Levels, EpochNewChangeLog, etc.
There're cases we want a similar HummockVersion struct but with only the SstableInfo replaced. For instance, storing either SstableId or Arc<SstableInfo> instead of SstableInfo can significantly reduce the memory footprint.

This pull request introduces a generic parameter to HummockVersion, allowing the use of SstableInfo to be replaced with a more flexible type. All original types XX are made generic and renamed to XXCommon<T>.

Current there're two concrete types:

  • HummockVersionCommon<SstableInfo>, alias HummockVersion;
  • HummockVersionCommon<SstableIdInVersion>, which is used by time travel.

To introduce a new type, just implement From trait. Check out time_travel.rs for example.

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
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.

LGTM

pub struct SstableIdInVersion(HummockSstableId);

impl From<&SstableIdInVersion> for PbSstableInfo {
fn from(sst_id: &SstableIdInVersion) -> Self {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Conversion between PbSstableInfo and SstableIdInVersion is lossy. We should make sure it will not be misused.

@zwang28 zwang28 added this pull request to the merge queue Sep 12, 2024
Merged via the queue into main with commit 4afcd4d Sep 12, 2024
34 of 35 checks passed
@zwang28 zwang28 deleted the wangzheng/recent_hummock_version branch September 12, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants