mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-01-19 06:43:45 +01:00
73133c36aa
Add NodeContext::shutdown variable and start using it to replace the kernel::Context::interrupt variable. The latter can't easily be removed right away but will be removed later in this PR. Moving the interrupt object from the kernel context to the node context increases flexibility of the kernel API so it is possible to use multiple interrupt objects, or avoid creating one if one is not needed. It will also allow getting rid of the kernel::g_context global later in this PR, replacing it with a private SignalInterrupt instance in init.cpp There is no change in behavior in this commit outside of unit tests. In unit tests there should be no visible change either, but internally now each test has its own interrupt variable so the variable will be automatically reset between tests.
85 lines
3.1 KiB
C++
85 lines
3.1 KiB
C++
// Copyright (c) 2019-2022 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_NODE_CONTEXT_H
|
|
#define BITCOIN_NODE_CONTEXT_H
|
|
|
|
#include <kernel/context.h>
|
|
|
|
#include <atomic>
|
|
#include <cassert>
|
|
#include <cstdlib>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
class ArgsManager;
|
|
class AddrMan;
|
|
class BanMan;
|
|
class BaseIndex;
|
|
class CBlockPolicyEstimator;
|
|
class CConnman;
|
|
class CScheduler;
|
|
class CTxMemPool;
|
|
class ChainstateManager;
|
|
class NetGroupManager;
|
|
class PeerManager;
|
|
namespace interfaces {
|
|
class Chain;
|
|
class ChainClient;
|
|
class Init;
|
|
class WalletLoader;
|
|
} // namespace interfaces
|
|
|
|
namespace node {
|
|
class KernelNotifications;
|
|
|
|
//! NodeContext struct containing references to chain state and connection
|
|
//! state.
|
|
//!
|
|
//! This is used by init, rpc, and test code to pass object references around
|
|
//! without needing to declare the same variables and parameters repeatedly, or
|
|
//! to use globals. More variables could be added to this struct (particularly
|
|
//! references to validation objects) to eliminate use of globals
|
|
//! and make code more modular and testable. The struct isn't intended to have
|
|
//! any member functions. It should just be a collection of references that can
|
|
//! be used without pulling in unwanted dependencies or functionality.
|
|
struct NodeContext {
|
|
//! libbitcoin_kernel context
|
|
std::unique_ptr<kernel::Context> kernel;
|
|
//! Init interface for initializing current process and connecting to other processes.
|
|
interfaces::Init* init{nullptr};
|
|
//! Interrupt object used to track whether node shutdown was requested.
|
|
util::SignalInterrupt* shutdown{nullptr};
|
|
std::unique_ptr<AddrMan> addrman;
|
|
std::unique_ptr<CConnman> connman;
|
|
std::unique_ptr<CTxMemPool> mempool;
|
|
std::unique_ptr<const NetGroupManager> netgroupman;
|
|
std::unique_ptr<CBlockPolicyEstimator> fee_estimator;
|
|
std::unique_ptr<PeerManager> peerman;
|
|
std::unique_ptr<ChainstateManager> chainman;
|
|
std::unique_ptr<BanMan> banman;
|
|
ArgsManager* args{nullptr}; // Currently a raw pointer because the memory is not managed by this struct
|
|
std::vector<BaseIndex*> indexes; // raw pointers because memory is not managed by this struct
|
|
std::unique_ptr<interfaces::Chain> chain;
|
|
//! List of all chain clients (wallet processes or other client) connected to node.
|
|
std::vector<std::unique_ptr<interfaces::ChainClient>> chain_clients;
|
|
//! Reference to chain client that should used to load or create wallets
|
|
//! opened by the gui.
|
|
interfaces::WalletLoader* wallet_loader{nullptr};
|
|
std::unique_ptr<CScheduler> scheduler;
|
|
std::function<void()> rpc_interruption_point = [] {};
|
|
std::unique_ptr<KernelNotifications> notifications;
|
|
std::atomic<int> exit_status{EXIT_SUCCESS};
|
|
|
|
//! Declare default constructor and destructor that are not inline, so code
|
|
//! instantiating the NodeContext struct doesn't need to #include class
|
|
//! definitions for all the unique_ptr members.
|
|
NodeContext();
|
|
~NodeContext();
|
|
};
|
|
} // namespace node
|
|
|
|
#endif // BITCOIN_NODE_CONTEXT_H
|