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

Fix deadlock when handling bad calls to batch_funding.._generated #2841

Merged

Conversation

TheBlueMatt
Copy link
Collaborator

When handling calls to batch_funding_transaction_generated which were missing outputs for one of the batch channels, we'd previously deadlock when trying to clean up the now-closed channels. This fixes that and adds a new test case for it.

Found by the full_stack_target fuzzer.

Copy link

coderabbitai bot commented Jan 22, 2024

Walkthrough

The update includes a crucial fix to resource management by explicitly releasing funding_batch_states before entering a loop to process shutdown_results. This prevents potential deadlocks, enhancing stability. Additionally, the test suite has been expanded with new tests to ensure the robustness of force-close handling and batch funding failure scenarios, safeguarding against previously identified deadlock issues during channel shutdown procedures.

Changes

File Path Change Summary
lightning/src/ln/channelmanager.rs Introduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rs Added tests for force-close handling and batch funding failure to address deadlock situations.

🐇✨
To code we hop, with care we leap,
Patching the holes where bugs might creep.
With tests we bound, and deadlocks flee,
In our digital burrow, we code free. 🌟🐾

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6b0ba8c and ec79a63.
Files selected for processing (2)
  • lightning/src/ln/channelmanager.rs (1 hunks)
  • lightning/src/ln/shutdown_tests.rs (3 hunks)
Additional comments: 2
lightning/src/ln/channelmanager.rs (2)
  • 3987-3987: Explicitly dropping funding_batch_states using mem::drop is a good practice to release resources before entering the loop. This should help in preventing the deadlock issue as described.
  • 3987-3989: The loop iterates over shutdown_results and calls self.finish_close_channel(shutdown_result) for each item. Ensure that finish_close_channel can handle all possible states of shutdown_result that may occur, especially since funding_batch_states has been dropped just before.

lightning/src/ln/shutdown_tests.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@wpaulino wpaulino left a comment

Choose a reason for hiding this comment

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

LGTM but CI needs fixing

When handling calls to `batch_funding_transaction_generated` which
were missing outputs for one of the batch channels, we'd previously
deadlock when trying to clean up the now-closed channels. This
fixes that and adds a new test case for it.

Found by the full_stack_target fuzzer.
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6b0ba8c and 983ca37.
Files selected for processing (2)
  • lightning/src/ln/channelmanager.rs (1 hunks)
  • lightning/src/ln/shutdown_tests.rs (3 hunks)
Files skipped from review as they are similar to previous changes (2)
  • lightning/src/ln/channelmanager.rs
  • lightning/src/ln/shutdown_tests.rs

@TheBlueMatt TheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
@TheBlueMatt
Copy link
Collaborator Author

Gonna go ahead and land this since the non-test diff is incredibly trivial and we should get to releasing.

@TheBlueMatt TheBlueMatt merged commit 15c9f5b into lightningdevkit:main Jan 22, 2024
15 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