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,112 bytes · SHA-256 24bc6b6e9a87a847… · View upstream ↗

1// Copyright (c) 2022-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 <memusage.h>
6#include <support/allocators/pool.h>
7#include <test/util/poolresourcetester.h>
8#include <test/util/random.h>
9#include <test/util/setup_common.h>
10
11#include <boost/test/unit_test.hpp>
12
13#include <cstddef>
14#include <cstdint>
15#include <unordered_map>
16#include <vector>
17
18BOOST_FIXTURE_TEST_SUITE(pool_tests, BasicTestingSetup)
19
20BOOST_AUTO_TEST_CASE(basic_allocating)
21{
22    auto resource = PoolResource<8, 8>();
23    PoolResourceTester::CheckAllDataAccountedFor(resource);
24
25    // first chunk is already allocated
26    size_t expected_bytes_available = resource.ChunkSizeBytes();
27    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
28
29    // chunk is used, no more allocation
30    void* block = resource.Allocate(8, 8);
31    expected_bytes_available -= 8;
32    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
33
34    BOOST_TEST(0 == PoolResourceTester::FreeListSizes(resource)[1]);
35    resource.Deallocate(block, 8, 8);
36    PoolResourceTester::CheckAllDataAccountedFor(resource);
37    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
38
39    // alignment is too small, but the best fitting freelist is used. Nothing is allocated.
40    void* b = resource.Allocate(8, 1);
41    BOOST_TEST(b == block); // we got the same block of memory as before
42    BOOST_TEST(0 == PoolResourceTester::FreeListSizes(resource)[1]);
43    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
44
45    resource.Deallocate(block, 8, 1);
46    PoolResourceTester::CheckAllDataAccountedFor(resource);
47    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
48    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
49
50    // can't use resource because alignment is too big, allocate system memory
51    b = resource.Allocate(8, 16);
52    BOOST_TEST(b != block);
53    block = b;
54    PoolResourceTester::CheckAllDataAccountedFor(resource);
55    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
56    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
57
58    resource.Deallocate(block, 8, 16);
59    PoolResourceTester::CheckAllDataAccountedFor(resource);
60    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
61    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
62
63    // can't use chunk because size is too big
64    block = resource.Allocate(16, 8);
65    PoolResourceTester::CheckAllDataAccountedFor(resource);
66    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
67    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
68
69    resource.Deallocate(block, 16, 8);
70    PoolResourceTester::CheckAllDataAccountedFor(resource);
71    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
72    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
73
74    // it's possible that 0 bytes are allocated, make sure this works. In that case the call is forwarded to operator new
75    // 0 bytes takes one entry from the first freelist
76    void* p = resource.Allocate(0, 1);
77    BOOST_TEST(0 == PoolResourceTester::FreeListSizes(resource)[1]);
78    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
79
80    resource.Deallocate(p, 0, 1);
81    PoolResourceTester::CheckAllDataAccountedFor(resource);
82    BOOST_TEST(1 == PoolResourceTester::FreeListSizes(resource)[1]);
83    BOOST_TEST(expected_bytes_available == PoolResourceTester::AvailableMemoryFromChunk(resource));
84}
85
86// Allocates from 0 to n bytes were n > the PoolResource's data, and each should work
87BOOST_AUTO_TEST_CASE(allocate_any_byte)
88{
89    auto resource = PoolResource<128, 8>(1024);
90
91    uint8_t num_allocs = 200;
92
93    auto data = std::vector<std::span<uint8_t>>();
94
95    // allocate an increasing number of bytes
96    for (uint8_t num_bytes = 0; num_bytes < num_allocs; ++num_bytes) {
97        uint8_t* bytes = new (resource.Allocate(num_bytes, 1)) uint8_t[num_bytes];
98        BOOST_TEST(bytes != nullptr);
99        data.emplace_back(bytes, num_bytes);
100
101        // set each byte to num_bytes
102        std::fill(bytes, bytes + num_bytes, num_bytes);
103    }
104
105    // now that we got all allocated, test if all still have the correct values, and give everything back to the allocator
106    uint8_t val = 0;
107    for (auto const& span : data) {
108        for (auto x : span) {
109            BOOST_TEST(val == x);
110        }
111        std::destroy(span.data(), span.data() + span.size());
112        resource.Deallocate(span.data(), span.size(), 1);
113        ++val;
114    }
115
116    PoolResourceTester::CheckAllDataAccountedFor(resource);
117}
118
119BOOST_AUTO_TEST_CASE(random_allocations)
120{
121    struct PtrSizeAlignment {
122        void* ptr;
123        size_t bytes;
124        size_t alignment;
125    };
126
127    // makes a bunch of random allocations and gives all of them back in random order.
128    auto resource = PoolResource<128, 8>(65536);
129    std::vector<PtrSizeAlignment> ptr_size_alignment{};
130    for (size_t i = 0; i < 1000; ++i) {
131        // make it a bit more likely to allocate than deallocate
132        if (ptr_size_alignment.empty() || 0 != m_rng.randrange(4)) {
133            // allocate a random item
134            std::size_t alignment = std::size_t{1} << m_rng.randrange(8);          // 1, 2, ..., 128
135            std::size_t size = (m_rng.randrange(200) / alignment + 1) * alignment; // multiple of alignment
136            void* ptr = resource.Allocate(size, alignment);
137            BOOST_TEST(ptr != nullptr);
138            BOOST_TEST((reinterpret_cast<uintptr_t>(ptr) & (alignment - 1)) == 0);
139            ptr_size_alignment.push_back({ptr, size, alignment});
140        } else {
141            // deallocate a random item
142            auto& x = ptr_size_alignment[m_rng.randrange(ptr_size_alignment.size())];
143            resource.Deallocate(x.ptr, x.bytes, x.alignment);
144            x = ptr_size_alignment.back();
145            ptr_size_alignment.pop_back();
146        }
147    }
148
149    // deallocate all the rest
150    for (auto const& x : ptr_size_alignment) {
151        resource.Deallocate(x.ptr, x.bytes, x.alignment);
152    }
153
154    PoolResourceTester::CheckAllDataAccountedFor(resource);
155}
156
157BOOST_AUTO_TEST_CASE(memusage_test)
158{
159    auto std_map = std::unordered_map<int64_t, int64_t>{};
160
161    using Map = std::unordered_map<int64_t,
162                                   int64_t,
163                                   std::hash<int64_t>,
164                                   std::equal_to<int64_t>,
165                                   PoolAllocator<std::pair<const int64_t, int64_t>,
166                                                 sizeof(std::pair<const int64_t, int64_t>) + sizeof(void*) * 4>>;
167    auto resource = Map::allocator_type::ResourceType(1024);
168
169    PoolResourceTester::CheckAllDataAccountedFor(resource);
170
171    {
172        auto resource_map = Map{0, std::hash<int64_t>{}, std::equal_to<int64_t>{}, &resource};
173
174        // can't have the same resource usage
175        BOOST_TEST(memusage::DynamicUsage(std_map) != memusage::DynamicUsage(resource_map));
176
177        for (size_t i = 0; i < 10000; ++i) {
178            std_map[i];
179            resource_map[i];
180        }
181
182        // Eventually the resource_map should have a much lower memory usage because it has less malloc overhead
183        BOOST_TEST(memusage::DynamicUsage(resource_map) <= memusage::DynamicUsage(std_map) * 90 / 100);
184
185        // Make sure the pool is actually used by the nodes
186        auto max_nodes_per_chunk = resource.ChunkSizeBytes() / sizeof(Map::value_type);
187        auto min_num_allocated_chunks = resource_map.size() / max_nodes_per_chunk + 1;
188        BOOST_TEST(resource.NumAllocatedChunks() >= min_num_allocated_chunks);
189    }
190
191    PoolResourceTester::CheckAllDataAccountedFor(resource);
192}
193
194BOOST_AUTO_TEST_SUITE_END()
195

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.