Skip to content

peer: replace the old cond based msgStream w/ BackpressureQueue[T] #9839

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

Open
wants to merge 3 commits into
base: backpressure-queue
Choose a base branch
from

Conversation

Roasbeef
Copy link
Member

In this commit, we replace the old condition variable based msgStream
with the new back pressure queue. The implementation details at this
abstraction level have been greatly simplified. For now we just pass a
predicate that'll never drop the incoming packets.

In a follow up commit, we then start to actually set a predicate to decide
when to drop incoming packets. We use two layers of predicates:

  • One that'll never drop certain protected message types
  • One that'll randomly drop packets starting at a threshold, before
    always dropping packets up to some other max threshold.

This is mostly a draft of some ideas I was kicking around the other day.
One other scenario to consider is: initial graph download. IGD well end up
sending 10s of thousands of messages to a remote peer so they can sync
to the graph. As is, we'll start to drop some of those messages if we aren't
able to process them quickly enough (unless the remote peer has implemented
a form of application-level flow control).

To patch that gap, we could consider never dropping if we're doing an IGD or
graph spot check with a peer. We can consult the gossip syncer for a given
peer to decide if we should drop or not (outside the protected set).

Initial Params

The Random Early Drop algo added takes two params: a min threshold,
and a max threshold. Here's a table that contains the probability of drop
with a queue size of 50, and two diff params for min+max threshold:

Queue Length (q) p_drop ([15,35]) p_drop ([10,40])
0 0 0
10 0 0
20 0.25 0.33
30 0.75 0.67
34 0.95 0.80
35 1.00 0.83
49 1.00 1.00

Roasbeef added 3 commits May 19, 2025 17:04
In this commit, we replace the old condition variable based msgStream
with the new back pressure queue. The implementation details at this
abstraction level have been greatly simplified. For now we just pass a
predicate that'll never drop the incoming packets.
The msgStream's backpressure queue previously used a drop predicate that
always returned false, meaning messages were never dropped based on
queue length.

This commit introduces a new drop predicate mechanism for the msgStream
queue, controlled by build tags.

For non-integration builds, the predicate combines a type-based check
with Random Early Detection (RED):

- Certain critical message types (`lnwire.LinkUpdater`,
  `lnwire.AnnounceSignatures1`) are marked as protected and are never
  dropped.

- For other message types, RED is applied based on the queue length,
  using `redMinThreshold` and `redMaxThreshold` to determine the drop
  probability.

For integration builds, the predicate always returns false, preserving
the previous behavior to avoid interfering with tests.

This change allows the msgStream queue to proactively drop less critical
messages under high load, preventing unbounded queue growth while
ensuring essential messages are prioritized.
@Roasbeef Roasbeef added enhancement Improvements to existing features / behaviour p2p Code related to the peer-to-peer behaviour resource usage Software resource usage improvements/issues labels May 20, 2025
Copy link
Contributor

coderabbitai bot commented May 20, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.
    • 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.
    • @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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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.

Copy link

Pull reviewers stats

Stats of the last 30 days for lnd:

User Total reviews Time to review Total comments
guggero
🥇
25
▀▀▀
23h 19m
49
▀▀▀
ziggie1984
🥈
12
16h 37m
35
▀▀
bhandras
🥉
11
4h 35m
13
yyforyongyu
11
1d 5h 12m
20
Roasbeef
6
9h 9m
4
bitromortac
5
1h 41m
6
ellemouton
4
1d 6h 20m
5
morehouse
2
7h 12m
1
mohamedawnallah
2
6d 14h 50m
▀▀
11
NishantBansal2003
2
5d 15h 32m
▀▀
0
ffranr
1
19m
0
sputn1ck
1
23h 39m
2
GeorgeTsagk
1
3d 36m
0
saubyk
1
20h 37m
0
MPins
1
8d 20h 40m
▀▀▀
4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing features / behaviour p2p Code related to the peer-to-peer behaviour resource usage Software resource usage improvements/issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant