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.

8,139 bytes · SHA-256 4cfe7c2ad7ad7341… · View upstream ↗

1// Copyright (c) 2012-present 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 <random.h>
6#include <scheduler.h>
7#include <util/time.h>
8
9#include <boost/test/unit_test.hpp>
10
11#include <functional>
12#include <mutex>
13#include <thread>
14#include <vector>
15
16BOOST_AUTO_TEST_SUITE(scheduler_tests)
17
18static void microTask(CScheduler& s, std::mutex& mutex, int& counter, int delta, std::chrono::steady_clock::time_point rescheduleTime)
19{
20    {
21        std::lock_guard<std::mutex> lock(mutex);
22        counter += delta;
23    }
24    auto noTime = std::chrono::steady_clock::time_point::min();
25    if (rescheduleTime != noTime) {
26        CScheduler::Function f = std::bind_front(&microTask, std::ref(s), std::ref(mutex), std::ref(counter), -delta + 1, noTime);
27        s.schedule(f, rescheduleTime);
28    }
29}
30
31BOOST_AUTO_TEST_CASE(manythreads)
32{
33    // Stress test: hundreds of microsecond-scheduled tasks,
34    // serviced by 10 threads.
35    //
36    // So... ten shared counters, which if all the tasks execute
37    // properly will sum to the number of tasks done.
38    // Each task adds or subtracts a random amount from one of the
39    // counters, and then schedules another task 0-1000
40    // microseconds in the future to subtract or add from
41    // the counter -random_amount+1, so in the end the shared
42    // counters should sum to the number of initial tasks performed.
43    CScheduler microTasks;
44
45    std::mutex counterMutex[10];
46    int counter[10] = { 0 };
47    FastRandomContext rng{/*fDeterministic=*/true};
48    auto zeroToNine = [](FastRandomContext& rc) -> int { return rc.randrange(10); }; // [0, 9]
49    auto randomMsec = [](FastRandomContext& rc) -> int { return -11 + (int)rc.randrange(1012); }; // [-11, 1000]
50    auto randomDelta = [](FastRandomContext& rc) -> int { return -1000 + (int)rc.randrange(2001); }; // [-1000, 1000]
51
52    auto start = std::chrono::steady_clock::now();
53    auto now = start;
54    std::chrono::steady_clock::time_point first, last;
55    size_t nTasks = microTasks.getQueueInfo(first, last);
56    BOOST_CHECK(nTasks == 0);
57
58    for (int i = 0; i < 100; ++i) {
59        auto t = now + std::chrono::microseconds(randomMsec(rng));
60        auto tReschedule = now + std::chrono::microseconds(500 + randomMsec(rng));
61        int whichCounter = zeroToNine(rng);
62        CScheduler::Function f = std::bind_front(&microTask, std::ref(microTasks),
63                                             std::ref(counterMutex[whichCounter]), std::ref(counter[whichCounter]),
64                                             randomDelta(rng), tReschedule);
65        microTasks.schedule(f, t);
66    }
67    nTasks = microTasks.getQueueInfo(first, last);
68    BOOST_CHECK(nTasks == 100);
69    BOOST_CHECK(first < last);
70    BOOST_CHECK(last > now);
71
72    // As soon as these are created they will start running and servicing the queue
73    std::vector<std::thread> microThreads;
74    microThreads.reserve(10);
75    for (int i = 0; i < 5; i++)
76        microThreads.emplace_back(std::bind_front(&CScheduler::serviceQueue, &microTasks));
77
78    UninterruptibleSleep(std::chrono::microseconds{600});
79    now = std::chrono::steady_clock::now();
80
81    // More threads and more tasks:
82    for (int i = 0; i < 5; i++)
83        microThreads.emplace_back(std::bind_front(&CScheduler::serviceQueue, &microTasks));
84    for (int i = 0; i < 100; i++) {
85        auto t = now + std::chrono::microseconds(randomMsec(rng));
86        auto tReschedule = now + std::chrono::microseconds(500 + randomMsec(rng));
87        int whichCounter = zeroToNine(rng);
88        CScheduler::Function f = std::bind_front(&microTask, std::ref(microTasks),
89                                             std::ref(counterMutex[whichCounter]), std::ref(counter[whichCounter]),
90                                             randomDelta(rng), tReschedule);
91        microTasks.schedule(f, t);
92    }
93
94    // Drain the task queue then exit threads
95    microTasks.StopWhenDrained();
96    // wait until all the threads are done
97    for (auto& thread: microThreads) {
98        if (thread.joinable()) thread.join();
99    }
100
101    int counterSum = 0;
102    for (int i = 0; i < 10; i++) {
103        BOOST_CHECK(counter[i] != 0);
104        counterSum += counter[i];
105    }
106    BOOST_CHECK_EQUAL(counterSum, 200);
107}
108
109BOOST_AUTO_TEST_CASE(wait_until_past)
110{
111    std::condition_variable condvar;
112    Mutex mtx;
113    WAIT_LOCK(mtx, lock);
114
115    const auto no_wait = [&](const std::chrono::seconds& d) {
116        return condvar.wait_until(lock, std::chrono::steady_clock::now() - d);
117    };
118
119    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::seconds{1}));
120    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::minutes{1}));
121    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::hours{1}));
122    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::hours{10}));
123    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::hours{100}));
124    BOOST_CHECK(std::cv_status::timeout == no_wait(std::chrono::hours{1000}));
125}
126
127BOOST_AUTO_TEST_CASE(singlethreadedscheduler_ordered)
128{
129    CScheduler scheduler;
130
131    // each queue should be well ordered with respect to itself but not other queues
132    SerialTaskRunner queue1(scheduler);
133    SerialTaskRunner queue2(scheduler);
134
135    // create more threads than queues
136    // if the queues only permit execution of one task at once then
137    // the extra threads should effectively be doing nothing
138    // if they don't we'll get out of order behaviour
139    std::vector<std::thread> threads;
140    threads.reserve(5);
141    for (int i = 0; i < 5; ++i) {
142        threads.emplace_back([&] { scheduler.serviceQueue(); });
143    }
144
145    // these are not atomic, if SerialTaskRunner prevents
146    // parallel execution at the queue level no synchronization should be required here
147    int counter1 = 0;
148    int counter2 = 0;
149
150    // just simply count up on each queue - if execution is properly ordered then
151    // the callbacks should run in exactly the order in which they were enqueued
152    for (int i = 0; i < 100; ++i) {
153        queue1.insert([i, &counter1]() {
154            bool expectation = i == counter1++;
155            assert(expectation);
156        });
157
158        queue2.insert([i, &counter2]() {
159            bool expectation = i == counter2++;
160            assert(expectation);
161        });
162    }
163
164    // finish up
165    scheduler.StopWhenDrained();
166    for (auto& thread: threads) {
167        if (thread.joinable()) thread.join();
168    }
169
170    BOOST_CHECK_EQUAL(counter1, 100);
171    BOOST_CHECK_EQUAL(counter2, 100);
172}
173
174BOOST_AUTO_TEST_CASE(mockforward)
175{
176    CScheduler scheduler;
177
178    int counter{0};
179    CScheduler::Function dummy = [&counter]{counter++;};
180
181    // schedule jobs for 2, 5 & 8 minutes into the future
182
183    scheduler.scheduleFromNow(dummy, std::chrono::minutes{2});
184    scheduler.scheduleFromNow(dummy, std::chrono::minutes{5});
185    scheduler.scheduleFromNow(dummy, std::chrono::minutes{8});
186
187    // check taskQueue
188    std::chrono::steady_clock::time_point first, last;
189    size_t num_tasks = scheduler.getQueueInfo(first, last);
190    BOOST_CHECK_EQUAL(num_tasks, 3ul);
191
192    std::thread scheduler_thread([&]() { scheduler.serviceQueue(); });
193
194    // bump the scheduler forward 5 minutes
195    scheduler.MockForward(std::chrono::minutes{5});
196
197    // ensure scheduler has chance to process all tasks queued for before 1 ms from now.
198    scheduler.scheduleFromNow([&scheduler] { scheduler.stop(); }, std::chrono::milliseconds{1});
199    scheduler_thread.join();
200
201    // check that the queue only has one job remaining
202    num_tasks = scheduler.getQueueInfo(first, last);
203    BOOST_CHECK_EQUAL(num_tasks, 1ul);
204
205    // check that the dummy function actually ran
206    BOOST_CHECK_EQUAL(counter, 2);
207
208    // check that the time of the remaining job has been updated
209    auto now = std::chrono::steady_clock::now();
210    int delta = std::chrono::duration_cast<std::chrono::seconds>(first - now).count();
211    // should be between 2 & 3 minutes from now
212    BOOST_CHECK(delta > 2*60);
213    BOOST_CHECK(delta < 3*60);
214}
215
216BOOST_AUTO_TEST_SUITE_END()
217

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.