Bitcoin Core  24.99.0
P2P Digital Currency
common.cpp
Go to the documentation of this file.
1 // Copyright (c) 2021 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #if defined(HAVE_CONFIG_H)
7 #endif
8 
9 #include <clientversion.h>
10 #include <fs.h>
11 #include <logging.h>
12 #include <node/interface_ui.h>
13 #include <tinyformat.h>
14 #include <util/string.h>
15 #include <util/system.h>
16 #include <util/time.h>
17 #include <util/translation.h>
18 
19 #include <algorithm>
20 #include <string>
21 #include <vector>
22 
23 namespace init {
25 {
26  argsman.AddArg("-debuglogfile=<file>", strprintf("Specify location of debug log file. Relative paths will be prefixed by a net-specific datadir location. (-nodebuglogfile to disable; default: %s)", DEFAULT_DEBUGLOGFILE), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
27  argsman.AddArg("-debug=<category>", "Output debug and trace logging (default: -nodebug, supplying <category> is optional). "
28  "If <category> is not supplied or if <category> = 1, output all debug and trace logging. <category> can be: " + LogInstance().LogCategoriesString() + ". This option can be specified multiple times to output multiple categories.",
30  argsman.AddArg("-debugexclude=<category>", "Exclude debug and trace logging for a category. Can be used in conjunction with -debug=1 to output debug and trace logging for all categories except the specified category. This option can be specified multiple times to exclude multiple categories.", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
31  argsman.AddArg("-logips", strprintf("Include IP addresses in debug output (default: %u)", DEFAULT_LOGIPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
32  argsman.AddArg("-loglevel=<level>|<category>:<level>", strprintf("Set the global or per-category severity level for logging categories enabled with the -debug configuration option or the logging RPC: %s (default=%s); warning and error levels are always logged. If <category>:<level> is supplied, the setting will override the global one and may be specified multiple times to set multiple category-specific levels. <category> can be: %s.", LogInstance().LogLevelsString(), LogInstance().LogLevelToStr(BCLog::DEFAULT_LOG_LEVEL), LogInstance().LogCategoriesString()), ArgsManager::DISALLOW_NEGATION | ArgsManager::DISALLOW_ELISION | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
33  argsman.AddArg("-logtimestamps", strprintf("Prepend debug output with timestamp (default: %u)", DEFAULT_LOGTIMESTAMPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
34 #ifdef HAVE_THREAD_LOCAL
35  argsman.AddArg("-logthreadnames", strprintf("Prepend debug output with name of the originating thread (only available on platforms supporting thread_local) (default: %u)", DEFAULT_LOGTHREADNAMES), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
36 #else
37  argsman.AddHiddenArgs({"-logthreadnames"});
38 #endif
39  argsman.AddArg("-logsourcelocations", strprintf("Prepend debug output with name of the originating source location (source file, line number and function name) (default: %u)", DEFAULT_LOGSOURCELOCATIONS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
40  argsman.AddArg("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
41  argsman.AddArg("-printtoconsole", "Send trace/debug info to console (default: 1 when no -daemon. To disable logging to file, set -nodebuglogfile)", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
42  argsman.AddArg("-shrinkdebugfile", "Shrink debug.log file on client startup (default: 1 when no -debug)", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
43 }
44 
46 {
47  LogInstance().m_print_to_file = !args.IsArgNegated("-debuglogfile");
49  LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", !args.GetBoolArg("-daemon", false));
52 #ifdef HAVE_THREAD_LOCAL
54 #endif
56 
57  fLogIPs = args.GetBoolArg("-logips", DEFAULT_LOGIPS);
58 }
59 
61 {
62  if (args.IsArgSet("-loglevel")) {
63  for (const std::string& level_str : args.GetArgs("-loglevel")) {
64  if (level_str.find_first_of(':', 3) == std::string::npos) {
65  // user passed a global log level, i.e. -loglevel=<level>
66  if (!LogInstance().SetLogLevel(level_str)) {
67  InitWarning(strprintf(_("Unsupported global logging level -loglevel=%s. Valid values: %s."), level_str, LogInstance().LogLevelsString()));
68  }
69  } else {
70  // user passed a category-specific log level, i.e. -loglevel=<category>:<level>
71  const auto& toks = SplitString(level_str, ':');
72  if (!(toks.size() == 2 && LogInstance().SetCategoryLogLevel(toks[0], toks[1]))) {
73  InitWarning(strprintf(_("Unsupported category-specific logging level -loglevel=%s. Expected -loglevel=<category>:<loglevel>. Valid categories: %s. Valid loglevels: %s."), level_str, LogInstance().LogCategoriesString(), LogInstance().LogLevelsString()));
74  }
75  }
76  }
77  }
78 }
79 
81 {
82  if (args.IsArgSet("-debug")) {
83  // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
84  const std::vector<std::string> categories = args.GetArgs("-debug");
85 
86  if (std::none_of(categories.begin(), categories.end(),
87  [](std::string cat){return cat == "0" || cat == "none";})) {
88  for (const auto& cat : categories) {
89  if (!LogInstance().EnableCategory(cat)) {
90  InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
91  }
92  }
93  }
94  }
95 
96  // Now remove the logging categories which were explicitly excluded
97  for (const std::string& cat : args.GetArgs("-debugexclude")) {
98  if (!LogInstance().DisableCategory(cat)) {
99  InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
100  }
101  }
102 }
103 
105 {
106  if (LogInstance().m_print_to_file) {
107  if (args.GetBoolArg("-shrinkdebugfile", LogInstance().DefaultShrinkDebugFile())) {
108  // Do this first since it both loads a bunch of debug.log into memory,
109  // and because this needs to happen before any other debug.log printing
111  }
112  }
113  if (!LogInstance().StartLogging()) {
114  return InitError(strprintf(Untranslated("Could not open debug log file %s"),
115  fs::PathToString(LogInstance().m_file_path)));
116  }
117 
118  if (!LogInstance().m_log_timestamps)
119  LogPrintf("Startup time: %s\n", FormatISO8601DateTime(GetTime()));
120  LogPrintf("Default data directory %s\n", fs::PathToString(GetDefaultDataDir()));
121  LogPrintf("Using data directory %s\n", fs::PathToString(gArgs.GetDataDirNet()));
122 
123  // Only log conf file usage message if conf file actually exists.
124  fs::path config_file_path = GetConfigFile(args.GetPathArg("-conf", BITCOIN_CONF_FILENAME));
125  if (fs::exists(config_file_path)) {
126  LogPrintf("Config file: %s\n", fs::PathToString(config_file_path));
127  } else if (args.IsArgSet("-conf")) {
128  // Warn if no conf file exists at path provided by user
129  InitWarning(strprintf(_("The specified config file %s does not exist"), fs::PathToString(config_file_path)));
130  } else {
131  // Not categorizing as "Warning" because it's the default behavior
132  LogPrintf("Config file: %s (not found, skipping)\n", fs::PathToString(config_file_path));
133  }
134 
135  // Log the config arguments to debug.log
136  args.LogArgs();
137 
138  return true;
139 }
140 
142 {
143  std::string version_string = FormatFullVersion();
144 #ifdef DEBUG
145  version_string += " (debug build)";
146 #else
147  version_string += " (release build)";
148 #endif
149  LogPrintf(PACKAGE_NAME " version %s\n", version_string);
150 }
151 } // namespace init
#define PACKAGE_NAME
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
Definition: system.cpp:599
@ ALLOW_ANY
disable validation
Definition: system.h:180
@ DISALLOW_NEGATION
disallow -nofoo syntax
Definition: system.h:185
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition: system.h:186
@ DEBUG_ONLY
Definition: system.h:188
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: system.cpp:491
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: system.cpp:500
const fs::path & GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: system.h:303
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
Definition: system.cpp:1124
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: system.cpp:654
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: system.cpp:732
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: system.cpp:711
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: system.cpp:393
bool m_log_sourcelocations
Definition: logging.h:119
fs::path m_file_path
Definition: logging.h:121
bool m_log_time_micros
Definition: logging.h:117
bool m_log_threadnames
Definition: logging.h:118
bool m_log_timestamps
Definition: logging.h:116
void ShrinkDebugFile()
Definition: logging.cpp:454
bool m_print_to_file
Definition: logging.h:114
bool m_print_to_console
Definition: logging.h:113
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:31
std::string FormatFullVersion()
void InitWarning(const bilingual_str &str)
Show warning message.
bool InitError(const bilingual_str &str)
Show error message.
bool fLogIPs
Definition: logging.cpp:41
const char *const DEFAULT_DEBUGLOGFILE
Definition: logging.cpp:17
BCLog::Logger & LogInstance()
Definition: logging.cpp:20
static const bool DEFAULT_LOGTIMESTAMPS
Definition: logging.h:25
static const bool DEFAULT_LOGIPS
Definition: logging.h:24
static const bool DEFAULT_LOGTHREADNAMES
Definition: logging.h:26
static const bool DEFAULT_LOGSOURCELOCATIONS
Definition: logging.h:27
static const bool DEFAULT_LOGTIMEMICROS
Definition: logging.h:23
#define LogPrintf(...)
Definition: logging.h:234
constexpr auto DEFAULT_LOG_LEVEL
Definition: logging.h:79
static bool exists(const path &p)
Definition: fs.h:88
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:150
void AddLoggingArgs(ArgsManager &argsman)
Definition: common.cpp:24
void SetLoggingCategories(const ArgsManager &args)
Definition: common.cpp:80
bool StartLogging(const ArgsManager &args)
Definition: common.cpp:104
void SetLoggingLevel(const ArgsManager &args)
Definition: common.cpp:60
void SetLoggingOptions(const ArgsManager &args)
Definition: common.cpp:45
void LogPackageVersion()
Definition: common.cpp:141
ArgsManager args
std::vector< std::string > SplitString(std::string_view str, char sep)
Definition: string.h:21
int64_t GetTime()
Definition: time.cpp:117
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:119
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1164
bilingual_str _(const char *psz)
Translation function.
Definition: translation.h:65
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:48
fs::path GetDefaultDataDir()
Definition: system.cpp:857
fs::path AbsPathForConfigVal(const fs::path &path, bool net_specific)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
Definition: system.cpp:1424
ArgsManager gArgs
Definition: system.cpp:86
fs::path GetConfigFile(const fs::path &configuration_file_path)
Definition: system.cpp:888
const char *const BITCOIN_CONF_FILENAME
Definition: system.cpp:83