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 server340 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.

7,344 bytes · SHA-256 7b9ff2858d0b4b33… · View upstream ↗

1// Copyright (c) 2015-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#ifndef BITCOIN_MEMUSAGE_H
6#define BITCOIN_MEMUSAGE_H
7
8#include <indirectmap.h>
9#include <prevector.h>
10#include <support/allocators/pool.h>
11
12#include <cassert>
13#include <cstdlib>
14#include <list>
15#include <map>
16#include <memory>
17#include <set>
18#include <string>
19#include <vector>
20#include <unordered_map>
21#include <unordered_set>
22
23
24namespace memusage
25{
26
27/** Compute the total memory used by allocating alloc bytes. */
28static size_t MallocUsage(size_t alloc);
29
30/** Dynamic memory usage for built-in types is zero. */
31static inline size_t DynamicUsage(const int8_t& v) { return 0; }
32static inline size_t DynamicUsage(const uint8_t& v) { return 0; }
33static inline size_t DynamicUsage(const int16_t& v) { return 0; }
34static inline size_t DynamicUsage(const uint16_t& v) { return 0; }
35static inline size_t DynamicUsage(const int32_t& v) { return 0; }
36static inline size_t DynamicUsage(const uint32_t& v) { return 0; }
37static inline size_t DynamicUsage(const int64_t& v) { return 0; }
38static inline size_t DynamicUsage(const uint64_t& v) { return 0; }
39static inline size_t DynamicUsage(const float& v) { return 0; }
40static inline size_t DynamicUsage(const double& v) { return 0; }
41template<typename X> static inline size_t DynamicUsage(X * const &v) { return 0; }
42template<typename X> static inline size_t DynamicUsage(const X * const &v) { return 0; }
43
44/** Compute the memory used for dynamically allocated but owned data structures.
45 *  For generic data types, this is *not* recursive. DynamicUsage(vector<vector<int> >)
46 *  will compute the memory used for the vector<int>'s, but not for the ints inside.
47 *  This is for efficiency reasons, as these functions are intended to be fast. If
48 *  application data structures require more accurate inner accounting, they should
49 *  iterate themselves, or use more efficient caching + updating on modification.
50 */
51
52static inline size_t MallocUsage(size_t alloc)
53{
54    // Measured on libc6 2.19 on Linux.
55    if (alloc == 0) {
56        return 0;
57    } else if (sizeof(void*) == 8) {
58        return ((alloc + 31) >> 4) << 4;
59    } else if (sizeof(void*) == 4) {
60        return ((alloc + 15) >> 3) << 3;
61    } else {
62        assert(0);
63    }
64}
65
66// STL data structures
67
68template<typename X>
69struct stl_tree_node
70{
71private:
72    int color;
73    void* parent;
74    void* left;
75    void* right;
76    X x;
77};
78
79struct stl_shared_counter
80{
81    /* Various platforms use different sized counters here.
82     * Conservatively assume that they won't be larger than size_t. */
83    void* class_type;
84    size_t use_count;
85    size_t weak_count;
86};
87
88template<typename T, typename Allocator>
89static inline size_t DynamicUsage(const std::vector<T, Allocator>& v)
90{
91    return MallocUsage(v.capacity() * sizeof(T));
92}
93
94static inline size_t DynamicUsage(const std::string& s)
95{
96    const char* s_ptr = reinterpret_cast<const char*>(&s);
97    // Don't count the dynamic memory used for string, if it resides in the
98    // "small string" optimization area (which stores data inside the object itself, up to some
99    // size; 15 bytes in modern libstdc++).
100    if (!std::less{}(s.data(), s_ptr) && !std::greater{}(s.data() + s.size(), s_ptr + sizeof(s))) {
101        return 0;
102    }
103    return MallocUsage(s.capacity());
104}
105
106template<unsigned int N, typename X, typename S, typename D>
107static inline size_t DynamicUsage(const prevector<N, X, S, D>& v)
108{
109    return MallocUsage(v.allocated_memory());
110}
111
112template<typename X, typename Y>
113static inline size_t DynamicUsage(const std::set<X, Y>& s)
114{
115    return MallocUsage(sizeof(stl_tree_node<X>)) * s.size();
116}
117
118template<typename X, typename Y>
119static inline size_t IncrementalDynamicUsage(const std::set<X, Y>& s)
120{
121    return MallocUsage(sizeof(stl_tree_node<X>));
122}
123
124template<typename X, typename Y, typename Z>
125static inline size_t DynamicUsage(const std::map<X, Y, Z>& m)
126{
127    return MallocUsage(sizeof(stl_tree_node<std::pair<const X, Y> >)) * m.size();
128}
129
130template<typename X, typename Y, typename Z>
131static inline size_t IncrementalDynamicUsage(const std::map<X, Y, Z>& m)
132{
133    return MallocUsage(sizeof(stl_tree_node<std::pair<const X, Y> >));
134}
135
136// indirectmap has underlying map with pointer as key
137
138template<typename X, typename Y>
139static inline size_t DynamicUsage(const indirectmap<X, Y>& m)
140{
141    return MallocUsage(sizeof(stl_tree_node<std::pair<const X*, Y> >)) * m.size();
142}
143
144template<typename X, typename Y>
145static inline size_t IncrementalDynamicUsage(const indirectmap<X, Y>& m)
146{
147    return MallocUsage(sizeof(stl_tree_node<std::pair<const X*, Y> >));
148}
149
150template<typename X>
151static inline size_t DynamicUsage(const std::unique_ptr<X>& p)
152{
153    return p ? MallocUsage(sizeof(X)) : 0;
154}
155
156template<typename X>
157static inline size_t DynamicUsage(const std::shared_ptr<X>& p)
158{
159    // A shared_ptr can either use a single continuous memory block for both
160    // the counter and the storage (when using std::make_shared), or separate.
161    // We can't observe the difference, however, so assume the worst.
162    return p ? MallocUsage(sizeof(X)) + MallocUsage(sizeof(stl_shared_counter)) : 0;
163}
164
165template<typename X>
166struct list_node
167{
168private:
169    void* ptr_next;
170    void* ptr_prev;
171    X x;
172};
173
174template<typename X>
175static inline size_t DynamicUsage(const std::list<X>& l)
176{
177    return MallocUsage(sizeof(list_node<X>)) * l.size();
178}
179
180template<typename X>
181struct unordered_node : private X
182{
183private:
184    void* ptr;
185};
186
187template<typename X, typename Y>
188static inline size_t DynamicUsage(const std::unordered_set<X, Y>& s)
189{
190    return MallocUsage(sizeof(unordered_node<X>)) * s.size() + MallocUsage(sizeof(void*) * s.bucket_count());
191}
192
193template<typename X, typename Y, typename Z>
194static inline size_t DynamicUsage(const std::unordered_map<X, Y, Z>& m)
195{
196    return MallocUsage(sizeof(unordered_node<std::pair<const X, Y> >)) * m.size() + MallocUsage(sizeof(void*) * m.bucket_count());
197}
198
199template <class Key, class T, class Hash, class Pred, std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
200static inline size_t DynamicUsage(const std::unordered_map<Key,
201                                                           T,
202                                                           Hash,
203                                                           Pred,
204                                                           PoolAllocator<std::pair<const Key, T>,
205                                                                         MAX_BLOCK_SIZE_BYTES,
206                                                                         ALIGN_BYTES>>& m)
207{
208    auto* pool_resource = m.get_allocator().resource();
209
210    // The allocated chunks are stored in a std::list. Size per node should
211    // therefore be 3 pointers: next, previous, and a pointer to the chunk.
212    size_t estimated_list_node_size = MallocUsage(sizeof(void*) * 3);
213    size_t usage_resource = estimated_list_node_size * pool_resource->NumAllocatedChunks();
214    size_t usage_chunks = MallocUsage(pool_resource->ChunkSizeBytes()) * pool_resource->NumAllocatedChunks();
215    return usage_resource + usage_chunks + MallocUsage(sizeof(void*) * m.bucket_count());
216}
217
218} // namespace memusage
219
220#endif // BITCOIN_MEMUSAGE_H
221

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

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.