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.

18,198 bytes · SHA-256 1e1dfba3d3c7f093… · 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#include <common/system.h>
6#include <logging.h>
7#include <random.h>
8#include <test/util/common.h>
9#include <util/string.h>
10#include <util/threadpool.h>
11#include <util/time.h>
12
13#include <boost/test/unit_test.hpp>
14
15#include <array>
16#include <functional>
17#include <latch>
18#include <ranges>
19#include <semaphore>
20
21// General test values
22int NUM_WORKERS_DEFAULT = 0;
23constexpr char POOL_NAME[] = "test";
24constexpr auto TEST_WAIT_TIMEOUT = 120s;
25
26struct ThreadPoolFixture {
27    ThreadPoolFixture() {
28        NUM_WORKERS_DEFAULT = FastRandomContext().randrange(GetNumCores()) + 1;
29        LogInfo("thread pool workers count: %d", NUM_WORKERS_DEFAULT);
30    }
31};
32
33// Test Cases Overview
34// 0) Submit task to a non-started pool.
35// 1) Submit tasks and verify completion.
36// 2) Maintain all threads busy except one.
37// 3) Wait for work to finish.
38// 4) Wait for result object.
39// 5) The task throws an exception, catch must be done in the consumer side.
40// 6) Busy workers, help them by processing tasks externally.
41// 7) Recursive submission of tasks.
42// 8) Submit task when all threads are busy, stop pool and verify task gets executed.
43// 9) Congestion test; create more workers than available cores.
44// 10) Ensure Interrupt() prevents further submissions.
45// 11) Start() must not cause a deadlock when called during Stop().
46// 12) Ensure queued tasks complete after Interrupt().
47// 13) Ensure the Stop() calling thread helps drain the queue.
48// 14) Submit range of tasks in one lock acquisition.
49BOOST_FIXTURE_TEST_SUITE(threadpool_tests, ThreadPoolFixture)
50
51#define WAIT_FOR(futures)                                                         \
52    do {                                                                          \
53        for (const auto& f : futures) {                                           \
54            BOOST_REQUIRE(f.wait_for(TEST_WAIT_TIMEOUT) == std::future_status::ready); \
55        }                                                                         \
56    } while (0)
57
58// Helper to unwrap a valid pool submission
59template <typename F>
60[[nodiscard]] auto Submit(ThreadPool& pool, F&& fn)
61{
62    return std::move(*Assert(pool.Submit(std::forward<F>(fn))));
63}
64
65// Block a number of worker threads by submitting tasks that wait on `release_sem`.
66// Returns the futures of the blocking tasks, ensuring all have started and are waiting.
67std::vector<std::future<void>> BlockWorkers(ThreadPool& threadPool, std::counting_semaphore<>& release_sem, size_t num_of_threads_to_block)
68{
69    assert(threadPool.WorkersCount() >= num_of_threads_to_block);
70    std::latch ready{static_cast<std::ptrdiff_t>(num_of_threads_to_block)};
71    std::vector<std::future<void>> blocking_tasks(num_of_threads_to_block);
72    for (auto& f : blocking_tasks) f = Submit(threadPool, [&] {
73        ready.count_down();
74        release_sem.acquire();
75    });
76    ready.wait();
77    return blocking_tasks;
78}
79
80// Test 0, submit task to a non-started, interrupted, or stopped pool
81BOOST_AUTO_TEST_CASE(submit_fails_with_correct_error)
82{
83    ThreadPool threadPool(POOL_NAME);
84    const auto fn_empty = [&] {};
85
86    // Never started: Inactive
87    auto res = threadPool.Submit(fn_empty);
88    BOOST_CHECK(!res);
89    BOOST_CHECK_EQUAL(SubmitErrorString(res.error()), "No active workers");
90
91    // Interrupted (workers still alive): Interrupted, and Start() must be rejected too
92    std::counting_semaphore<> blocker(0);
93    threadPool.Start(NUM_WORKERS_DEFAULT);
94    const auto blocking_tasks = BlockWorkers(threadPool, blocker, NUM_WORKERS_DEFAULT);
95    threadPool.Interrupt();
96    res = threadPool.Submit(fn_empty);
97    BOOST_CHECK(!res);
98    BOOST_CHECK_EQUAL(SubmitErrorString(res.error()), "Interrupted");
99    BOOST_CHECK_EXCEPTION(threadPool.Start(NUM_WORKERS_DEFAULT), std::runtime_error, HasReason("Thread pool has been interrupted or is stopping"));
100    blocker.release(NUM_WORKERS_DEFAULT);
101    WAIT_FOR(blocking_tasks);
102
103    // Interrupted then stopped: Inactive
104    threadPool.Stop();
105    res = threadPool.Submit(fn_empty);
106    BOOST_CHECK(!res);
107    BOOST_CHECK_EQUAL(SubmitErrorString(res.error()), "No active workers");
108
109    // Started then stopped: Inactive
110    threadPool.Start(NUM_WORKERS_DEFAULT);
111    threadPool.Stop();
112    res = threadPool.Submit(fn_empty);
113    BOOST_CHECK(!res);
114    BOOST_CHECK_EQUAL(SubmitErrorString(res.error()), "No active workers");
115
116    std::vector<std::function<void()>> tasks;
117    const auto range_res{threadPool.Submit(std::move(tasks))};
118    BOOST_CHECK(!range_res);
119    BOOST_CHECK_EQUAL(SubmitErrorString(range_res.error()), "No active workers");
120}
121
122// Test 1, submit tasks and verify completion
123BOOST_AUTO_TEST_CASE(submit_tasks_complete_successfully)
124{
125    int num_tasks = 50;
126
127    ThreadPool threadPool(POOL_NAME);
128    threadPool.Start(NUM_WORKERS_DEFAULT);
129    std::atomic<int> counter = 0;
130
131    // Store futures to ensure completion before checking counter.
132    std::vector<std::future<void>> futures;
133    futures.reserve(num_tasks);
134    for (int i = 1; i <= num_tasks; i++) {
135        futures.emplace_back(Submit(threadPool, [&counter, i]() {
136            counter.fetch_add(i, std::memory_order_relaxed);
137        }));
138    }
139
140    // Wait for all tasks to finish
141    WAIT_FOR(futures);
142    int expected_value = (num_tasks * (num_tasks + 1)) / 2; // Gauss sum.
143    BOOST_CHECK_EQUAL(counter.load(), expected_value);
144    BOOST_CHECK_EQUAL(threadPool.WorkQueueSize(), 0);
145}
146
147// Test 2, maintain all threads busy except one
148BOOST_AUTO_TEST_CASE(single_available_worker_executes_all_tasks)
149{
150    ThreadPool threadPool(POOL_NAME);
151    threadPool.Start(NUM_WORKERS_DEFAULT);
152    std::counting_semaphore<> blocker(0);
153    const auto blocking_tasks = BlockWorkers(threadPool, blocker, NUM_WORKERS_DEFAULT - 1);
154
155    // Now execute tasks on the single available worker
156    // and check that all the tasks are executed.
157    int num_tasks = 15;
158    int counter = 0;
159
160    // Store futures to wait on
161    std::vector<std::future<void>> futures(num_tasks);
162    for (auto& f : futures) f = Submit(threadPool, [&counter]{ counter++; });
163
164    WAIT_FOR(futures);
165    BOOST_CHECK_EQUAL(counter, num_tasks);
166
167    blocker.release(NUM_WORKERS_DEFAULT - 1);
168    WAIT_FOR(blocking_tasks);
169    threadPool.Stop();
170    BOOST_CHECK_EQUAL(threadPool.WorkersCount(), 0);
171}
172
173// Test 3, wait for work to finish
174BOOST_AUTO_TEST_CASE(wait_for_task_to_finish)
175{
176    ThreadPool threadPool(POOL_NAME);
177    threadPool.Start(NUM_WORKERS_DEFAULT);
178    std::atomic<bool> flag = false;
179    std::future<void> future = Submit(threadPool, [&flag]() {
180        UninterruptibleSleep(200ms);
181        flag.store(true, std::memory_order_release);
182    });
183    BOOST_CHECK(future.wait_for(TEST_WAIT_TIMEOUT) == std::future_status::ready);
184    BOOST_CHECK(flag.load(std::memory_order_acquire));
185}
186
187// Test 4, obtain result object
188BOOST_AUTO_TEST_CASE(get_result_from_completed_task)
189{
190    ThreadPool threadPool(POOL_NAME);
191    threadPool.Start(NUM_WORKERS_DEFAULT);
192    std::future<bool> future_bool = Submit(threadPool, []() { return true; });
193    BOOST_CHECK(future_bool.get());
194
195    std::future<std::string> future_str = Submit(threadPool, []() { return std::string("true"); });
196    std::string result = future_str.get();
197    BOOST_CHECK_EQUAL(result, "true");
198}
199
200// Test 5, throw exception and catch it on the consumer side
201BOOST_AUTO_TEST_CASE(task_exception_propagates_to_future)
202{
203    ThreadPool threadPool(POOL_NAME);
204    threadPool.Start(NUM_WORKERS_DEFAULT);
205
206    const auto make_err{[&](size_t n) { return strprintf("error on thread #%s", n); }};
207
208    const int num_tasks = 5;
209    std::vector<std::future<void>> futures;
210    futures.reserve(num_tasks);
211    for (int i = 0; i < num_tasks; i++) {
212        futures.emplace_back(Submit(threadPool, [&make_err, i] { throw std::runtime_error(make_err(i)); }));
213    }
214
215    for (int i = 0; i < num_tasks; i++) {
216        BOOST_CHECK_EXCEPTION(futures[i].get(), std::runtime_error, HasReason{make_err(i)});
217    }
218}
219
220// Test 6, all workers are busy, help them by processing tasks from outside
221BOOST_AUTO_TEST_CASE(process_tasks_manually_when_workers_busy)
222{
223    ThreadPool threadPool(POOL_NAME);
224    threadPool.Start(NUM_WORKERS_DEFAULT);
225
226    std::counting_semaphore<> blocker(0);
227    const auto& blocking_tasks = BlockWorkers(threadPool, blocker, NUM_WORKERS_DEFAULT);
228
229    // Now submit tasks and check that none of them are executed.
230    int num_tasks = 20;
231    std::atomic<int> counter = 0;
232    for (int i = 0; i < num_tasks; i++) {
233        (void)Submit(threadPool, [&counter]() {
234            counter.fetch_add(1, std::memory_order_relaxed);
235        });
236    }
237    UninterruptibleSleep(100ms);
238    BOOST_CHECK_EQUAL(threadPool.WorkQueueSize(), num_tasks);
239
240    // Now process manually
241    for (int i = 0; i < num_tasks; i++) {
242        threadPool.ProcessTask();
243    }
244    BOOST_CHECK_EQUAL(counter.load(), num_tasks);
245    BOOST_CHECK_EQUAL(threadPool.WorkQueueSize(), 0);
246    blocker.release(NUM_WORKERS_DEFAULT);
247    threadPool.Stop();
248    WAIT_FOR(blocking_tasks);
249}
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.