mirror of
https://github.com/Retropex/bitcoin.git
synced 2025-06-02 15:32:34 +02:00
5ca28ef28b
Instead of having a single NodeContext::shutdown member that is used both to request shutdowns and check if they have been requested, use separate members for each. Benefits of this change: 1. Should make code a little clearer and easier to search because it is easier to see which parts of code are triggering shutdowns and which parts are just checking to see if they were triggered. 2. Makes it possible for init.cpp to specify additional code to run when a shutdown is requested, like signalling the m_tip_block_cv condition variable. Motivation for this change was to remove hacky NodeContext argument and m_tip_block_cv access from the StopRPC function, so StopRPC can just be concerned with RPC functionality, not other node functionality.
73 lines
2.3 KiB
C++
73 lines
2.3 KiB
C++
// Copyright (c) 2023 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_KERNEL_NOTIFICATIONS_H
|
|
#define BITCOIN_NODE_KERNEL_NOTIFICATIONS_H
|
|
|
|
#include <kernel/notifications_interface.h>
|
|
|
|
#include <sync.h>
|
|
#include <threadsafety.h>
|
|
#include <uint256.h>
|
|
|
|
#include <atomic>
|
|
#include <cstdint>
|
|
#include <functional>
|
|
|
|
class ArgsManager;
|
|
class CBlockIndex;
|
|
enum class SynchronizationState;
|
|
struct bilingual_str;
|
|
|
|
namespace kernel {
|
|
enum class Warning;
|
|
} // namespace kernel
|
|
|
|
namespace node {
|
|
|
|
class Warnings;
|
|
static constexpr int DEFAULT_STOPATHEIGHT{0};
|
|
|
|
class KernelNotifications : public kernel::Notifications
|
|
{
|
|
public:
|
|
KernelNotifications(const std::function<bool()>& shutdown_request, std::atomic<int>& exit_status, node::Warnings& warnings)
|
|
: m_shutdown_request(shutdown_request), m_exit_status{exit_status}, m_warnings{warnings} {}
|
|
|
|
[[nodiscard]] kernel::InterruptResult blockTip(SynchronizationState state, CBlockIndex& index) override EXCLUSIVE_LOCKS_REQUIRED(!m_tip_block_mutex);
|
|
|
|
void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override;
|
|
|
|
void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override;
|
|
|
|
void warningSet(kernel::Warning id, const bilingual_str& message) override;
|
|
|
|
void warningUnset(kernel::Warning id) override;
|
|
|
|
void flushError(const bilingual_str& message) override;
|
|
|
|
void fatalError(const bilingual_str& message) override;
|
|
|
|
//! Block height after which blockTip notification will return Interrupted{}, if >0.
|
|
int m_stop_at_height{DEFAULT_STOPATHEIGHT};
|
|
//! Useful for tests, can be set to false to avoid shutdown on fatal error.
|
|
bool m_shutdown_on_fatal_error{true};
|
|
|
|
Mutex m_tip_block_mutex;
|
|
std::condition_variable m_tip_block_cv GUARDED_BY(m_tip_block_mutex);
|
|
//! The block for which the last blockTip notification was received for.
|
|
uint256 m_tip_block GUARDED_BY(m_tip_block_mutex);
|
|
|
|
private:
|
|
const std::function<bool()>& m_shutdown_request;
|
|
std::atomic<int>& m_exit_status;
|
|
node::Warnings& m_warnings;
|
|
};
|
|
|
|
void ReadNotificationArgs(const ArgsManager& args, KernelNotifications& notifications);
|
|
|
|
} // namespace node
|
|
|
|
#endif // BITCOIN_NODE_KERNEL_NOTIFICATIONS_H
|