Skip to content

perf: optimize usage of RWMutex in MCPServer for performance #181

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

Merged
merged 3 commits into from
Apr 25, 2025

Conversation

cryo-zd
Copy link
Contributor

@cryo-zd cryo-zd commented Apr 21, 2025

  Note that field capabilitiesMu is a RWMutex in MCPServer for controlling concurrent read/write operations to field capabilities.
 At most of time, capabilities 's members resource/tools/prompts/ will only be set not to be nil for one time when we call func NewMCPServer at the beginning or when we call func AddResource/AddResourceTemplate/AddPrompt/AddTools for the first time.
  So, for field capabilitiesMu, the number of its read operations far exceeds the number of write operations, for which we could utilize RLock and double-checking technique to optimizes the concurrency performance for the AddXxx functions mentioned above.
experiment
benchmark
benchmark2

Summary by CodeRabbit

  • Refactor
    • Enhanced internal performance and responsiveness when adding resources, templates, prompts, or tools. No changes to user-facing features or functionality.

Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

Walkthrough

This change updates the locking mechanism in the MCPServer struct methods responsible for adding resources, resource templates, prompts, and tools. Instead of always acquiring an exclusive lock to check and initialize capability fields, the code now uses a double-checked locking pattern: it first checks the field under a shared read lock, only escalating to an exclusive lock if initialization is required. This reduces the duration of exclusive lock holding on capabilitiesMu. No public API signatures were altered.

Changes

Files/Paths Change Summary
server/server.go Refactored locking in AddResource, AddResourceTemplate, AddPrompt, and AddTools to use double-checked locking with capabilitiesMu, reducing exclusive lock contention during capability initialization.

Possibly related PRs

  • Fix tool calls #38: Also modifies capability initialization in server.go, changing from eager to lazy initialization in the same methods affected by this PR.
  • Dustin/138 deadlock remove global mutex #139: Introduces and restructures mutex usage, including capabilitiesMu, which this PR further refines with double-checked locking.

📜 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 552c66f and 8706661.

📒 Files selected for processing (1)
  • server/server.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • server/server.go

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

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

@cryo-zd cryo-zd closed this Apr 22, 2025
@cryo-zd cryo-zd reopened this Apr 23, 2025
@cryo-zd cryo-zd changed the title refact: optimize usage of RWMutex in MCPServer for performance perf: optimize usage of RWMutex in MCPServer for performance Apr 23, 2025
@ezynda3 ezynda3 merged commit 341ebc5 into mark3labs:main Apr 25, 2025
3 checks passed
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.

2 participants