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.

14,581 bytes · SHA-256 86b6f6d2b493f57c… · 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 <cuckoocache.h>
6#include <random.h>
7#include <script/sigcache.h>
8#include <test/util/random.h>
9#include <test/util/setup_common.h>
10#include <util/byte_units.h>
11
12#include <boost/test/unit_test.hpp>
13
14#include <deque>
15#include <mutex>
16#include <shared_mutex>
17#include <thread>
18#include <vector>
19
20/** Test Suite for CuckooCache
21 *
22 *  1. All tests should have a deterministic result (using insecure rand
23 *  with deterministic seeds)
24 *  2. Some test methods are templated to allow for easier testing
25 *  against new versions / comparing
26 *  3. Results should be treated as a regression test, i.e., did the behavior
27 *  change significantly from what was expected. This can be OK, depending on
28 *  the nature of the change, but requires updating the tests to reflect the new
29 *  expected behavior. For example improving the hit rate may cause some tests
30 *  using BOOST_CHECK_CLOSE to fail.
31 *
32 */
33BOOST_FIXTURE_TEST_SUITE(cuckoocache_tests, BasicTestingSetup);
34
35/* Test that no values not inserted into the cache are read out of it.
36 *
37 * There are no repeats in the first 200000 m_rng.rand256() calls
38 */
39BOOST_AUTO_TEST_CASE(test_cuckoocache_no_fakes)
40{
41    SeedRandomForTest(SeedRand::ZEROS);
42    CuckooCache::cache<uint256, SignatureCacheHasher> cc{};
43    cc.setup_bytes(4_MiB);
44    for (int x = 0; x < 100000; ++x) {
45        cc.insert(m_rng.rand256());
46    }
47    for (int x = 0; x < 100000; ++x) {
48        BOOST_CHECK(!cc.contains(m_rng.rand256(), false));
49    }
50};
51
52struct HitRateTest : BasicTestingSetup {
53/** This helper returns the hit rate when bytes*load worth of entries are
54 * inserted into a bytes sized cache
55 */
56template <typename Cache>
57double test_cache(size_t bytes, double load)
58{
59    SeedRandomForTest(SeedRand::ZEROS);
60    std::vector<uint256> hashes;
61    Cache set{};
62    set.setup_bytes(bytes);
63    uint32_t n_insert = static_cast<uint32_t>(load * (bytes / sizeof(uint256)));
64    hashes.resize(n_insert);
65    for (uint32_t i = 0; i < n_insert; ++i) {
66        uint32_t* ptr = (uint32_t*)hashes[i].begin();
67        for (uint8_t j = 0; j < 8; ++j)
68            *(ptr++) = m_rng.rand32();
69    }
70    /** We make a copy of the hashes because future optimizations of the
71     * cuckoocache may overwrite the inserted element, so the test is
72     * "future proofed".
73     */
74    std::vector<uint256> hashes_insert_copy = hashes;
75    /** Do the insert */
76    for (const uint256& h : hashes_insert_copy)
77        set.insert(h);
78    /** Count the hits */
79    uint32_t count = 0;
80    for (const uint256& h : hashes)
81        count += set.contains(h, false);
82    double hit_rate = ((double)count) / ((double)n_insert);
83    return hit_rate;
84}
85
86/** The normalized hit rate for a given load.
87 *
88 * The semantics are a little confusing, so please see the below
89 * explanation.
90 *
91 * Examples:
92 *
93 * 1. at load 0.5, we expect a perfect hit rate, so we multiply by
94 * 1.0
95 * 2. at load 2.0, we expect to see half the entries, so a perfect hit rate
96 * would be 0.5. Therefore, if we see a hit rate of 0.4, 0.4*2.0 = 0.8 is the
97 * normalized hit rate.
98 *
99 * This is basically the right semantics, but has a bit of a glitch depending on
100 * how you measure around load 1.0 as after load 1.0 your normalized hit rate
101 * becomes effectively perfect, ignoring freshness.
102 */
103static double normalize_hit_rate(double hits, double load)
104{
105    return hits * std::max(load, 1.0);
106}
107}; // struct HitRateTest
108
109/** Check the hit rate on loads ranging from 0.1 to 1.6 */
110BOOST_FIXTURE_TEST_CASE(cuckoocache_hit_rate_ok, HitRateTest)
111{
112    /** Arbitrarily selected Hit Rate threshold that happens to work for this test
113     * as a lower bound on performance.
114     */
115    double HitRateThresh = 0.98;
116    for (double load = 0.1; load < 2; load *= 2) {
117        double hits = test_cache<CuckooCache::cache<uint256, SignatureCacheHasher>>(4_MiB, load);
118        BOOST_CHECK(normalize_hit_rate(hits, load) > HitRateThresh);
119    }
120}
121
122
123struct EraseTest : BasicTestingSetup {
124/** This helper checks that erased elements are preferentially inserted onto and
125 * that the hit rate of "fresher" keys is reasonable*/
126template <typename Cache>
127void test_cache_erase(size_t bytes)
128{
129    double load = 1;
130    SeedRandomForTest(SeedRand::ZEROS);
131    std::vector<uint256> hashes;
132    Cache set{};
133    set.setup_bytes(bytes);
134    uint32_t n_insert = static_cast<uint32_t>(load * (bytes / sizeof(uint256)));
135    hashes.resize(n_insert);
136    for (uint32_t i = 0; i < n_insert; ++i) {
137        uint32_t* ptr = (uint32_t*)hashes[i].begin();
138        for (uint8_t j = 0; j < 8; ++j)
139            *(ptr++) = m_rng.rand32();
140    }
141    /** We make a copy of the hashes because future optimizations of the
142     * cuckoocache may overwrite the inserted element, so the test is
143     * "future proofed".
144     */
145    std::vector<uint256> hashes_insert_copy = hashes;
146
147    /** Insert the first half */
148    for (uint32_t i = 0; i < (n_insert / 2); ++i)
149        set.insert(hashes_insert_copy[i]);
150    /** Erase the first quarter */
151    for (uint32_t i = 0; i < (n_insert / 4); ++i)
152        BOOST_CHECK(set.contains(hashes[i], true));
153    /** Insert the second half */
154    for (uint32_t i = (n_insert / 2); i < n_insert; ++i)
155        set.insert(hashes_insert_copy[i]);
156
157    /** elements that we marked as erased but are still there */
158    size_t count_erased_but_contained = 0;
159    /** elements that we did not erase but are older */
160    size_t count_stale = 0;
161    /** elements that were most recently inserted */
162    size_t count_fresh = 0;
163
164    for (uint32_t i = 0; i < (n_insert / 4); ++i)
165        count_erased_but_contained += set.contains(hashes[i], false);
166    for (uint32_t i = (n_insert / 4); i < (n_insert / 2); ++i)
167        count_stale += set.contains(hashes[i], false);
168    for (uint32_t i = (n_insert / 2); i < n_insert; ++i)
169        count_fresh += set.contains(hashes[i], false);
170
171    double hit_rate_erased_but_contained = double(count_erased_but_contained) / (double(n_insert) / 4.0);
172    double hit_rate_stale = double(count_stale) / (double(n_insert) / 4.0);
173    double hit_rate_fresh = double(count_fresh) / (double(n_insert) / 2.0);
174
175    // Check that our hit_rate_fresh is perfect
176    BOOST_CHECK_EQUAL(hit_rate_fresh, 1.0);
177    // Check that we have a more than 2x better hit rate on stale elements than
178    // erased elements.
179    BOOST_CHECK(hit_rate_stale > 2 * hit_rate_erased_but_contained);
180}
181}; // struct EraseTest
182
183BOOST_FIXTURE_TEST_CASE(cuckoocache_erase_ok, EraseTest)
184{
185    test_cache_erase<CuckooCache::cache<uint256, SignatureCacheHasher>>(4_MiB);
186}
187
188struct EraseParallelTest : BasicTestingSetup {
189template <typename Cache>
190void test_cache_erase_parallel(size_t bytes)
191{
192    double load = 1;
193    SeedRandomForTest(SeedRand::ZEROS);
194    std::vector<uint256> hashes;
195    Cache set{};
196    set.setup_bytes(bytes);
197    uint32_t n_insert = static_cast<uint32_t>(load * (bytes / sizeof(uint256)));
198    hashes.resize(n_insert);
199    for (uint32_t i = 0; i < n_insert; ++i) {
200        uint32_t* ptr = (uint32_t*)hashes[i].begin();
201        for (uint8_t j = 0; j < 8; ++j)
202            *(ptr++) = m_rng.rand32();
203    }
204    /** We make a copy of the hashes because future optimizations of the
205     * cuckoocache may overwrite the inserted element, so the test is
206     * "future proofed".
207     */
208    std::vector<uint256> hashes_insert_copy = hashes;
209    std::shared_mutex mtx;
210
211    {
212        /** Grab lock to make sure we release inserts */
213        std::unique_lock<std::shared_mutex> l(mtx);
214        /** Insert the first half */
215        for (uint32_t i = 0; i < (n_insert / 2); ++i)
216            set.insert(hashes_insert_copy[i]);
217    }
218
219    /** Spin up 3 threads to run contains with erase.
220     */
221    std::vector<std::thread> threads;
222    threads.reserve(3);
223    /** Erase the first quarter */
224    for (uint32_t x = 0; x < 3; ++x)
225        /** Each thread is emplaced with x copy-by-value
226        */
227        threads.emplace_back([&, x] {
228            std::shared_lock<std::shared_mutex> l(mtx);
229            size_t ntodo = (n_insert/4)/3;
230            size_t start = ntodo*x;
231            size_t end = ntodo*(x+1);
232            for (uint32_t i = start; i < end; ++i) {
233                bool contains = set.contains(hashes[i], true);
234                assert(contains);
235            }
236        });
237
238    /** Wait for all threads to finish
239     */
240    for (std::thread& t : threads)
241        t.join();
242    /** Grab lock to make sure we observe erases */
243    std::unique_lock<std::shared_mutex> l(mtx);
244    /** Insert the second half */
245    for (uint32_t i = (n_insert / 2); i < n_insert; ++i)
246        set.insert(hashes_insert_copy[i]);
247
248    /** elements that we marked erased but that are still there */
249    size_t count_erased_but_contained = 0;
250    /** elements that we did not erase but are older */

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.