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.

130,367 bytes · SHA-256 324a40ee27419492… · View upstream ↗

1//  __   _ _______ __   _  _____  ______  _______ __   _ _______ _     _
2//  | \  | |_____| | \  | |     | |_____] |______ | \  | |       |_____|
3//  |  \_| |     | |  \_| |_____| |_____] |______ |  \_| |_____  |     |
4//
5// Microbenchmark framework for C++11/14/17/20
6// https://github.com/martinus/nanobench
7//
8// Licensed under the MIT License <http://opensource.org/licenses/MIT>.
9// SPDX-License-Identifier: MIT
10// Copyright (c) 2019-2023 Martin Leitner-Ankerl <[email protected]>
11//
12// Permission is hereby granted, free of charge, to any person obtaining a copy
13// of this software and associated documentation files (the "Software"), to deal
14// in the Software without restriction, including without limitation the rights
15// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16// copies of the Software, and to permit persons to whom the Software is
17// furnished to do so, subject to the following conditions:
18//
19// The above copyright notice and this permission notice shall be included in all
20// copies or substantial portions of the Software.
21//
22// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28// SOFTWARE.
29
30#ifndef ANKERL_NANOBENCH_H_INCLUDED
31#define ANKERL_NANOBENCH_H_INCLUDED
32
33// see https://semver.org/
34#define ANKERL_NANOBENCH_VERSION_MAJOR 4  // incompatible API changes
35#define ANKERL_NANOBENCH_VERSION_MINOR 3  // backwards-compatible changes
36#define ANKERL_NANOBENCH_VERSION_PATCH 11 // backwards-compatible bug fixes
37
38///////////////////////////////////////////////////////////////////////////////////////////////////
39// public facing api - as minimal as possible
40///////////////////////////////////////////////////////////////////////////////////////////////////
41
42#include <chrono>        // high_resolution_clock
43#include <cassert>       // assert
44#include <cstdint>
45#include <cstring>       // memcpy
46// IWYU will only see this header with ANKERL_NANOBENCH_IMPLEMENT defined, which
47// makes it suggest removing forward declarations for the Input/output library.
48// IWYU pragma: begin_keep
49#include <iosfwd>        // for std::ostream* custom output target in Config
50// IWYU pragma: end_keep
51#include <limits>
52#include <ratio>
53#include <string>        // all names
54#include <type_traits>
55#include <unordered_map> // holds context information of results
56#include <utility>
57#include <vector>        // holds all results
58
59#define ANKERL_NANOBENCH(x) ANKERL_NANOBENCH_PRIVATE_##x()
60
61#define ANKERL_NANOBENCH_PRIVATE_CXX() __cplusplus
62#define ANKERL_NANOBENCH_PRIVATE_CXX98() 199711L
63#define ANKERL_NANOBENCH_PRIVATE_CXX11() 201103L
64#define ANKERL_NANOBENCH_PRIVATE_CXX14() 201402L
65#define ANKERL_NANOBENCH_PRIVATE_CXX17() 201703L
66
67#if ANKERL_NANOBENCH(CXX) >= ANKERL_NANOBENCH(CXX17)
68#    define ANKERL_NANOBENCH_PRIVATE_NODISCARD() [[nodiscard]]
69#else
70#    define ANKERL_NANOBENCH_PRIVATE_NODISCARD()
71#endif
72
73#if defined(__clang__)
74#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_PADDED_PUSH() \
75        _Pragma("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wpadded\"")
76#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_PADDED_POP() _Pragma("clang diagnostic pop")
77#else
78#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_PADDED_PUSH()
79#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_PADDED_POP()
80#endif
81
82#if defined(__GNUC__)
83#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_EFFCPP_PUSH() _Pragma("GCC diagnostic push") _Pragma("GCC diagnostic ignored \"-Weffc++\"")
84#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_EFFCPP_POP() _Pragma("GCC diagnostic pop")
85#else
86#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_EFFCPP_PUSH()
87#    define ANKERL_NANOBENCH_PRIVATE_IGNORE_EFFCPP_POP()
88#endif
89
90#if defined(ANKERL_NANOBENCH_LOG_ENABLED)
91#    include <iostream>
92#    define ANKERL_NANOBENCH_LOG(x)                                                 \
93        do {                                                                        \
94            std::cout << __FUNCTION__ << "@" << __LINE__ << ": " << x << std::endl; \
95        } while (0)
96#else
97#    define ANKERL_NANOBENCH_LOG(x) \
98        do {                        \
99        } while (0)
100#endif
101
102#define ANKERL_NANOBENCH_PRIVATE_PERF_COUNTERS() 0
103#if defined(__linux__) && !defined(ANKERL_NANOBENCH_DISABLE_PERF_COUNTERS)
104#    include <linux/version.h>
105#    if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 3, 0)
106// PERF_COUNT_HW_REF_CPU_CYCLES only available since kernel 3.3
107// PERF_FLAG_FD_CLOEXEC since kernel 3.14
108#        undef ANKERL_NANOBENCH_PRIVATE_PERF_COUNTERS
109#        define ANKERL_NANOBENCH_PRIVATE_PERF_COUNTERS() 1
110#    endif
111#endif
112
113#if defined(__clang__)
114#    define ANKERL_NANOBENCH_NO_SANITIZE(...) __attribute__((no_sanitize(__VA_ARGS__)))
115#else
116#    define ANKERL_NANOBENCH_NO_SANITIZE(...)
117#endif
118
119#if defined(_MSC_VER)
120#    define ANKERL_NANOBENCH_PRIVATE_NOINLINE() __declspec(noinline)
121#else
122#    define ANKERL_NANOBENCH_PRIVATE_NOINLINE() __attribute__((noinline))
123#endif
124
125// workaround missing "is_trivially_copyable" in g++ < 5.0
126// See https://stackoverflow.com/a/31798726/48181
127#if defined(__GNUC__) && __GNUC__ < 5
128#    define ANKERL_NANOBENCH_IS_TRIVIALLY_COPYABLE(...) __has_trivial_copy(__VA_ARGS__)
129#else
130#    define ANKERL_NANOBENCH_IS_TRIVIALLY_COPYABLE(...) std::is_trivially_copyable<__VA_ARGS__>::value
131#endif
132
133// noexcept may be missing for std::string.
134// See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=58265
135#define ANKERL_NANOBENCH_PRIVATE_NOEXCEPT_STRING_MOVE() std::is_nothrow_move_assignable<std::string>::value
136
137// declarations ///////////////////////////////////////////////////////////////////////////////////
138
139// As definitions follow these declarations within this
140// header, IWYU considers some of them redundant and
141// suggests removing them. Disable this IWYU behavior.
142// IWYU pragma: begin_keep
143
144namespace ankerl {
145namespace nanobench {
146
147using Clock = std::conditional<std::chrono::high_resolution_clock::is_steady, std::chrono::high_resolution_clock,
148                               std::chrono::steady_clock>::type;
149class Bench;
150struct Config;
151class Result;
152class Rng;
153class BigO;
154
155namespace detail {
156template <typename SetupOp>
157class SetupRunner;
158} // namespace detail
159
160/**
161 * @brief Renders output from a mustache-like template and benchmark results.
162 *
163 * The templating facility here is heavily inspired by [mustache - logic-less templates](https://mustache.github.io/).
164 * It adds a few more features that are necessary to get all of the captured data out of nanobench. Please read the
165 * excellent [mustache manual](https://mustache.github.io/mustache.5.html) to see what this is all about.
166 *
167 * nanobench output has two nested layers, *result* and *measurement*.  Here is a hierarchy of the allowed tags:
168 *
169 * * `{{#result}}` Marks the begin of the result layer. Whatever comes after this will be instantiated as often as
170 *   a benchmark result is available. Within it, you can use these tags:
171 *
172 *    * `{{title}}` See Bench::title.
173 *
174 *    * `{{name}}` Benchmark name, usually directly provided with Bench::run, but can also be set with Bench::name.
175 *
176 *    * `{{unit}}` Unit, e.g. `byte`. Defaults to `op`, see Bench::unit.
177 *
178 *    * `{{batch}}` Batch size, see Bench::batch.
179 *
180 *    * `{{complexityN}}` Value used for asymptotic complexity calculation. See Bench::complexityN.
181 *
182 *    * `{{epochs}}` Number of epochs, see Bench::epochs.
183 *
184 *    * `{{clockResolution}}` Accuracy of the clock, i.e. what's the smallest time possible to measure with the clock.
185 *      For modern systems, this can be around 20 ns. This value is automatically determined by nanobench at the first
186 *      benchmark that is run, and used as a static variable throughout the application's runtime.
187 *
188 *    * `{{clockResolutionMultiple}}` Configuration multiplier for `clockResolution`. See Bench::clockResolutionMultiple.
189 *      This is the target runtime for each measurement (epoch). That means the more accurate your clock is, the faster
190 *      will be the benchmark. Basing the measurement's runtime on the clock resolution is the main reason why nanobench is so fast.
191 *
192 *    * `{{maxEpochTime}}` Configuration for a maximum time each measurement (epoch) is allowed to take. Note that at least
193 *      a single iteration will be performed, even when that takes longer than maxEpochTime. See Bench::maxEpochTime.
194 *
195 *    * `{{minEpochTime}}` Minimum epoch time, defaults to 1ms. See Bench::minEpochTime.
196 *
197 *    * `{{minEpochIterations}}` See Bench::minEpochIterations.
198 *
199 *    * `{{epochIterations}}` See Bench::epochIterations.
200 *
201 *    * `{{warmup}}` Number of iterations used before measuring starts. See Bench::warmup.
202 *
203 *    * `{{relative}}` True or false, depending on the setting you have used. See Bench::relative.
204 *
205 *    * `{{context(variableName)}}` See Bench::context.
206 *
207 *    Apart from these tags, it is also possible to use some mathematical operations on the measurement data. The operations
208 *    are of the form `{{command(name)}}`.  Currently `name` can be one of `elapsed`, `iterations`. If performance counters
209 *    are available (currently only on current Linux systems), you also have `pagefaults`, `cpucycles`,
210 *    `contextswitches`, `instructions`, `branchinstructions`, and `branchmisses`. All the measures (except `iterations`) are
211 *    provided for a single iteration (so `elapsed` is the time a single iteration took). The following tags are available:
212 *
213 *    * `{{median(<name>)}}` Calculate median of a measurement data set, e.g. `{{median(elapsed)}}`.
214 *
215 *    * `{{average(<name>)}}` Average (mean) calculation.
216 *
217 *    * `{{medianAbsolutePercentError(<name>)}}` Calculates MdAPE, the Median Absolute Percentage Error. The MdAPE is an excellent
218 *      metric for the variation of measurements. It is more robust to outliers than the
219 *      [Mean absolute percentage error (M-APE)](https://en.wikipedia.org/wiki/Mean_absolute_percentage_error).
220 *      @f[
221 *       \mathrm{MdAPE}(e) = \mathrm{med}\{| \frac{e_i - \mathrm{med}\{e\}}{e_i}| \}
222 *      @f]
223 *      E.g. for *elapsed*: First, @f$ \mathrm{med}\{e\} @f$ calculates the median by sorting and then taking the middle element
224 *      of all *elapsed* measurements. This is used to calculate the absolute percentage
225 *      error to this median for each measurement, as in  @f$ | \frac{e_i - \mathrm{med}\{e\}}{e_i}| @f$. All these results
226 *      are sorted, and the middle value is chosen as the median absolute percent error.
227 *
228 *      This measurement is a bit hard to interpret, but it is very robust against outliers. E.g. a value of 5% means that half of the
229 *      measurements deviate less than 5% from the median, and the other deviate more than 5% from the median.
230 *
231 *    * `{{sum(<name>)}}` Sum of all the measurements. E.g. `{{sum(iterations)}}` will give you the total number of iterations
232*        measured in this benchmark.
233 *
234 *    * `{{minimum(<name>)}}` Minimum of all measurements.
235 *
236 *    * `{{maximum(<name>)}}` Maximum of all measurements.
237 *
238 *    * `{{sumProduct(<first>, <second>)}}` Calculates the sum of the products of corresponding measures:
239 *      @f[
240 *          \mathrm{sumProduct}(a,b) = \sum_{i=1}^{n}a_i\cdot b_i
241 *      @f]
242 *      E.g. to calculate total runtime of the benchmark, you multiply iterations with elapsed time for each measurement, and
243 *      sum these results up:
244 *      `{{sumProduct(iterations, elapsed)}}`.
245 *
246 *    * `{{#measurement}}` To access individual measurement results, open the begin tag for measurements.
247 *
248 *       * `{{elapsed}}` Average elapsed wall clock time per iteration, in seconds.
249 *
250 *       * `{{iterations}}` Number of iterations in the measurement. The number of iterations will fluctuate due

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.