[Wallet] Lock cs_wallet in additional places.#949
Merged
codeofalltrades merged 1 commit intoVeil-Project:masterfrom May 26, 2021
Merged
[Wallet] Lock cs_wallet in additional places.#949codeofalltrades merged 1 commit intoVeil-Project:masterfrom
codeofalltrades merged 1 commit intoVeil-Project:masterfrom
Conversation
- Declare CWallet::KeepKey as requiring the lock, and take it before all calls. This eliminates a tsan data race. Also, fields within CReserveKey may similarly contend during mining, declare that they are guarded by the same lock. - Add other cs_wallet uses per lock annotations. This eliminates some clang warnings: AddKeyPubKey requires holding mutex 'pwalletParent->cs_wallet' exclusively
CaveSpectre11
added
Component: Core App
codeofalltrades
added
Code Review: Passed
and removed
Tag: Waiting For Code Review
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
tsan identifies a data race within WalletBatch, commonly between KeepKey and AddToWallet.
Solution
Declare CWallet::KeepKey as requiring
cs_wallet, and take it before all calls as prescribed by clang. (This moved the tsan data race to the nearby fields of CReserveKey, which was mitigated by including their access within the lock.)Add another cs_wallet use per clang warning: AddKeyPubKey requires holding mutex 'pwalletParent->cs_wallet' exclusively.
Tested
Configured with --with-sanitizers=thread, built with clang, and run on regtest. tsan warnings for this area no longer appear.