mirror of https://github.com/bitcoin/bitcoin.git synced 2026-09-12 13:42:10 +02:00

Files

Ryan Ofsky 735b1cf431 Merge bitcoin/bitcoin#34806 : refactor: logging: Various API improvements

02b2c41103 logging: use util/log.h where possible (Anthony Towns)
57d7495fe5 IWYU fixes (Anthony Towns)
611878b46f scripted-diff: logging: Drop LogAcceptCategory (Anthony Towns)
34332dba2f util/log, logging: Provide ShouldDebugLog and ShouldTraceLog instead of a generic ShouldLog (Anthony Towns)
abea304dd6 logging: Move GetLogCategory into Logger class (Anthony Towns)
58113e5833 util/log: Rename LogPrintLevel_ into detail_ namespace (Anthony Towns)
f69d1ae56d util/log: Provide util::log::NO_RATE_LIMIT to avoid rate limits (Anthony Towns)
72e92d67df logging: Protect ShrinkDebugFile by m_cs (Anthony Towns)
904c0d07bb util/stdmutex: Drop StdLockGuard (Anthony Towns)

Pull request description:

  `ShrinkDebugFile` now takes the logging mutex for its entire run; though it's only called in init so shouldn't have any races in the first place.

  Adds a `NO_RATE_LIMIT` tag that can be used with info/warning/error logs to avoid rate-limiting. This allows `LogPrintLevel_` to be restricted to being an internal API.

  The `GetLogCategory` function is moved out of the global namespace.

  `ShouldLog` is split into separate `ShouldDebugLog` and `ShouldTraceLog` so that filtering checks are somewhat more enforced via function signature checks.

  Redundant `LogAcceptCategory` function is removed.

  More files are pointed at util/log.h instead of logging.h.

ACKs for top commit:
  maflcko:
    review ACK 02b2c41103 📅
  sedited:
    Re-ACK 02b2c41103
  l0rinc:
    untested ACK 02b2c41103
  ryanofsky:
    Code review ACK 02b2c41103435d8dbaa77a526e484066471b2b8c! Overall a lot of nice improvements here.

Tree-SHA512: 3bffdca91afbe5c45a522815fe82e6f4cfa96529a4a243b29aad21234650502d6cac780126b584ee3e7ec129d8fdd50670d8a05036cc5c36e586b8c4c3563970

2026-05-21 23:01:09 -04:00

chain.h

…

echo.h

…

handler.h

…

init.h

…

ipc.h

…

mining.h

…

node.h

…

README.md

…

rpc.h

…

types.h

…

wallet.h

…

README.md

Internal c++ interfaces

The following interfaces are defined here:

Chain — used by wallet to access blockchain and mempool state. Added in #14437, #14711, #15288, and #10973.
ChainClient — used by node to start & stop Chain clients. Added in #14437.
Node — used by GUI to start & stop bitcoin node. Added in #10244.
Wallet — used by GUI to access wallets. Added in #10244.
Handler — returned by handleEvent methods on interfaces above and used to manage lifetimes of event handlers.
Init — used by multiprocess code to access interfaces above on startup. Added in #19160.
Ipc — used by multiprocess code to access Init interface across processes. Added in #19160.
Rpc — used by bitcoin-cli to be able to call RPC methods over a unix socket instead of TCP.

The interfaces above define boundaries between major components of bitcoin code (node, wallet, and gui), making it possible for them to run in different processes, and be tested, developed, and understood independently. These interfaces are not currently designed to be stable or to be used externally.