refactor: remove warnings globals

This commit is contained in:
stickies-v
2024-05-07 14:21:35 +01:00
parent 9c4b0b7ce4
commit 260f8da71a
27 changed files with 87 additions and 51 deletions

View File

@@ -15,9 +15,9 @@
namespace node {
void AbortNode(util::SignalInterrupt* shutdown, std::atomic<int>& exit_status, const bilingual_str& message)
void AbortNode(util::SignalInterrupt* shutdown, std::atomic<int>& exit_status, const bilingual_str& message, node::Warnings* warnings)
{
g_warnings.Set(Warning::FATAL_INTERNAL_ERROR, message);
if (warnings) warnings->Set(Warning::FATAL_INTERNAL_ERROR, message);
InitError(_("A fatal internal error occurred, see debug.log for details: ") + message);
exit_status.store(EXIT_FAILURE);
if (shutdown && !(*shutdown)()) {

View File

@@ -14,7 +14,8 @@ class SignalInterrupt;
} // namespace util
namespace node {
void AbortNode(util::SignalInterrupt* shutdown, std::atomic<int>& exit_status, const bilingual_str& message);
class Warnings;
void AbortNode(util::SignalInterrupt* shutdown, std::atomic<int>& exit_status, const bilingual_str& message, node::Warnings* warnings);
} // namespace node
#endif // BITCOIN_NODE_ABORT_H

View File

@@ -13,6 +13,7 @@
#include <net_processing.h>
#include <netgroup.h>
#include <node/kernel_notifications.h>
#include <node/warnings.h>
#include <policy/fees.h>
#include <scheduler.h>
#include <txmempool.h>

View File

@@ -39,6 +39,7 @@ class SignalInterrupt;
namespace node {
class KernelNotifications;
class Warnings;
//! NodeContext struct containing references to chain state and connection
//! state.
@@ -81,6 +82,8 @@ struct NodeContext {
//! Issues calls about blocks and transactions
std::unique_ptr<ValidationSignals> validation_signals;
std::atomic<int> exit_status{EXIT_SUCCESS};
//! Manages all the node warnings
std::unique_ptr<node::Warnings> warnings;
//! Declare default constructor and destructor that are not inline, so code
//! instantiating the NodeContext struct doesn't need to #include class

View File

@@ -93,7 +93,7 @@ public:
explicit NodeImpl(NodeContext& context) { setContext(&context); }
void initLogging() override { InitLogging(args()); }
void initParameterInteraction() override { InitParameterInteraction(args()); }
bilingual_str getWarnings() override { return Join(node::g_warnings.GetMessages(), Untranslated("<hr />")); }
bilingual_str getWarnings() override { return Join(Assert(m_context->warnings)->GetMessages(), Untranslated("<hr />")); }
int getExitStatus() override { return Assert(m_context)->exit_status.load(); }
uint32_t getLogCategories() override { return LogInstance().GetCategoryMask(); }
bool baseInitialize() override
@@ -101,6 +101,7 @@ public:
if (!AppInitBasicSetup(args(), Assert(context())->exit_status)) return false;
if (!AppInitParameterInteraction(args())) return false;
m_context->warnings = std::make_unique<node::Warnings>();
m_context->kernel = std::make_unique<kernel::Context>();
m_context->ecc_context = std::make_unique<ECC_Context>();
if (!AppInitSanityChecks(*m_context->kernel)) return false;

View File

@@ -72,25 +72,25 @@ void KernelNotifications::progress(const bilingual_str& title, int progress_perc
void KernelNotifications::warningSet(kernel::Warning id, const bilingual_str& message)
{
if (node::g_warnings.Set(id, message)) {
if (m_warnings.Set(id, message)) {
AlertNotify(message.original);
}
}
void KernelNotifications::warningUnset(kernel::Warning id)
{
g_warnings.Unset(id);
m_warnings.Unset(id);
}
void KernelNotifications::flushError(const bilingual_str& message)
{
AbortNode(&m_shutdown, m_exit_status, message);
AbortNode(&m_shutdown, m_exit_status, message, &m_warnings);
}
void KernelNotifications::fatalError(const bilingual_str& message)
{
node::AbortNode(m_shutdown_on_fatal_error ? &m_shutdown : nullptr,
m_exit_status, message);
m_exit_status, message, &m_warnings);
}
void ReadNotificationArgs(const ArgsManager& args, KernelNotifications& notifications)

View File

@@ -25,12 +25,14 @@ class SignalInterrupt;
namespace node {
class Warnings;
static constexpr int DEFAULT_STOPATHEIGHT{0};
class KernelNotifications : public kernel::Notifications
{
public:
KernelNotifications(util::SignalInterrupt& shutdown, std::atomic<int>& exit_status) : m_shutdown(shutdown), m_exit_status{exit_status} {}
KernelNotifications(util::SignalInterrupt& shutdown, std::atomic<int>& exit_status, node::Warnings& warnings)
: m_shutdown(shutdown), m_exit_status{exit_status}, m_warnings{warnings} {}
[[nodiscard]] kernel::InterruptResult blockTip(SynchronizationState state, CBlockIndex& index) override;
@@ -53,6 +55,7 @@ public:
private:
util::SignalInterrupt& m_shutdown;
std::atomic<int>& m_exit_status;
node::Warnings& m_warnings;
};
void ReadNotificationArgs(const ArgsManager& args, KernelNotifications& notifications);

View File

@@ -48,7 +48,7 @@ bool TimeOffsets::WarnIfOutOfSync() const
// when median == std::numeric_limits<int64_t>::min(), calling std::chrono::abs is UB
auto median{std::max(Median(), std::chrono::seconds(std::numeric_limits<int64_t>::min() + 1))};
if (std::chrono::abs(median) <= WARN_THRESHOLD) {
node::g_warnings.Unset(node::Warning::CLOCK_OUT_OF_SYNC);
m_warnings.Unset(node::Warning::CLOCK_OUT_OF_SYNC);
return false;
}
@@ -61,6 +61,6 @@ bool TimeOffsets::WarnIfOutOfSync() const
"RPC methods to get more info."
), Ticks<std::chrono::minutes>(WARN_THRESHOLD))};
LogWarning("%s\n", msg.original);
node::g_warnings.Set(node::Warning::CLOCK_OUT_OF_SYNC, msg);
m_warnings.Set(node::Warning::CLOCK_OUT_OF_SYNC, msg);
return true;
}

View File

@@ -11,8 +11,16 @@
#include <cstddef>
#include <deque>
namespace node {
class Warnings;
} // namespace node
class TimeOffsets
{
public:
TimeOffsets(node::Warnings& warnings) : m_warnings{warnings} {}
private:
//! Maximum number of timeoffsets stored.
static constexpr size_t MAX_SIZE{50};
//! Minimum difference between system and network time for a warning to be raised.
@@ -23,6 +31,8 @@ class TimeOffsets
* positive offset means our peer's clock is ahead of our local clock. */
std::deque<std::chrono::seconds> m_offsets GUARDED_BY(m_mutex){};
node::Warnings& m_warnings;
public:
/** Add a new time offset sample. */
void Add(std::chrono::seconds offset) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);

View File

@@ -17,8 +17,6 @@
#include <vector>
namespace node {
Warnings g_warnings;
Warnings::Warnings()
{
// Pre-release build warning
@@ -54,17 +52,17 @@ std::vector<bilingual_str> Warnings::GetMessages() const
return messages;
}
UniValue GetWarningsForRpc(bool use_deprecated)
UniValue GetWarningsForRpc(const Warnings& warnings, bool use_deprecated)
{
if (use_deprecated) {
const auto all_warnings{g_warnings.GetMessages()};
return all_warnings.empty() ? "" : all_warnings.back().original;
const auto all_messages{warnings.GetMessages()};
return all_messages.empty() ? "" : all_messages.back().original;
}
UniValue warnings{UniValue::VARR};
for (auto&& warning : g_warnings.GetMessages()) {
warnings.push_back(std::move(warning.original));
UniValue messages{UniValue::VARR};
for (auto&& message : warnings.GetMessages()) {
messages.push_back(std::move(message.original));
}
return warnings;
return messages;
}
} // namespace node

View File

@@ -7,13 +7,13 @@
#define BITCOIN_NODE_WARNINGS_H
#include <sync.h>
#include <util/translation.h>
#include <map>
#include <variant>
#include <vector>
class UniValue;
struct bilingual_str;
namespace kernel {
enum class Warning;
@@ -79,14 +79,12 @@ public:
};
/**
* RPC helper function that wraps g_warnings.GetMessages().
* RPC helper function that wraps warnings.GetMessages().
*
* Returns a UniValue::VSTR with the latest warning if use_deprecated is
* set to true, or a UniValue::VARR with all warnings otherwise.
*/
UniValue GetWarningsForRpc(bool use_deprecated);
extern Warnings g_warnings;
UniValue GetWarningsForRpc(const Warnings& warnings, bool use_deprecated);
} // namespace node
#endif // BITCOIN_NODE_WARNINGS_H