From aaced5633b81b2f08b993106a527e2a0e1d663c1 Mon Sep 17 00:00:00 2001
From: Ben Woosley <ben.woosley@gmail.com>
Date: Mon, 6 Mar 2023 22:01:13 +0100
Subject: [PATCH] refactor: Move error() from util/system.h to logging.h

error is a low-level function with a sole dependency on LogPrintf, which
is defined in logging.h

The background of this commit is an ongoing effort to decouple the
libbitcoinkernel library from the ArgsManager defined in system.h.
Moving the function out of system.h allows including it from a separate
source file without including the ArgsManager definitions from system.h.
---
 src/addrdb.cpp                 | 1 +
 src/index/base.cpp             | 1 +
 src/index/coinstatsindex.cpp   | 1 +
 src/index/txindex.cpp          | 1 +
 src/kernel/coinstats.cpp       | 2 +-
 src/logging.h                  | 7 +++++++
 src/net.cpp                    | 3 ++-
 src/netbase.cpp                | 2 +-
 src/node/blockstorage.cpp      | 1 +
 src/script/signingprovider.cpp | 2 +-
 src/txdb.cpp                   | 2 +-
 src/util/system.h              | 7 -------
 12 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/src/addrdb.cpp b/src/addrdb.cpp
index 7be13c8f1e8..9ae8244d1c0 100644
--- a/src/addrdb.cpp
+++ b/src/addrdb.cpp
@@ -11,6 +11,7 @@
 #include <cstdint>
 #include <fs.h>
 #include <hash.h>
+#include <logging.h>
 #include <logging/timer.h>
 #include <netbase.h>
 #include <netgroup.h>
diff --git a/src/index/base.cpp b/src/index/base.cpp
index 7c570d4534f..8a311296c20 100644
--- a/src/index/base.cpp
+++ b/src/index/base.cpp
@@ -6,6 +6,7 @@
 #include <index/base.h>
 #include <interfaces/chain.h>
 #include <kernel/chain.h>
+#include <logging.h>
 #include <node/blockstorage.h>
 #include <node/context.h>
 #include <node/database_args.h>
diff --git a/src/index/coinstatsindex.cpp b/src/index/coinstatsindex.cpp
index 8cece7d78dd..4d637e217af 100644
--- a/src/index/coinstatsindex.cpp
+++ b/src/index/coinstatsindex.cpp
@@ -7,6 +7,7 @@
 #include <crypto/muhash.h>
 #include <index/coinstatsindex.h>
 #include <kernel/coinstats.h>
+#include <logging.h>
 #include <node/blockstorage.h>
 #include <serialize.h>
 #include <txdb.h>
diff --git a/src/index/txindex.cpp b/src/index/txindex.cpp
index 25ccc3e636d..9095e7afeb7 100644
--- a/src/index/txindex.cpp
+++ b/src/index/txindex.cpp
@@ -5,6 +5,7 @@
 #include <index/txindex.h>
 
 #include <index/disktxpos.h>
+#include <logging.h>
 #include <node/blockstorage.h>
 #include <util/system.h>
 #include <validation.h>
diff --git a/src/kernel/coinstats.cpp b/src/kernel/coinstats.cpp
index 82d7d8c46ba..4b75c387a64 100644
--- a/src/kernel/coinstats.cpp
+++ b/src/kernel/coinstats.cpp
@@ -8,6 +8,7 @@
 #include <coins.h>
 #include <crypto/muhash.h>
 #include <hash.h>
+#include <logging.h>
 #include <node/blockstorage.h>
 #include <primitives/transaction.h>
 #include <script/script.h>
@@ -19,7 +20,6 @@
 #include <uint256.h>
 #include <util/check.h>
 #include <util/overflow.h>
-#include <util/system.h>
 #include <validation.h>
 #include <version.h>
 
diff --git a/src/logging.h b/src/logging.h
index 35fb598cefc..954731d2144 100644
--- a/src/logging.h
+++ b/src/logging.h
@@ -257,4 +257,11 @@ static inline void LogPrintf_(const std::string& logging_function, const std::st
         }                                                 \
     } while (0)
 
+template <typename... Args>
+bool error(const char* fmt, const Args&... args)
+{
+    LogPrintf("ERROR: %s\n", tfm::format(fmt, args...));
+    return false;
+}
+
 #endif // BITCOIN_LOGGING_H
diff --git a/src/net.cpp b/src/net.cpp
index 4e4f2f78be7..d1895b7172c 100644
--- a/src/net.cpp
+++ b/src/net.cpp
@@ -16,12 +16,13 @@
 #include <compat/compat.h>
 #include <consensus/consensus.h>
 #include <crypto/sha256.h>
-#include <node/eviction.h>
 #include <fs.h>
 #include <i2p.h>
+#include <logging.h>
 #include <net_permissions.h>
 #include <netaddress.h>
 #include <netbase.h>
+#include <node/eviction.h>
 #include <node/interface_ui.h>
 #include <protocol.h>
 #include <random.h>
diff --git a/src/netbase.cpp b/src/netbase.cpp
index 797f1e17f29..f39a3635f4a 100644
--- a/src/netbase.cpp
+++ b/src/netbase.cpp
@@ -6,12 +6,12 @@
 #include <netbase.h>
 
 #include <compat/compat.h>
+#include <logging.h>
 #include <sync.h>
 #include <tinyformat.h>
 #include <util/sock.h>
 #include <util/strencodings.h>
 #include <util/string.h>
-#include <util/system.h>
 #include <util/time.h>
 
 #include <atomic>
diff --git a/src/node/blockstorage.cpp b/src/node/blockstorage.cpp
index c0a25572fc6..255b73b3472 100644
--- a/src/node/blockstorage.cpp
+++ b/src/node/blockstorage.cpp
@@ -11,6 +11,7 @@
 #include <flatfile.h>
 #include <fs.h>
 #include <hash.h>
+#include <logging.h>
 #include <pow.h>
 #include <reverse_iterator.h>
 #include <shutdown.h>
diff --git a/src/script/signingprovider.cpp b/src/script/signingprovider.cpp
index 5123dd81ac6..ef055573b97 100644
--- a/src/script/signingprovider.cpp
+++ b/src/script/signingprovider.cpp
@@ -7,7 +7,7 @@
 #include <script/signingprovider.h>
 #include <script/standard.h>
 
-#include <util/system.h>
+#include <logging.h>
 
 const SigningProvider& DUMMY_SIGNING_PROVIDER = SigningProvider();
 
diff --git a/src/txdb.cpp b/src/txdb.cpp
index 7257fb49590..15351a43554 100644
--- a/src/txdb.cpp
+++ b/src/txdb.cpp
@@ -6,11 +6,11 @@
 #include <txdb.h>
 
 #include <chain.h>
+#include <logging.h>
 #include <pow.h>
 #include <random.h>
 #include <shutdown.h>
 #include <uint256.h>
-#include <util/system.h>
 #include <util/translation.h>
 #include <util/vector.h>
 
diff --git a/src/util/system.h b/src/util/system.h
index 2d07e643454..7292262bea4 100644
--- a/src/util/system.h
+++ b/src/util/system.h
@@ -43,13 +43,6 @@ extern const char * const BITCOIN_SETTINGS_FILENAME;
 void SetupEnvironment();
 bool SetupNetworking();
 
-template<typename... Args>
-bool error(const char* fmt, const Args&... args)
-{
-    LogPrintf("ERROR: %s\n", tfm::format(fmt, args...));
-    return false;
-}
-
 /**
  * Ensure file contents are fully committed to disk, using a platform-specific
  * feature analogous to fsync().