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

Implement lock striping for cmap #1053

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Implement lock striping for cmap #1053

merged 1 commit into from
Oct 28, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Oct 28, 2024

What this PR does / why we need it:

Implement lock striping for cmap

This change introduces lock striping to improve concurrent map performance by
reducing lock contention. Instead of using a single lock for the entire map,
the implementation divides the map into shards, each with its own lock,
allowing for better parallelism and throughput in concurrent operations.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Enhanced concurrency for the map structure, allowing for improved performance during simultaneous access.
    • Introduced sharding for more efficient data management.
  • Bug Fixes

    • Reduced contention issues by updating locking mechanisms for operations on the map.
  • Documentation

    • Updated function signatures for clarity and consistency.

This change introduces lock striping to improve concurrent map performance by
reducing lock contention. Instead of using a single lock for the entire map,
the implementation divides the map into shards, each with its own lock,
allowing for better parallelism and throughput in concurrent operations.
Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes in this pull request significantly modify the Map structure in the cmap package, shifting from a single mutex-protected map to a concurrent map that employs sharding for better performance. A constant for the number of shards is introduced, along with a new shard type that encapsulates a mutex and a map. The Map type is updated to include an array of these shards, and various methods are adjusted to lock only the relevant shard instead of the entire map, enhancing concurrency.

Changes

File Change Summary
pkg/cmap/cmap.go Introduced const numShards = 32 and type shard[K comparable, V any] struct. Updated Map to include an array of shards. Modified New function to initialize shards. Added shardForKey and shardOf methods. Updated locking in Set, Upsert, Get, Delete, Has, Len, Keys, and Values methods. Renamed parameter in UpsertFunc from valueInMap to value.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Map
    participant Shard

    Client->>Map: Set(key, value)
    Map->>Shard: shardForKey(key)
    Shard->>Shard: Lock()
    Shard->>Shard: Store value
    Shard->>Map: Unlock()
    Map->>Client: Acknowledge
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

Attention: Patch coverage is 81.81818% with 14 lines in your changes missing coverage. Please review.

Project coverage is 46.76%. Comparing base (553e240) to head (9dcf72d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
pkg/cmap/cmap.go 81.81% 13 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1053      +/-   ##
==========================================
+ Coverage   46.66%   46.76%   +0.09%     
==========================================
  Files          82       82              
  Lines       11959    12001      +42     
==========================================
+ Hits         5581     5612      +31     
- Misses       5816     5826      +10     
- Partials      562      563       +1     

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

@hackerwins hackerwins marked this pull request as ready for review October 28, 2024 00:35
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 553e240 and 9dcf72d.

📒 Files selected for processing (1)
  • pkg/cmap/cmap.go (2 hunks)
🧰 Additional context used
🪛 golangci-lint
pkg/cmap/cmap.go

[high] 60-60: G115: integer overflow conversion int -> uint32

(gosec)

pkg/cmap/cmap.go Show resolved Hide resolved
pkg/cmap/cmap.go Show resolved Hide resolved
pkg/cmap/cmap.go Show resolved Hide resolved
pkg/cmap/cmap.go Show resolved Hide resolved
@hackerwins hackerwins merged commit c776ae1 into main Oct 28, 2024
5 checks passed
@hackerwins hackerwins deleted the lock-striping branch October 28, 2024 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant