Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Fix deadlock when handling bad calls to `batch_funding.._generated` by TheBlueMatt · Pull Request #2841 · lightningdevkit/rust-lightning · GitHub
Skip to content

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

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock
Jan 22, 2024
Merged

Fix deadlock when handling bad calls to batch_funding.._generated#2841
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
TheBlueMatt:2024-01-batch-deadlock

Conversation

@TheBlueMatt

Copy link
Copy Markdown
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.

@coderabbitai

coderabbitaiBot commented Jan 22, 2024

Copy link
Copy Markdown

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 PathChange Summary
lightning/src/ln/channelmanager.rsIntroduced memory resource release before processing shutdown results and added logic to handle channel closure.
lightning/src/ln/shutdown_tests.rsAdded 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.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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.

Comment threadlightning/src/ln/shutdown_tests.rs

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

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.
@TheBlueMatt
TheBlueMattforce-pushed the 2024-01-batch-deadlock branch from ec79a63 to 983ca37CompareJanuary 22, 2024 21:23

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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

@TheBlueMattTheBlueMatt added this to the 0.0.121 milestone Jan 22, 2024
Comment threadlightning/src/ln/shutdown_tests.rs
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

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:mainJan 22, 2024
Sign up for freeto 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

@TheBlueMatt@wpaulino