diff --git a/doc/release-notes.md b/doc/release-notes.md
index 8c4192067..c926b80a1 100644
--- a/doc/release-notes.md
+++ b/doc/release-notes.md
@@ -1,14 +1,20 @@
# Bitcoin ABC 0.22.5 Release Notes
Bitcoin ABC version 0.22.5 is now available from:
This release includes the following features and fixes:
- The `-upgradewallet` command line flag has been replaced in favor of the `upgradewallet` RPC.
Updated RPCs
------------
- The `getchaintxstats` RPC now returns the additional key of
`window_final_block_height`.
+
+Updated settings
+----------------
+
+- The `-debug=db` logging category, which was deprecated in 0.22.4 and replaced by
+ `-debug=walletdb` to distinguish it from `coindb`, has been removed.
diff --git a/src/logging.cpp b/src/logging.cpp
index 32186e53a..f38a51905 100644
--- a/src/logging.cpp
+++ b/src/logging.cpp
@@ -1,360 +1,352 @@
// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 The Bitcoin Core developers
// Copyright (c) 2017-2019 The Bitcoin developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include
#include
#include
bool fLogIPs = DEFAULT_LOGIPS;
const char *const DEFAULT_DEBUGLOGFILE = "debug.log";
BCLog::Logger &LogInstance() {
/**
* NOTE: the logger instance is leaked on exit. This is ugly, but will be
* cleaned up by the OS/libc. Defining a logger as a global object doesn't
* work since the order of destruction of static/global objects is
* undefined. Consider if the logger gets destroyed, and then some later
* destructor calls LogPrintf, maybe indirectly, and you get a core dump at
* shutdown trying to access the logger. When the shutdown sequence is fully
* audited and tested, explicit destruction of these objects can be
* implemented by changing this from a raw pointer to a std::unique_ptr.
* Since the ~Logger() destructor is never called, the Logger class and all
* its subclasses must have implicitly-defined destructors.
*
* This method of initialization was originally introduced in
* ee3374234c60aba2cc4c5cd5cac1c0aefc2d817c.
*/
static BCLog::Logger *g_logger{new BCLog::Logger()};
return *g_logger;
}
static int FileWriteStr(const std::string &str, FILE *fp) {
return fwrite(str.data(), 1, str.size(), fp);
}
bool BCLog::Logger::StartLogging() {
StdLockGuard scoped_lock(m_cs);
assert(m_buffering);
assert(m_fileout == nullptr);
if (m_print_to_file) {
assert(!m_file_path.empty());
m_fileout = fsbridge::fopen(m_file_path, "a");
if (!m_fileout) {
return false;
}
// Unbuffered.
setbuf(m_fileout, nullptr);
// Add newlines to the logfile to distinguish this execution from the
// last one.
FileWriteStr("\n\n\n\n\n", m_fileout);
}
// Dump buffered messages from before we opened the log.
m_buffering = false;
while (!m_msgs_before_open.empty()) {
const std::string &s = m_msgs_before_open.front();
if (m_print_to_file) {
FileWriteStr(s, m_fileout);
}
if (m_print_to_console) {
fwrite(s.data(), 1, s.size(), stdout);
}
for (const auto &cb : m_print_callbacks) {
cb(s);
}
m_msgs_before_open.pop_front();
}
if (m_print_to_console) {
fflush(stdout);
}
return true;
}
void BCLog::Logger::DisconnectTestLogger() {
StdLockGuard scoped_lock(m_cs);
m_buffering = true;
if (m_fileout != nullptr) {
fclose(m_fileout);
}
m_fileout = nullptr;
m_print_callbacks.clear();
}
struct CLogCategoryDesc {
BCLog::LogFlags flag;
std::string category;
};
const CLogCategoryDesc LogCategories[] = {
{BCLog::NONE, "0"},
{BCLog::NONE, "none"},
{BCLog::NET, "net"},
{BCLog::TOR, "tor"},
{BCLog::MEMPOOL, "mempool"},
{BCLog::HTTP, "http"},
{BCLog::BENCH, "bench"},
{BCLog::ZMQ, "zmq"},
{BCLog::WALLETDB, "walletdb"},
{BCLog::RPC, "rpc"},
{BCLog::ESTIMATEFEE, "estimatefee"},
{BCLog::ADDRMAN, "addrman"},
{BCLog::SELECTCOINS, "selectcoins"},
{BCLog::REINDEX, "reindex"},
{BCLog::CMPCTBLOCK, "cmpctblock"},
{BCLog::RAND, "rand"},
{BCLog::PRUNE, "prune"},
{BCLog::PROXY, "proxy"},
{BCLog::MEMPOOLREJ, "mempoolrej"},
{BCLog::LIBEVENT, "libevent"},
{BCLog::COINDB, "coindb"},
{BCLog::QT, "qt"},
{BCLog::LEVELDB, "leveldb"},
{BCLog::VALIDATION, "validation"},
{BCLog::ALL, "1"},
{BCLog::ALL, "all"},
};
bool GetLogCategory(BCLog::LogFlags &flag, const std::string &str) {
if (str == "") {
flag = BCLog::ALL;
return true;
}
for (const CLogCategoryDesc &category_desc : LogCategories) {
if (category_desc.category == str) {
flag = category_desc.flag;
return true;
}
}
return false;
}
std::string ListLogCategories() {
std::string ret;
int outcount = 0;
for (const CLogCategoryDesc &category_desc : LogCategories) {
// Omit the special cases.
if (category_desc.flag != BCLog::NONE &&
category_desc.flag != BCLog::ALL) {
if (outcount != 0) {
ret += ", ";
}
ret += category_desc.category;
outcount++;
}
}
return ret;
}
std::vector ListActiveLogCategories() {
std::vector ret;
for (const CLogCategoryDesc &category_desc : LogCategories) {
// Omit the special cases.
if (category_desc.flag != BCLog::NONE &&
category_desc.flag != BCLog::ALL) {
CLogCategoryActive catActive;
catActive.category = category_desc.category;
catActive.active = LogAcceptCategory(category_desc.flag);
ret.push_back(catActive);
}
}
return ret;
}
BCLog::Logger::~Logger() {
if (m_fileout) {
fclose(m_fileout);
}
}
std::string BCLog::Logger::LogTimestampStr(const std::string &str) {
std::string strStamped;
if (!m_log_timestamps) {
return str;
}
if (m_started_new_line) {
int64_t nTimeMicros = GetTimeMicros();
strStamped = FormatISO8601DateTime(nTimeMicros / 1000000);
if (m_log_time_micros) {
strStamped.pop_back();
strStamped += strprintf(".%06dZ", nTimeMicros % 1000000);
}
int64_t mocktime = GetMockTime();
if (mocktime) {
strStamped +=
" (mocktime: " + FormatISO8601DateTime(mocktime) + ")";
}
strStamped += ' ' + str;
} else {
strStamped = str;
}
return strStamped;
}
namespace BCLog {
/** Belts and suspenders: make sure outgoing log messages don't contain
* potentially suspicious characters, such as terminal control codes.
*
* This escapes control characters except newline ('\n') in C syntax.
* It escapes instead of removes them to still allow for troubleshooting
* issues where they accidentally end up in strings.
*/
std::string LogEscapeMessage(const std::string &str) {
std::string ret;
for (char ch_in : str) {
uint8_t ch = (uint8_t)ch_in;
if ((ch >= 32 || ch == '\n') && ch != '\x7f') {
ret += ch_in;
} else {
ret += strprintf("\\x%02x", ch);
}
}
return ret;
}
} // namespace BCLog
void BCLog::Logger::LogPrintStr(const std::string &str) {
StdLockGuard scoped_lock(m_cs);
std::string str_prefixed = LogEscapeMessage(str);
if (m_log_threadnames && m_started_new_line) {
str_prefixed.insert(0, "[" + util::ThreadGetInternalName() + "] ");
}
str_prefixed = LogTimestampStr(str_prefixed);
m_started_new_line = !str.empty() && str[str.size() - 1] == '\n';
if (m_buffering) {
// buffer if we haven't started logging yet
m_msgs_before_open.push_back(str_prefixed);
return;
}
if (m_print_to_console) {
// Print to console.
fwrite(str_prefixed.data(), 1, str_prefixed.size(), stdout);
fflush(stdout);
}
for (const auto &cb : m_print_callbacks) {
cb(str_prefixed);
}
if (m_print_to_file) {
assert(m_fileout != nullptr);
// Reopen the log file, if requested.
if (m_reopen_file) {
m_reopen_file = false;
FILE *new_fileout = fsbridge::fopen(m_file_path, "a");
if (new_fileout) {
// unbuffered.
setbuf(m_fileout, nullptr);
fclose(m_fileout);
m_fileout = new_fileout;
}
}
FileWriteStr(str_prefixed, m_fileout);
}
}
void BCLog::Logger::ShrinkDebugFile() {
// Amount of debug.log to save at end when shrinking (must fit in memory)
constexpr size_t RECENT_DEBUG_HISTORY_SIZE = 10 * 1000000;
assert(!m_file_path.empty());
// Scroll debug.log if it's getting too big.
FILE *file = fsbridge::fopen(m_file_path, "r");
// Special files (e.g. device nodes) may not have a size.
size_t log_size = 0;
try {
log_size = fs::file_size(m_file_path);
} catch (const fs::filesystem_error &) {
}
// If debug.log file is more than 10% bigger the RECENT_DEBUG_HISTORY_SIZE
// trim it down by saving only the last RECENT_DEBUG_HISTORY_SIZE bytes.
if (file && log_size > 11 * (RECENT_DEBUG_HISTORY_SIZE / 10)) {
// Restart the file with some of the end.
std::vector vch(RECENT_DEBUG_HISTORY_SIZE, 0);
if (fseek(file, -((long)vch.size()), SEEK_END)) {
LogPrintf("Failed to shrink debug log file: fseek(...) failed\n");
fclose(file);
return;
}
int nBytes = fread(vch.data(), 1, vch.size(), file);
fclose(file);
file = fsbridge::fopen(m_file_path, "w");
if (file) {
fwrite(vch.data(), 1, nBytes, file);
fclose(file);
}
} else if (file != nullptr) {
fclose(file);
}
}
void BCLog::Logger::EnableCategory(LogFlags category) {
m_categories |= category;
}
bool BCLog::Logger::EnableCategory(const std::string &str) {
BCLog::LogFlags flag;
if (!GetLogCategory(flag, str)) {
- if (str == "db") {
- // DEPRECATION: Added in 0.22.4, should start returning an error in
- // a future release
- LogPrintf("Warning: logging category 'db' is deprecated, use "
- "'walletdb' instead\n");
- EnableCategory(BCLog::WALLETDB);
- return true;
- }
return false;
}
EnableCategory(flag);
return true;
}
void BCLog::Logger::DisableCategory(LogFlags category) {
m_categories &= ~category;
}
bool BCLog::Logger::DisableCategory(const std::string &str) {
BCLog::LogFlags flag;
if (!GetLogCategory(flag, str)) {
return false;
}
DisableCategory(flag);
return true;
}
bool BCLog::Logger::WillLogCategory(LogFlags category) const {
// ALL is not meant to be used as a logging category, but only as a mask
// representing all categories.
if (category == BCLog::NONE || category == BCLog::ALL) {
LogPrintf("Error trying to log using a category mask instead of an "
"explicit category.\n");
return true;
}
return (m_categories.load(std::memory_order_relaxed) & category) != 0;
}
bool BCLog::Logger::DefaultShrinkDebugFile() const {
return m_categories != BCLog::NONE;
}