READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

11,012 bytes · SHA-256 98067b8f9898a41f… · View upstream ↗

1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_SYNC_H
7#define BITCOIN_SYNC_H
8
9// This header declares threading primitives compatible with Clang
10// Thread Safety Analysis and provides appropriate annotation macros.
11#include <threadsafety.h> // IWYU pragma: export
12#include <util/macros.h>
13
14#include <cassert>
15#include <condition_variable>
16#include <mutex>
17#include <string>
18#include <thread>
19
20////////////////////////////////////////////////
21//                                            //
22// THE SIMPLE DEFINITION, EXCLUDING DEBUG CODE //
23//                                            //
24////////////////////////////////////////////////
25
26/*
27RecursiveMutex mutex;
28    std::recursive_mutex mutex;
29
30LOCK(mutex);
31    std::unique_lock<std::recursive_mutex> criticalblock(mutex);
32
33LOCK2(mutex1, mutex2);
34    std::unique_lock<std::recursive_mutex> criticalblock1(mutex1);
35    std::unique_lock<std::recursive_mutex> criticalblock2(mutex2);
36
37TRY_LOCK(mutex, name);
38    std::unique_lock<std::recursive_mutex> name(mutex, std::try_to_lock_t);
39 */
40
41///////////////////////////////
42//                           //
43// THE ACTUAL IMPLEMENTATION //
44//                           //
45///////////////////////////////
46
47#ifdef DEBUG_LOCKORDER
48template <typename MutexType>
49void EnterCritical(const char* pszName, const char* pszFile, int nLine, MutexType* cs, bool fTry = false);
50void LeaveCritical();
51void CheckLastCritical(void* cs, std::string& lockname, const char* guardname, const char* file, int line);
52template <typename MutexType>
53void AssertLockHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) EXCLUSIVE_LOCKS_REQUIRED(cs);
54template <typename MutexType>
55void AssertLockNotHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) LOCKS_EXCLUDED(cs);
56void DeleteLock(void* cs);
57bool LockStackEmpty();
58
59/**
60 * Call abort() if a potential lock order deadlock bug is detected, instead of
61 * just logging information and throwing a logic_error. Defaults to true, and
62 * set to false in DEBUG_LOCKORDER unit tests.
63 */
64extern bool g_debug_lockorder_abort;
65#else
66template <typename MutexType>
67inline void EnterCritical(const char* pszName, const char* pszFile, int nLine, MutexType* cs, bool fTry = false) {}
68inline void LeaveCritical() {}
69inline void CheckLastCritical(void* cs, std::string& lockname, const char* guardname, const char* file, int line) {}
70template <typename MutexType>
71inline void AssertLockHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) EXCLUSIVE_LOCKS_REQUIRED(cs) {}
72template <typename MutexType>
73void AssertLockNotHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) LOCKS_EXCLUDED(cs) {}
74inline void DeleteLock(void* cs) {}
75inline bool LockStackEmpty() { return true; }
76#endif
77
78/*
79 * Called when a mutex fails to lock immediately because it is held by another
80 * thread, or spuriously. Responsible for locking the lock before returning.
81 */
82#ifdef DEBUG_LOCKCONTENTION
83
84template <typename LockType>
85void ContendedLock(std::string_view name, std::string_view file, int nLine, LockType& lock);
86#endif
87
88/**
89 * Template mixin that adds -Wthread-safety locking annotations and lock order
90 * checking to a subset of the mutex API.
91 */
92template <typename PARENT>
93class LOCKABLE AnnotatedMixin : public PARENT
94{
95public:
96    ~AnnotatedMixin() {
97        DeleteLock((void*)this);
98    }
99
100    void lock() EXCLUSIVE_LOCK_FUNCTION()
101    {
102        PARENT::lock();
103    }
104
105    void unlock() UNLOCK_FUNCTION()
106    {
107        PARENT::unlock();
108    }
109
110    bool try_lock() EXCLUSIVE_TRYLOCK_FUNCTION(true)
111    {
112        return PARENT::try_lock();
113    }
114
115    using unique_lock = std::unique_lock<PARENT>;
116#ifdef __clang__
117    //! For negative capabilities in the Clang Thread Safety Analysis.
118    //! A negative requirement uses the EXCLUSIVE_LOCKS_REQUIRED attribute, in conjunction
119    //! with the ! operator, to indicate that a mutex should not be held.
120    const AnnotatedMixin& operator!() const { return *this; }
121#endif // __clang__
122};
123
124/**
125 * Wrapped mutex: supports recursive locking, but no waiting
126 * TODO: We should move away from using the recursive lock by default.
127 */
128using RecursiveMutex = AnnotatedMixin<std::recursive_mutex>;
129
130/** Wrapped mutex: supports waiting but not recursive locking */
131using Mutex = AnnotatedMixin<std::mutex>;
132
133/** Different type to mark Mutex at global scope
134 *
135 * Thread safety analysis can't handle negative assertions about mutexes
136 * with global scope well, so mark them with a separate type, and
137 * eventually move all the mutexes into classes so they are not globally
138 * visible.
139 *
140 * See: https://github.com/bitcoin/bitcoin/pull/20272#issuecomment-720755781
141 */
142class GlobalMutex : public Mutex { };
143
144#define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
145
146inline void AssertLockNotHeldInline(const char* name, const char* file, int line, Mutex* cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) { AssertLockNotHeldInternal(name, file, line, cs); }
147inline void AssertLockNotHeldInline(const char* name, const char* file, int line, RecursiveMutex* cs) LOCKS_EXCLUDED(cs) { AssertLockNotHeldInternal(name, file, line, cs); }
148inline void AssertLockNotHeldInline(const char* name, const char* file, int line, GlobalMutex* cs) LOCKS_EXCLUDED(cs) { AssertLockNotHeldInternal(name, file, line, cs); }
149#define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
150
151/** Wrapper around std::unique_lock style lock for MutexType. */
152template <typename MutexType>
153class SCOPED_LOCKABLE UniqueLock : public MutexType::unique_lock
154{
155private:
156    using Base = typename MutexType::unique_lock;
157
158    void Enter(const char* pszName, const char* pszFile, int nLine)
159    {
160        EnterCritical(pszName, pszFile, nLine, Base::mutex());
161#ifdef DEBUG_LOCKCONTENTION
162        if (!Base::try_lock()) {
163            ContendedLock(pszName, pszFile, nLine, static_cast<Base&>(*this));
164        }
165#else
166        Base::lock();
167#endif
168    }
169
170    bool TryEnter(const char* pszName, const char* pszFile, int nLine)
171    {
172        EnterCritical(pszName, pszFile, nLine, Base::mutex(), true);
173        if (Base::try_lock()) {
174            return true;
175        }
176        LeaveCritical();
177        return false;
178    }
179
180public:
181    UniqueLock(MutexType& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) EXCLUSIVE_LOCK_FUNCTION(mutexIn) : Base(mutexIn, std::defer_lock)
182    {
183        if (fTry)
184            TryEnter(pszName, pszFile, nLine);
185        else
186            Enter(pszName, pszFile, nLine);
187    }
188
189    UniqueLock(MutexType* pmutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) EXCLUSIVE_LOCK_FUNCTION(pmutexIn)
190    {
191        if (!pmutexIn) return;
192
193        *static_cast<Base*>(this) = Base(*pmutexIn, std::defer_lock);
194        if (fTry)
195            TryEnter(pszName, pszFile, nLine);
196        else
197            Enter(pszName, pszFile, nLine);
198    }
199
200    ~UniqueLock() UNLOCK_FUNCTION()
201    {
202        if (Base::owns_lock())
203            LeaveCritical();
204    }
205
206    operator bool()
207    {
208        return Base::owns_lock();
209    }
210
211protected:
212    // needed for reverse_lock
213    UniqueLock() = default;
214
215public:
216    /**
217     * An RAII-style reverse lock. Unlocks on construction and locks on destruction.
218     */
219    class SCOPED_LOCKABLE reverse_lock {
220    public:
221        explicit reverse_lock(UniqueLock& _lock, const MutexType& mutex, const char* _guardname, const char* _file, int _line) UNLOCK_FUNCTION(mutex) : lock(_lock), file(_file), line(_line) {
222            // Ensure that mutex passed back for thread-safety analysis is indeed the original
223            assert(std::addressof(mutex) == lock.mutex());
224
225            CheckLastCritical((void*)lock.mutex(), lockname, _guardname, _file, _line);
226            lock.unlock();
227            LeaveCritical();
228            lock.swap(templock);
229        }
230
231        ~reverse_lock() UNLOCK_FUNCTION() {
232            templock.swap(lock);
233            EnterCritical(lockname.c_str(), file.c_str(), line, lock.mutex());
234            lock.lock();
235        }
236
237     private:
238        reverse_lock(reverse_lock const&);
239        reverse_lock& operator=(reverse_lock const&);
240
241        UniqueLock& lock;
242        UniqueLock templock;
243        std::string lockname;
244        const std::string file;
245        const int line;
246     };
247     friend class reverse_lock;
248};
249
250// clang's thread-safety analyzer is unable to deal with aliases of mutexes, so

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.