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.

11,907 bytes · SHA-256 0a6aaed11c3fc962… · View upstream ↗

1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_LOGGING_H
7#define BITCOIN_LOGGING_H
8
9#include <crypto/siphash.h>
10#include <logging/categories.h> // IWYU pragma: export
11#include <span.h>
12#include <util/byte_units.h>
13#include <util/fs.h>
14#include <util/log.h> // IWYU pragma: export
15#include <util/stdmutex.h>
16#include <util/string.h>
17#include <util/time.h>
18
19#include <atomic>
20#include <cstdint>
21#include <cstring>
22#include <functional>
23#include <list>
24#include <memory>
25#include <optional>
26#include <string>
27#include <unordered_map>
28#include <vector>
29
30inline constexpr bool DEFAULT_LOGTIMEMICROS = false;
31inline constexpr bool DEFAULT_LOGIPS        = false;
32inline constexpr bool DEFAULT_LOGTIMESTAMPS = true;
33inline constexpr bool DEFAULT_LOGTHREADNAMES = false;
34inline constexpr bool DEFAULT_LOGSOURCELOCATIONS = false;
35inline constexpr bool DEFAULT_LOGLEVELALWAYS = false;
36extern const char * const DEFAULT_DEBUGLOGFILE;
37
38extern bool fLogIPs;
39
40struct SourceLocationEqual {
41    bool operator()(const SourceLocation& lhs, const SourceLocation& rhs) const noexcept
42    {
43        return lhs.line() == rhs.line() && std::string_view(lhs.file_name()) == std::string_view(rhs.file_name());
44    }
45};
46
47struct SourceLocationHasher {
48    size_t operator()(const SourceLocation& s) const noexcept
49    {
50        // Use CSipHasher(0, 0) as a simple way to get uniform distribution.
51        return size_t(CSipHasher(0, 0)
52                      .Write(s.line())
53                      .Write(MakeUCharSpan(std::string_view{s.file_name()}))
54                      .Finalize());
55    }
56};
57
58struct LogCategory {
59    std::string category;
60    bool active;
61};
62
63namespace BCLog {
64    constexpr auto DEFAULT_LOG_LEVEL{Level::Debug};
65    constexpr size_t DEFAULT_MAX_LOG_BUFFER{1'000'000}; // buffer up to 1MB of log data prior to StartLogging
66    constexpr uint64_t RATELIMIT_MAX_BYTES{1_MiB}; // maximum number of bytes per source location that can be logged within the RATELIMIT_WINDOW
67    constexpr auto RATELIMIT_WINDOW{1h}; // time window after which log ratelimit stats are reset
68    constexpr bool DEFAULT_LOGRATELIMIT{true};
69
70    //! Fixed window rate limiter for logging.
71    class LogRateLimiter
72    {
73    public:
74        //! Keeps track of an individual source location and how many available bytes are left for logging from it.
75        struct Stats {
76            //! Remaining bytes
77            uint64_t m_available_bytes;
78            //! Number of bytes that were consumed but didn't fit in the available bytes.
79            uint64_t m_dropped_bytes{0};
80
81            Stats(uint64_t max_bytes) : m_available_bytes{max_bytes} {}
82            //! Updates internal accounting and returns true if enough available_bytes were remaining
83            bool Consume(uint64_t bytes);
84        };
85
86    private:
87        mutable StdMutex m_mutex;
88
89        //! Stats for each source location that has attempted to log something.
90        std::unordered_map<SourceLocation, Stats, SourceLocationHasher, SourceLocationEqual> m_source_locations GUARDED_BY(m_mutex);
91        //! Whether any log locations are suppressed. Cached view on m_source_locations for performance reasons.
92        std::atomic<bool> m_suppression_active{false};
93        LogRateLimiter(uint64_t max_bytes, std::chrono::seconds reset_window);
94
95    public:
96        using SchedulerFunction = std::function<void(std::function<void()>, std::chrono::milliseconds)>;
97        /**
98         * @param scheduler_func    Callable object used to schedule resetting the window. The first
99         *                          parameter is the function to be executed, and the second is the
100         *                          reset_window interval.
101         * @param max_bytes         Maximum number of bytes that can be logged for each source
102         *                          location.
103         * @param reset_window      Time window after which the stats are reset.
104         */
105        static std::shared_ptr<LogRateLimiter> Create(
106            SchedulerFunction&& scheduler_func,
107            uint64_t max_bytes,
108            std::chrono::seconds reset_window);
109        //! Maximum number of bytes logged per location per window.
110        const uint64_t m_max_bytes;
111        //! Interval after which the window is reset.
112        const std::chrono::seconds m_reset_window;
113        //! Suppression status of a source log location.
114        enum class Status {
115            UNSUPPRESSED,     // string fits within the limit
116            NEWLY_SUPPRESSED, // suppression has started since this string
117            STILL_SUPPRESSED, // suppression is still ongoing
118        };
119        //! Consumes `source_loc`'s available bytes corresponding to the size of the (formatted)
120        //! `str` and returns its status.
121        [[nodiscard]] Status Consume(
122            const SourceLocation& source_loc,
123            const std::string& str) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
124        //! Resets all usage to zero. Called periodically by the scheduler.
125        void Reset() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
126        //! Returns true if any log locations are currently being suppressed.
127        bool SuppressionsActive() const { return m_suppression_active; }
128    };
129
130    class Logger
131    {
132    private:
133        mutable StdMutex m_cs; // Can not use Mutex from sync.h because in debug mode it would cause a deadlock when a potential deadlock was detected
134
135        FILE* m_fileout GUARDED_BY(m_cs) = nullptr;
136        std::list<util::log::Entry> m_msgs_before_open GUARDED_BY(m_cs);
137        bool m_buffering GUARDED_BY(m_cs) = true; //!< Buffer messages before logging can be started.
138        size_t m_max_buffer_memusage GUARDED_BY(m_cs){DEFAULT_MAX_LOG_BUFFER};
139        size_t m_cur_buffer_memusage GUARDED_BY(m_cs){0};
140        size_t m_buffer_lines_discarded GUARDED_BY(m_cs){0};
141
142        //! Manages the rate limiting of each log location.
143        std::shared_ptr<LogRateLimiter> m_limiter GUARDED_BY(m_cs);
144
145        //! Category-specific log level. Overrides `m_log_level`.
146        std::unordered_map<LogFlags, Level> m_category_log_levels GUARDED_BY(m_cs);
147
148        //! If there is no category-specific log level, all logs with a severity
149        //! level lower than `m_log_level` will be ignored.
150        std::atomic<Level> m_log_level{DEFAULT_LOG_LEVEL};
151
152        /** Log categories bitfield. */
153        std::atomic<CategoryMask> m_categories{BCLog::NONE};
154
155        std::string Format(const util::log::Entry& entry) const;
156
157        std::string LogTimestampStr(SystemClock::time_point now, std::chrono::seconds mocktime) const;
158
159        /** Slots that connect to the print signal */
160        std::list<std::function<void(const std::string&)>> m_print_callbacks GUARDED_BY(m_cs){};
161
162        /** Send an entry to the log output (internal) */
163        void LogPrint_(util::log::Entry log_entry) EXCLUSIVE_LOCKS_REQUIRED(m_cs);
164
165        std::string GetLogPrefix(LogFlags category, Level level) const;
166
167    public:
168        bool m_print_to_console = false;
169        bool m_print_to_file = false;
170
171        bool m_log_timestamps = DEFAULT_LOGTIMESTAMPS;
172        bool m_log_time_micros = DEFAULT_LOGTIMEMICROS;
173        bool m_log_threadnames = DEFAULT_LOGTHREADNAMES;
174        bool m_log_sourcelocations = DEFAULT_LOGSOURCELOCATIONS;
175        bool m_always_print_category_level = DEFAULT_LOGLEVELALWAYS;
176
177        fs::path m_file_path;
178        std::atomic<bool> m_reopen_file{false};
179
180        /** Send an entry to the log output */
181        void LogPrint(util::log::Entry log_entry) EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
182
183        /** Returns whether logs will be written to any output */
184        bool Enabled() const EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
185        {
186            STDLOCK(m_cs);
187            return m_buffering || m_print_to_console || m_print_to_file || !m_print_callbacks.empty();
188        }
189
190        /** Connect a slot to the print signal and return the connection */
191        std::list<std::function<void(const std::string&)>>::iterator PushBackCallback(std::function<void(const std::string&)> fun) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
192        {
193            STDLOCK(m_cs);
194            m_print_callbacks.push_back(std::move(fun));
195            return --m_print_callbacks.end();
196        }
197
198        /** Delete a connection */
199        void DeleteCallback(std::list<std::function<void(const std::string&)>>::iterator it) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
200        {
201            STDLOCK(m_cs);
202            m_print_callbacks.erase(it);
203        }
204
205        size_t NumConnections() EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
206        {
207            STDLOCK(m_cs);
208            return m_print_callbacks.size();
209        }
210
211        /** Start logging (and flush all buffered messages) */
212        bool StartLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
213        /** Only for testing */
214        void DisconnectTestLogger() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
215
216        void SetRateLimiting(std::shared_ptr<LogRateLimiter> limiter) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
217        {
218            STDLOCK(m_cs);
219            m_limiter = std::move(limiter);
220        }
221
222        /** Disable logging
223         * This offers a slight speedup and slightly smaller memory usage
224         * compared to leaving the logging system in its default state.
225         * Mostly intended for libbitcoin-kernel apps that don't want any logging.
226         * Should be used instead of StartLogging().
227         */
228        void DisableLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
229
230        void ShrinkDebugFile() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
231
232        std::unordered_map<LogFlags, Level> CategoryLevels() const EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
233        {
234            STDLOCK(m_cs);
235            return m_category_log_levels;
236        }
237        void SetCategoryLogLevel(const std::unordered_map<LogFlags, Level>& levels) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
238        {
239            STDLOCK(m_cs);
240            m_category_log_levels = levels;
241        }
242        void AddCategoryLogLevel(LogFlags category, Level level) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
243        {
244            STDLOCK(m_cs);
245            m_category_log_levels[category] = level;
246        }
247        bool SetCategoryLogLevel(std::string_view category_str, std::string_view level_str) EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
248
249        Level LogLevel() const { return m_log_level.load(); }
250        void SetLogLevel(Level level) { m_log_level = level; }

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.