Skip to content

Commit 9fed456

Browse files
PastaPastaPastaknst
authored andcommitted
Merge #6407: fix: dataraces
5078bae fix(test): wait for chainlock before mining a block we expect to include said chainlock (pasta) f39c1e6 fix: guard m_can_tx_relay behind m_tx_relay_mutex; make it private; add additional annotations (pasta) Pull request description: ## Issue being fixed or feature implemented See each commit; fixes two bugs, both discovered while running feature_llmq_chainlocks.py with tsan / debug. one a datarace in net_processing.cpp and the other in the test I was using to ensure this fix was correct, feature_llmq_chainlocks ## What was done? ### net_processing.cpp You can see the datarace here: https://gist.github.com/PastaPastaPasta/c966a9f805758b34524085e3d52ea7f8 We simply guard it with an existing mutex that is always locked in close proximity. ### feature_llmq_chainlocks.py Most of the time, while generating the cycle quorum, there is sufficient time to generate a chainlock; however, this is racey, and I've observed locally where the block gets generated before a chainlock is present and as such `test_coinbase_best_cl` fails. We should instead wait for the chainlock first, and then mine the block. This was we can ensure the mined block will include that chainlock. This was observed locally maybe 1/10 times or so ## How Has This Been Tested? ran feature_llmq_chainlocks.py ~40 times locally with tsan / debug ## Breaking Changes None ## Checklist: _Go over all the following points, and put an `x` in all the boxes that apply._ - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: kwvg: utACK 5078bae knst: utACK 5078bae UdjinM6: utACK 5078bae Tree-SHA512: b346fc60809df72d0161f625073dce7062bd2641d35e4f80160fac9afeec63707de552e2856940ac2604875908ae3b98a225d352de36bfbfc6ee3fbe1e1538ff
1 parent 86105da commit 9fed456

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

src/net_processing.cpp

+9-7
Original file line numberDiff line numberDiff line change
@@ -309,21 +309,23 @@ struct Peer {
309309
/**
310310
* (Bitcoin) Initializes a TxRelay struct for this peer. Can be called at most once for a peer.
311311
* (Dash) Enables the flag that allows GetTxRelay() to return m_tx_relay */
312-
TxRelay* SetTxRelay()
312+
TxRelay* SetTxRelay() LOCKS_EXCLUDED(m_tx_relay_mutex)
313313
{
314+
LOCK(m_tx_relay_mutex);
314315
Assume(!m_can_tx_relay);
315316
m_can_tx_relay = true;
316-
return WITH_LOCK(m_tx_relay_mutex, return m_tx_relay.get());
317+
return m_tx_relay.get();
317318
};
318319

319-
TxRelay* GetInvRelay()
320+
TxRelay* GetInvRelay() LOCKS_EXCLUDED(m_tx_relay_mutex)
320321
{
321322
return WITH_LOCK(m_tx_relay_mutex, return m_tx_relay.get());
322323
}
323324

324-
TxRelay* GetTxRelay()
325+
TxRelay* GetTxRelay() LOCKS_EXCLUDED(m_tx_relay_mutex)
325326
{
326-
return m_can_tx_relay ? WITH_LOCK(m_tx_relay_mutex, return m_tx_relay.get()) : nullptr;
327+
LOCK(m_tx_relay_mutex);
328+
return m_can_tx_relay ? m_tx_relay.get() : nullptr;
327329
};
328330

329331
/** A vector of addresses to send to the peer, limited to MAX_ADDR_TO_SEND. */
@@ -353,8 +355,6 @@ struct Peer {
353355
* This field must correlate with whether m_addr_known has been
354356
* initialized.*/
355357
std::atomic_bool m_addr_relay_enabled{false};
356-
/** Whether a peer can relay transactions */
357-
bool m_can_tx_relay{false};
358358
/** Whether a getaddr request to this peer is outstanding. */
359359
bool m_getaddr_sent GUARDED_BY(NetEventsInterface::g_msgproc_mutex){false};
360360
/** Guards address sending timers. */
@@ -406,6 +406,8 @@ struct Peer {
406406
* (non-transaction relay should use GetInvRelay(), which will provide
407407
* unconditional access) */
408408
std::unique_ptr<TxRelay> m_tx_relay GUARDED_BY(m_tx_relay_mutex){std::make_unique<TxRelay>()};
409+
/** Whether a peer can relay transactions */
410+
bool m_can_tx_relay GUARDED_BY(m_tx_relay_mutex) {false};
409411
};
410412

411413
using PeerRef = std::shared_ptr<Peer>;

test/functional/feature_llmq_chainlocks.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,10 @@ def run_test(self):
5656
self.move_to_next_cycle()
5757
self.log.info("Cycle H+2C height:" + str(self.nodes[0].getblockcount()))
5858
self.mine_cycle_quorum(llmq_type_name="llmq_test_dip0024", llmq_type=103)
59-
60-
61-
self.log.info("Mine single block, wait for chainlock")
62-
self.generate(self.nodes[0], 1, sync_fun=self.no_op)
6359
self.wait_for_chainlocked_block_all_nodes(self.nodes[0].getbestblockhash())
60+
61+
self.log.info("Mine single block, ensure it includes latest chainlock")
62+
self.generate(self.nodes[0], 1, sync_fun=self.sync_blocks)
6463
self.test_coinbase_best_cl(self.nodes[0])
6564

6665
# ChainLock locks all the blocks below it so nocl_block_hash should be locked too

0 commit comments

Comments
 (0)