Skip to content

chore: refactor cur_tipset in MessagePool to use RwLock instead Mutex #5901

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.

Sign up for GitHub

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

Jump to bottom
Merged
LesnyRumcajs merged 1 commit into from
Aug 5, 2025
Merged

chore: refactor cur_tipset in MessagePool to use RwLock instead Mutex #5901

LesnyRumcajs merged 1 commit into from
Aug 5, 2025

Conversation

@hanabi1224
Copy link
Contributor

@hanabi1224 hanabi1224 commented Aug 5, 2025 •
edited by coderabbitai bot
Loading

Summary of changes

During invetigating #5812 I made some refactoring to the cur_tipset in MessagePool to use RwLock instead Mutex since there're quite a few read-only operations.

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Refactor
    • Improved concurrent access to the current tipset by switching from exclusive locking to a read-write lock, allowing multiple readers at once.
    • Introduced a new method for retrieving the current tipset, streamlining access across the application.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025 •
edited
Loading

Walkthrough

The changes refactor the synchronization mechanism for the cur_tipset shared state in the message pool module, replacing all uses of Mutex with RwLock (aliased as SyncRwLock). All accesses are updated accordingly, and a new current_tipset() method is introduced to provide read access. No other logic or error handling is modified.

Changes

Cohort / File(s) Change Summary
Message Pool Synchronization Refactor
src/message_pool/msgpool/mod.rs, src/message_pool/msgpool/msg_pool.rs, src/message_pool/msgpool/selection.rs		 Replaced Mutex with SyncRwLock for cur_tipset shared state, updated all lock acquisitions, and introduced current_tipset() method for read access.
RPC Gas Estimation Update
src/rpc/methods/gas.rs		 Updated to use current_tipset() instead of direct lock-and-clone on cur_tipset.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MessagePool
    participant Tipset

    Client->>MessagePool: current_tipset()
    MessagePool->>Tipset: (acquires RwLock read)
    MessagePool-->>Client: Arc<Tipset> clone
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • LesnyRumcajs

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6fa222b and b5bf7e2.

📒 Files selected for processing (4)
  • src/message_pool/msgpool/mod.rs (7 hunks)
  • src/message_pool/msgpool/msg_pool.rs (9 hunks)
  • src/message_pool/msgpool/selection.rs (1 hunks)
  • src/rpc/methods/gas.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: tests
  • GitHub Check: tests-release
  • GitHub Check: Build Ubuntu
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: Build MacOS
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: All lint checks
  • GitHub Check: Analyze (go)
  • GitHub Check: Analyze (rust)
🔇 Additional comments (14)
src/rpc/methods/gas.rs (1)

224-224: LGTM: Clean refactoring to use the new current_tipset() method.

The change correctly replaces direct mutex access with the new current_tipset() method, which internally uses a read lock on the RwLock. This improves both encapsulation and concurrency.

src/message_pool/msgpool/selection.rs (1)

293-293: LGTM: Consistent refactoring to use current_tipset() method.

The change properly replaces direct mutex access with the new method call, maintaining consistency with the RwLock refactoring across the message pool module.

src/message_pool/msgpool/msg_pool.rs (5)

35-35: LGTM: Required import for RwLock refactoring.

The import of parking_lot::RwLock as SyncRwLock is necessary for the refactoring and maintains consistency with the existing naming convention.

180-180: LGTM: Core refactoring from Mutex to RwLock.

The field type change from Mutex to SyncRwLock is the core of this refactoring, enabling multiple concurrent readers while maintaining exclusive write access. This should improve performance for frequent read operations on the current tipset.

205-208: LGTM: Well-designed accessor method.

The new current_tipset() method provides clean encapsulation of the RwLock access pattern. Using read() allows concurrent access while clone() gives callers their own Arc<Tipset> reference. The method name is clear and descriptive.

222-222: LGTM: Consistent method call replacements.

All these changes correctly replace direct field access with calls to the new current_tipset() method. The refactoring is applied consistently across different methods (push, add, add_helper, get_sequence, pending), improving encapsulation and maintainability.

Also applies to: 257-258, 326-326, 339-339, 384-384

477-477: LGTM: Proper RwLock initialization in constructor.

The constructor change correctly initializes the cur_tipset field with SyncRwLock::new() instead of Mutex::new(), maintaining the same initialization semantics while using the new synchronization primitive.

src/message_pool/msgpool/mod.rs (7)

24-24: LGTM!

The import of parking_lot::RwLock with alias SyncRwLock is appropriate for the refactoring from Mutex to RwLock. Using parking_lot provides better performance than the standard library's RwLock.

60-60: LGTM!

The function parameter type change from Mutex to SyncRwLock is consistent with the refactoring objective and maintains the same semantic contract.

68-68: LGTM!

The change from .lock() to .read() is correct for this read-only operation. This allows multiple concurrent readers to access the current tipset, improving performance as intended by the refactoring.

219-219: LGTM!

The function parameter type change is consistent with the refactoring and appropriate since head_change performs both read and write operations on cur_tipset.

230-230: LGTM!

Both write lock acquisitions are correct for these mutation operations. Using .write() provides the necessary exclusive access for updating the current tipset during head changes.

Also applies to: 269-269

279-279: LGTM!

The change to use .read() for this read-only operation is correct and allows for better concurrency. The clone operation appropriately provides an owned value for the function call.

619-619: LGTM!

The change to use mpool.current_tipset() method instead of direct lock access is excellent. This provides a cleaner API that encapsulates the RwLock implementation details and makes the code more maintainable.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hm/use-rwlock-for-mpool-ts
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

@hanabi1224 hanabi1224 force-pushed the hm/use-rwlock-for-mpool-ts branch from e609994 to b5bf7e2 Compare August 5, 2025 14:39
@hanabi1224 hanabi1224 marked this pull request as ready for review August 5, 2025 14:40
@hanabi1224 hanabi1224 requested a review from a team as a code owner August 5, 2025 14:40
@hanabi1224 hanabi1224 requested review from akaladarshi and elmattic and removed request for a team August 5, 2025 14:40
@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Aug 5, 2025
Merged via the queue into main with commit 905a93e Aug 5, 2025
47 checks passed
@hanabi1224 hanabi1224 deleted the hm/use-rwlock-for-mpool-ts branch August 5, 2025 17:52
sudo-shashank pushed a commit that referenced this pull request Aug 11, 2025
@hanabi1224 @sudo-shashank
chore: refactor cur_tipset in MessagePool to use RwLock instead Mutex (…
458c78a 
…#5901)
@coderabbitai coderabbitai bot mentioned this pull request Dec 8, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LesnyRumcajs LesnyRumcajs LesnyRumcajs approved these changes

@akaladarshi akaladarshi akaladarshi approved these changes

@elmattic elmattic Awaiting requested review from elmattic elmattic is a code owner automatically assigned from ChainSafe/forest

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hanabi1224 @LesnyRumcajs @akaladarshi