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.

42,575 bytes · SHA-256 eb3af11a89776343… · View upstream ↗

1// Copyright (c) The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef MP_PROXY_IO_H
6#define MP_PROXY_IO_H
7
8#include <mp/proxy.h>
9#include <mp/util.h>
10
11#include <mp/proxy.capnp.h>
12
13#include <capnp/rpc-twoparty.h>
14
15#include <assert.h>
16#include <algorithm>
17#include <condition_variable>
18#include <cstdlib>
19#include <functional>
20#include <kj/function.h>
21#include <map>
22#include <memory>
23#include <optional>
24#include <sstream>
25#include <string>
26#include <thread>
27
28namespace mp {
29struct ThreadContext;
30struct Listener;
31
32struct InvokeContext
33{
34    Connection& connection;
35};
36
37struct ClientInvokeContext : InvokeContext
38{
39    ThreadContext& thread_context;
40    ClientInvokeContext(Connection& conn, ThreadContext& thread_context)
41        : InvokeContext{conn}, thread_context{thread_context}
42    {
43    }
44};
45
46template <typename ProxyServer, typename CallContext_>
47struct ServerInvokeContext : InvokeContext
48{
49    using CallContext = CallContext_;
50
51    ProxyServer& proxy_server;
52    CallContext& call_context;
53    int req;
54    //! For IPC methods that execute asynchronously, not on the event-loop
55    //! thread: lock preventing the event-loop thread from freeing the params or
56    //! results structs if the request is canceled while the worker thread is
57    //! reading params (`call_context.getParams()`) or writing results
58    //! (`call_context.getResults()`).
59    Lock* cancel_lock{nullptr};
60    //! For IPC methods that execute asynchronously, not on the event-loop
61    //! thread, this is set to true if the IPC call was canceled by the client
62    //! or canceled by a disconnection. If the call runs on the event-loop
63    //! thread, it can't be canceled. This should be accessed with cancel_lock
64    //! held if it is not null, since in the asynchronous case it is accessed
65    //! from multiple threads.
66    bool request_canceled{false};
67
68    ServerInvokeContext(ProxyServer& proxy_server, CallContext& call_context, int req)
69        : InvokeContext{*proxy_server.m_context.connection}, proxy_server{proxy_server}, call_context{call_context}, req{req}
70    {
71    }
72};
73
74template <typename Interface, typename Params, typename Results>
75using ServerContext = ServerInvokeContext<ProxyServer<Interface>, ::capnp::CallContext<Params, Results>>;
76
77template <>
78struct ProxyClient<Thread> : public ProxyClientBase<Thread, ::capnp::Void>
79{
80    using ProxyClientBase::ProxyClientBase;
81    // https://stackoverflow.com/questions/22357887/comparing-two-mapiterators-why-does-it-need-the-copy-constructor-of-stdpair
82    ProxyClient(const ProxyClient&) = delete;
83    ~ProxyClient();
84
85    //! Reference to callback function that is run if there is a sudden
86    //! disconnect and the Connection object is destroyed before this
87    //! ProxyClient<Thread> object. The callback will destroy this object and
88    //! remove its entry from the thread's request_threads or callback_threads
89    //! map. It will also reset m_disconnect_cb so the destructor does not
90    //! access it. In the normal case where there is no sudden disconnect, the
91    //! destructor will unregister m_disconnect_cb so the callback is never run.
92    //! Since this variable is accessed from multiple threads, accesses should
93    //! be guarded with the associated Waiter::m_mutex.
94    std::optional<CleanupIt> m_disconnect_cb;
95};
96
97template <>
98struct ProxyServer<Thread> final : public Thread::Server
99{
100public:
101    ProxyServer(Connection& connection, ThreadContext& thread_context, std::thread&& thread);
102    ~ProxyServer();
103    kj::Promise<void> getName(GetNameContext context) override;
104
105    //! Run a callback function fn returning T on this thread. The function will
106    //! be queued and executed as soon as the thread is idle, and when fn
107    //! returns, the promise returned by this method will be fulfilled with the
108    //! value fn returned.
109    template<typename T, typename Fn>
110    kj::Promise<T> post(Fn&& fn);
111
112    EventLoopRef m_loop;
113    ThreadContext& m_thread_context;
114    std::thread m_thread;
115    //! Promise signaled when m_thread_context.waiter is ready and there is no
116    //! post() callback function waiting to execute.
117    kj::Promise<void> m_thread_ready{kj::READY_NOW};
118};
119
120//! Handler for kj::TaskSet failed task events.
121class LoggingErrorHandler : public kj::TaskSet::ErrorHandler
122{
123public:
124    LoggingErrorHandler(EventLoop& loop) : m_loop(loop) {}
125    void taskFailed(kj::Exception&& exception) override;
126    EventLoop& m_loop;
127};
128
129//! Log flags. Update stringify function if changed!
130enum class Log {
131    Trace = 0,
132    Debug,
133    Info,
134    Warning,
135    Error,
136    Raise,
137};
138
139kj::StringPtr KJ_STRINGIFY(Log flags);
140
141struct LogMessage {
142
143    //! Message to be logged
144    std::string message;
145
146    //! The severity level of this message
147    Log level;
148};
149
150using LogFn = std::function<void(LogMessage)>;
151
152struct LogOptions {
153
154    //! External logging callback.
155    LogFn log_fn;
156
157    //! Maximum number of characters to use when representing
158    //! request and response structs as strings.
159    size_t max_chars{200};
160
161    //! Messages with a severity level less than log_level will not be
162    //! reported.
163    Log log_level{Log::Trace};
164};
165
166class Logger
167{
168public:
169    Logger(const LogOptions& options, Log log_level) : m_options(options), m_log_level(log_level) {}
170
171    Logger(Logger&&) = delete;
172    Logger& operator=(Logger&&) = delete;
173    Logger(const Logger&) = delete;
174    Logger& operator=(const Logger&) = delete;
175
176    ~Logger() noexcept(false)
177    {
178        if (enabled()) m_options.log_fn({std::move(m_buffer).str(), m_log_level});
179    }
180
181    template <typename T>
182    friend Logger& operator<<(Logger& logger, T&& value)
183    {
184        if (logger.enabled()) logger.m_buffer << std::forward<T>(value);
185        return logger;
186    }
187
188    template <typename T>
189    friend Logger& operator<<(Logger&& logger, T&& value)
190    {
191        return logger << std::forward<T>(value);
192    }
193
194    explicit operator bool() const
195    {
196        return enabled();
197    }
198
199private:
200    bool enabled() const
201    {
202        return m_options.log_fn && m_log_level >= m_options.log_level;
203    }
204
205    const LogOptions& m_options;
206    Log m_log_level;
207    std::ostringstream m_buffer;
208};
209
210#define MP_LOGPLAIN(loop, ...) if (mp::Logger logger{(loop).m_log_opts, __VA_ARGS__}; logger) logger
211
212#define MP_LOG(loop, ...) MP_LOGPLAIN(loop, __VA_ARGS__) << "{" << LongThreadName((loop).m_exe_name) << "} "
213
214std::string LongThreadName(const char* exe_name);
215
216//! Event loop implementation.
217//!
218//! Cap'n Proto threading model is very simple: all I/O operations are
219//! asynchronous and must be performed on a single thread. This includes:
220//!
221//! - Code starting an asynchronous operation (calling a function that returns a
222//!   promise object)
223//! - Code notifying that an asynchronous operation is complete (code using a
224//!   fulfiller object)
225//! - Code handling a completed operation (code chaining or waiting for a promise)
226//!
227//! All of this code needs to access shared state, and there is no mutex that
228//! can be acquired to lock this state because Cap'n Proto
229//! assumes it will only be accessed from one thread. So all this code needs to
230//! actually run on one thread, and the EventLoop::loop() method is the entry point for
231//! this thread. ProxyClient and ProxyServer objects that use other threads and
232//! need to perform I/O operations post to this thread using EventLoop::post()
233//! and EventLoop::sync() methods.
234//!
235//! Specifically, because ProxyClient methods can be called from arbitrary
236//! threads, and ProxyServer methods can run on arbitrary threads, ProxyClient
237//! methods use the EventLoop thread to send requests, and ProxyServer methods
238//! use the thread to return results.
239//!
240//! Based on https://groups.google.com/d/msg/capnproto/TuQFF1eH2-M/g81sHaTAAQAJ
241class EventLoop
242{
243public:
244    //! Construct event loop object with default logging options.
245    EventLoop(const char* exe_name, LogFn log_fn, void* context = nullptr)
246        : EventLoop(exe_name, LogOptions{std::move(log_fn)}, context){}
247
248    //! Construct event loop object with specified logging options.
249    EventLoop(const char* exe_name, LogOptions log_opts, void* context = nullptr);
250

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.