phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-26 03:03:22 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions

log: Use ConstevalFormatString

Browse source 
This changes all logging (including the wallet logging) to produce a
ConstevalFormatString at compile time, so that the format string can be
validated at compile-time.

Also, while touching the wallet logging, avoid a copy of the template
Params by using const Params&.
This commit is contained in:
MarcoFalke 2024-07-29 12:08:48 +02:00
parent fae9b60c4f
commit facbcd4cef
No known key found for this signature in database
5 changed files with 7 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/logging.h
View file

@ -246,7 +246,7 @@ static inline bool LogAcceptCategory(BCLog::LogFlags category, BCLog::Level leve
bool GetLogCategory(BCLog::LogFlags& flag, std::string_view str); bool GetLogCategory(BCLog::LogFlags& flag, std::string_view str);
template <typename... Args> template <typename... Args>
static inline void LogPrintf_(std::string_view logging_function, std::string_view source_file, const int source_line, const BCLog::LogFlags flag, const BCLog::Level level, const char* fmt, const Args&... args) inline void LogPrintFormatInternal(std::string_view logging_function, std::string_view source_file, const int source_line, const BCLog::LogFlags flag, const BCLog::Level level, util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)
{ {
if (LogInstance().Enabled()) { if (LogInstance().Enabled()) {
std::string log_msg; std::string log_msg;
@ -254,13 +254,13 @@ static inline void LogPrintf_(std::string_view logging_function, std::string_vie
log_msg = tfm::format(fmt, args...); log_msg = tfm::format(fmt, args...);
} catch (tinyformat::format_error& fmterr) { } catch (tinyformat::format_error& fmterr) {
/* Original format string will have newline so don't add one here */ /* Original format string will have newline so don't add one here */
log_msg = "Error \"" + std::string(fmterr.what()) + "\" while formatting log message: " + fmt; log_msg = "Error \"" + std::string{fmterr.what()} + "\" while formatting log message: " + fmt.fmt;
} }
LogInstance().LogPrintStr(log_msg, logging_function, source_file, source_line, flag, level); LogInstance().LogPrintStr(log_msg, logging_function, source_file, source_line, flag, level);
} }
} }
#define LogPrintLevel_(category, level, ...) LogPrintf_(__func__, __FILE__, __LINE__, category, level, __VA_ARGS__) #define LogPrintLevel_(category, level, ...) LogPrintFormatInternal(__func__, __FILE__, __LINE__, category, level, __VA_ARGS__)
// Log unconditionally. // Log unconditionally.
// Be conservative when using functions that unconditionally log to debug.log! // Be conservative when using functions that unconditionally log to debug.log!

4
src/wallet/scriptpubkeyman.h
View file

@ -254,9 +254,9 @@ public:
/** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */ /** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */
template <typename... Params> template <typename... Params>
void WalletLogPrintf(const char* fmt, Params... parameters) const void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const
{ {
LogPrintf(("%s " + std::string{fmt}).c_str(), m_storage.GetDisplayName(), parameters...); LogInfo("%s %s", m_storage.GetDisplayName(), tfm::format(wallet_fmt, params...));
}; };
/** Watch-only address added */ /** Watch-only address added */

4
src/wallet/wallet.h
View file

@ -927,9 +927,9 @@ public:
/** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */ /** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */
template <typename... Params> template <typename... Params>
void WalletLogPrintf(const char* fmt, Params... parameters) const void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const
{ {
LogPrintf(("%s " + std::string{fmt}).c_str(), GetDisplayName(), parameters...); LogInfo("%s %s", GetDisplayName(), tfm::format(wallet_fmt, params...));
}; };
/** Upgrade the wallet */ /** Upgrade the wallet */

8
test/lint/lint-format-strings.py
View file

@ -17,15 +17,7 @@ import sys
FUNCTION_NAMES_AND_NUMBER_OF_LEADING_ARGUMENTS = [ FUNCTION_NAMES_AND_NUMBER_OF_LEADING_ARGUMENTS = [
'tfm::format,1', # Assuming tfm::::format(std::ostream&, ... 'tfm::format,1', # Assuming tfm::::format(std::ostream&, ...
'LogError,0',
'LogWarning,0',
'LogInfo,0',
'LogDebug,1',
'LogTrace,1',
'LogPrintf,0',
'LogPrintLevel,2',
'strprintf,0', 'strprintf,0',
'WalletLogPrintf,0',
] ]
RUN_LINT_FILE = 'test/lint/run-lint-format-strings.py' RUN_LINT_FILE = 'test/lint/run-lint-format-strings.py'

5
test/lint/run-lint-format-strings.py
View file

@ -15,11 +15,6 @@ import sys
FALSE_POSITIVES = [ FALSE_POSITIVES = [
("src/clientversion.cpp", "strprintf(_(COPYRIGHT_HOLDERS).translated, COPYRIGHT_HOLDERS_SUBSTITUTION)"), ("src/clientversion.cpp", "strprintf(_(COPYRIGHT_HOLDERS).translated, COPYRIGHT_HOLDERS_SUBSTITUTION)"),
("src/test/translation_tests.cpp", "strprintf(format, arg)"), ("src/test/translation_tests.cpp", "strprintf(format, arg)"),
("src/validationinterface.cpp", "LogDebug(BCLog::VALIDATION, fmt \"\\n\", __VA_ARGS__)"),
("src/wallet/wallet.h", "WalletLogPrintf(const char* fmt, Params... parameters)"),
("src/wallet/wallet.h", "LogPrintf((\"%s \" + std::string{fmt}).c_str(), GetDisplayName(), parameters...)"),
("src/wallet/scriptpubkeyman.h", "WalletLogPrintf(const char* fmt, Params... parameters)"),
("src/wallet/scriptpubkeyman.h", "LogPrintf((\"%s \" + std::string{fmt}).c_str(), m_storage.GetDisplayName(), parameters...)"),
] ]