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.

Sign up for GitHub

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

peer: panic early on queued nil messages #3213

Merged
merged 1 commit into from
Nov 13, 2023
Merged

peer: panic early on queued nil messages #3213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions peer/peer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"io"
"math/rand"
"net"
"runtime/debug"
"strconv"
"sync"
"sync/atomic"
Expand Down Expand Up @@ -1688,6 +1689,23 @@ cleanup:
//
// This function is safe for concurrent access.
func (p *Peer) QueueMessage(msg wire.Message, doneChan chan<- struct{}) {
// Provide debug information when called with a nil message. This
// provides a more useful stack trace to callers than hitting the
// panic in a long-lived peer goroutine that contains no information
// about what caller queued the nil message.
if msg == nil {
// The semantics of whether a non-nil doneChan should be sent
// to or not, and the unknown program state this might lead
// to, doesn't leave a reasonable option to recover from this.
if doneChan != nil {
panic("peer: queued nil message")
}

log.Warnf("Attempt to send nil message type %T\nStack: %s",
msg, debug.Stack())
return
}

// Avoid risk of deadlock if goroutine already exited. The goroutine
// we will be sending to hangs around until it knows for a fact that
// it is marked as disconnected and *then* it drains the channels.
Expand Down