peer: test for startup writeHander data race #8198
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We use unsynchronized counters to trigger a report under the race detector if multiple reads or writes happen concurrently.
The test reliably detects lightningnetwork#8184.
Roasbeef
approved these changes
Nov 17, 2023
There was a problem hiding this comment.
LGTM 🐿️
I removed that earlier patch and confirms that when run with -race this reliably fails:
⛰ go test -v -run=TestStartupWriteMessageRace -race
=== RUN TestStartupWriteMessageRace
=== PAUSE TestStartupWriteMessageRace
=== CONT TestStartupWriteMessageRace
==================
WARNING: DATA RACE
Read at 0x00c00010ec70 by goroutine 15:
github.com/lightningnetwork/lnd/peer.(*mockMessageConn).SetWriteDeadline()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/test_utils.go:522 +0x34
github.com/lightningnetwork/lnd/peer.(*Brontide).writeMessage.func1()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/brontide.go:2114 +0x70
github.com/lightningnetwork/lnd/peer.(*Brontide).writeMessage()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/brontide.go:2159 +0x428
github.com/lightningnetwork/lnd/peer.(*Brontide).Start()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/brontide.go:727 +0xe14
github.com/lightningnetwork/lnd/peer.TestStartupWriteMessageRace()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/brontide_test.go:1441 +0xf7c
testing.tRunner()
/Users/roasbeef/go/src/testing/testing.go:1595 +0x194
testing.(*T).Run.func1()
/Users/roasbeef/go/src/testing/testing.go:1648 +0x40
Previous write at 0x00c00010ec70 by goroutine 27:
github.com/lightningnetwork/lnd/peer.(*mockMessageConn).WriteMessage()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/test_utils.go:535 +0x58
github.com/lightningnetwork/lnd/peer.(*Brontide).writeMessage.func2()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/peer/brontide.go:2153 +0xb8
github.com/lightningnetwork/lnd/peer.(*Brontide).writeMessage.(*Write).Submit.func3()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/pool/write.go:53 +0x68
github.com/lightningnetwork/lnd/pool.(*Worker).spawnWorker()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/pool/worker.go:209 +0x27c
github.com/lightningnetwork/lnd/pool.(*Worker).requestHandler.func2()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/pool/worker.go:161 +0x40
Goroutine 15 (running) created at:
testing.(*T).Run()
/Users/roasbeef/go/src/testing/testing.go:1648 +0x5d8
testing.runTests.func1()
/Users/roasbeef/go/src/testing/testing.go:2054 +0x80
testing.tRunner()
/Users/roasbeef/go/src/testing/testing.go:1595 +0x194
testing.runTests()
/Users/roasbeef/go/src/testing/testing.go:2052 +0x6d8
testing.(*M).Run()
/Users/roasbeef/go/src/testing/testing.go:1925 +0x904
main.main()
_testmain.go:71 +0x294
Goroutine 27 (running) created at:
github.com/lightningnetwork/lnd/pool.(*Worker).requestHandler()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/pool/worker.go:161 +0x274
github.com/lightningnetwork/lnd/pool.(*Write).Start.(*Worker).Start.func1.1()
/Users/roasbeef/gocode/src/github.com/lightningnetwork/lnd/pool/worker.go:99 +0x34
==================
testing.go:1465: race detected during execution of test
--- FAIL: TestStartupWriteMessageRace (0.28s)
FAIL
exit status 1
FAIL github.com/lightningnetwork/lnd/peer 0.856s
| // writeRaceDetectingCounter is incremented on any function call | ||
| // associated with writing to the connection. The race detector will | ||
| // trigger on this counter if a data race exists. | ||
| writeRaceDetectingCounter int |
There was a problem hiding this comment.
Ahh nice little trick: unsafe concurrent access here will cause the race detector to fire!
yyforyongyu
approved these changes
Nov 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The test case reliably triggers #8184 under the race detector.
Tested: