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

htlcswitch+routing: handle nil pointer dereference properly #9303

Merged
merged 3 commits into from
Dec 17, 2024

Conversation

yyforyongyu
Copy link
Member

This is the final cherry-picking from the blockbeat series PR #9260, which fixes the case on how we handle a closing circuit and a nil pointer dereference in the payment lifecycle:

2024-11-07 18:05:26.293 [CRT] CHDB log_shutdown.go:31: Caught unhandled error: ERROR: could not access status of transaction 330367 (SQLSTATE 58P01)
2024-11-07 18:05:26.293 [INF] CHDB log_shutdown.go:32: Sending request for shutdown
2024-11-07 18:05:26.293 [INF] LTND signal.go:181: Received shutdown request.
2024-11-07 18:05:26.293 [INF] LTND signal.go:166: Shutting down...
2024-11-07 18:05:26.293 [INF] LTND signal.go:185: Gracefully shutting down.
2024-11-07 18:05:26.294 [DBG] HSWC payment_result.go:166: Subscribing to result for attemptID=266
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x30 pc=0x1193220]

goroutine 69854 [running]:
github.com/lightningnetwork/lnd/channeldb.(*MPPayment).GetStatus(0xc000464320?)
	/home/runner/work/lnd/lnd/channeldb/mp_payment.go:459
github.com/lightningnetwork/lnd/routing.(*paymentLifecycle).resumePayment.func1({0x220afa0, 0xc000b23a80})
	/home/runner/work/lnd/lnd/routing/payment_lifecycle.go:195 +0x48
github.com/lightningnetwork/lnd/routing.(*paymentLifecycle).resumePayment(0xc00288d700, {0x2223108, 0xc0002c27e0})
	/home/runner/work/lnd/lnd/routing/payment_lifecycle.go:210 +0xf22
github.com/lightningnetwork/lnd/routing.(*ChannelRouter).sendPayment(0xc0004ef080, {0x2222410?, 0x337d480?}, 0x7fffffffffffffff, {0xb6, 0x7f, 0xd, 0xe2, 0xc4, 0x48, ...}, ...)
	/home/runner/work/lnd/lnd/routing/router.go:1328 +0x2ec
github.com/lightningnetwork/lnd/routing.(*ChannelRouter).SendPaymentAsync.func1()
	/home/runner/work/lnd/lnd/routing/router.go:983 +0x24c
created by github.com/lightningnetwork/lnd/routing.(*ChannelRouter).SendPaymentAsync in goroutine 42117
	/home/runner/work/lnd/lnd/routing/router.go:977 +0xec

@yyforyongyu yyforyongyu added bug fix no-changelog size/micro small bug fix or feature, less than 15 mins of review, less than 250 labels Nov 25, 2024
@yyforyongyu yyforyongyu added this to the v0.19.0 milestone Nov 25, 2024
@yyforyongyu yyforyongyu self-assigned this Nov 25, 2024
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

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.


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>, 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. (Beta)
  • @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
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

Thank you for the fix ⚡️


// If the circuit is in the process of closing, we will return a nil as
// there's another packet handling undergoing.
if errors.Is(err, ErrCircuitClosing) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm I am not sure if we should return nil here, because we shouldn't call the settle logic twice if we are already closing the circuit and if we do so shouldn't we return an error signaling that the circuit is closing rather than allowing it to be called multiple times and neglecting the error ?

Copy link
Member Author

Choose a reason for hiding this comment

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

I also think we should return an error here and let it be handled - unfortunately we cannot easily do it atm. I view this as a followup of 8c0c53e - in addition of catching the closed case, we should also catch the closing case. Tho it does feel like the logic should be put inside closeCircuit?

Copy link
Collaborator

Choose a reason for hiding this comment

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

ahh ok given this fact I think it is ok to place the logic here. But I would recommend to add a comment here why we can end up calling this logic here twice the current comment I would not be able to explain what this really means in detail or how this might happen:

there's another packet handling undergoing.

i this really only the case if resolution and the normal htlcPlex loggic trigger shortly after another ?

routing/payment_lifecycle.go Outdated Show resolved Hide resolved
We have two sources which can call `handlePacketSettle`, either through
the link's `<-s.htlcPlex`, or the `<-s.resolutionMsgs`, which means the
`closeCircuit` could be call twice. Previously we already caught this
case inside `closeCircuit`, in that we would return a nil circuit upon
seeing `ErrUnknownCircuit`, indicating the circuit was removed. However,
we still need to account the case when the circuit is the process of
being closed, which is now fixed as we will ignore when seeing
`ErrCircuitClosing`.
In a rare case when the critical log is triggered when using postgres as
db backend, the `payment` could be nil cause the server is shutting
down, causing the payment fetching to return an error. We now cache its
state before fetching it from the db.
Copy link
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

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

LGTM 🐝

@Roasbeef Roasbeef merged commit 8ecef03 into lightningnetwork:master Dec 17, 2024
32 of 36 checks passed
@yyforyongyu yyforyongyu deleted the fix-circuit-closed branch December 17, 2024 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug fix no-changelog size/micro small bug fix or feature, less than 15 mins of review, less than 250
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants