Line data Source code
1 : // Copyright (c) 2021-2022 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)
6 : #include <config/bitcoin-config.h>
7 : #endif
8 :
9 : #include <clientversion.h>
10 : #include <common/args.h>
11 : #include <logging.h>
12 : #include <node/interface_ui.h>
13 : #include <tinyformat.h>
14 : #include <util/fs.h>
15 : #include <util/fs_helpers.h>
16 : #include <util/result.h>
17 : #include <util/string.h>
18 : #include <util/time.h>
19 : #include <util/translation.h>
20 :
21 : #include <algorithm>
22 : #include <string>
23 : #include <vector>
24 :
25 : namespace init {
26 69 : void AddLoggingArgs(ArgsManager& argsman)
27 : {
28 69 : argsman.AddArg("-debuglogfile=<file>", strprintf("Specify location of debug log file (default: %s). Relative paths will be prefixed by a net-specific datadir location. Pass -nodebuglogfile to disable writing the log to a file.", DEFAULT_DEBUGLOGFILE), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
29 138 : argsman.AddArg("-debug=<category>", "Output debug and trace logging (default: -nodebug, supplying <category> is optional). "
30 69 : "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.",
31 69 : ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
32 69 : 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);
33 69 : argsman.AddArg("-logips", strprintf("Include IP addresses in debug output (default: %u)", DEFAULT_LOGIPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
34 69 : 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);
35 69 : argsman.AddArg("-logtimestamps", strprintf("Prepend debug output with timestamp (default: %u)", DEFAULT_LOGTIMESTAMPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
36 : #ifdef HAVE_THREAD_LOCAL
37 69 : 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);
38 : #else
39 : argsman.AddHiddenArgs({"-logthreadnames"});
40 : #endif
41 69 : 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);
42 69 : argsman.AddArg("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
43 69 : 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);
44 69 : argsman.AddArg("-shrinkdebugfile", "Shrink debug.log file on client startup (default: 1 when no -debug)", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
45 69 : }
46 :
47 69 : void SetLoggingOptions(const ArgsManager& args)
48 : {
49 69 : LogInstance().m_print_to_file = !args.IsArgNegated("-debuglogfile");
50 69 : LogInstance().m_file_path = AbsPathForConfigVal(args, args.GetPathArg("-debuglogfile", DEFAULT_DEBUGLOGFILE));
51 69 : LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", !args.GetBoolArg("-daemon", false));
52 69 : LogInstance().m_log_timestamps = args.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
53 69 : LogInstance().m_log_time_micros = args.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
54 : #ifdef HAVE_THREAD_LOCAL
55 69 : LogInstance().m_log_threadnames = args.GetBoolArg("-logthreadnames", DEFAULT_LOGTHREADNAMES);
56 : #endif
57 69 : LogInstance().m_log_sourcelocations = args.GetBoolArg("-logsourcelocations", DEFAULT_LOGSOURCELOCATIONS);
58 :
59 69 : fLogIPs = args.GetBoolArg("-logips", DEFAULT_LOGIPS);
60 69 : }
61 :
62 69 : util::Result<void> SetLoggingLevel(const ArgsManager& args)
63 : {
64 69 : if (args.IsArgSet("-loglevel")) {
65 138 : for (const std::string& level_str : args.GetArgs("-loglevel")) {
66 69 : if (level_str.find_first_of(':', 3) == std::string::npos) {
67 : // user passed a global log level, i.e. -loglevel=<level>
68 69 : if (!LogInstance().SetLogLevel(level_str)) {
69 0 : return util::Error{strprintf(_("Unsupported global logging level %s=%s. Valid values: %s."), "-loglevel", level_str, LogInstance().LogLevelsString())};
70 : }
71 69 : } else {
72 : // user passed a category-specific log level, i.e. -loglevel=<category>:<level>
73 0 : const auto& toks = SplitString(level_str, ':');
74 173 : if (!(toks.size() == 2 && LogInstance().SetCategoryLogLevel(toks[0], toks[1]))) {
75 0 : return util::Error{strprintf(_("Unsupported category-specific logging level %1$s=%2$s. Expected %1$s=<category>:<loglevel>. Valid categories: %3$s. Valid loglevels: %4$s."), "-loglevel", level_str, LogInstance().LogCategoriesString(), LogInstance().LogLevelsString())};
76 : }
77 0 : }
78 : }
79 69 : }
80 69 : return {};
81 69 : }
82 :
83 69 : util::Result<void> SetLoggingCategories(const ArgsManager& args)
84 : {
85 69 : if (args.IsArgSet("-debug")) {
86 : // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
87 69 : const std::vector<std::string> categories = args.GetArgs("-debug");
88 :
89 69 : if (std::none_of(categories.begin(), categories.end(),
90 0 : [](std::string cat){return cat == "0" || cat == "none";})) {
91 69 : for (const auto& cat : categories) {
92 0 : if (!LogInstance().EnableCategory(cat)) {
93 0 : return util::Error{strprintf(_("Unsupported logging category %s=%s."), "-debug", cat)};
94 : }
95 : }
96 69 : }
97 69 : }
98 :
99 : // Now remove the logging categories which were explicitly excluded
100 207 : for (const std::string& cat : args.GetArgs("-debugexclude")) {
101 138 : if (!LogInstance().DisableCategory(cat)) {
102 0 : return util::Error{strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat)};
103 : }
104 : }
105 69 : return {};
106 69 : }
107 :
108 0 : bool StartLogging(const ArgsManager& args)
109 : {
110 0 : if (LogInstance().m_print_to_file) {
111 0 : if (args.GetBoolArg("-shrinkdebugfile", LogInstance().DefaultShrinkDebugFile())) {
112 : // Do this first since it both loads a bunch of debug.log into memory,
113 : // and because this needs to happen before any other debug.log printing
114 0 : LogInstance().ShrinkDebugFile();
115 0 : }
116 0 : }
117 0 : if (!LogInstance().StartLogging()) {
118 0 : return InitError(strprintf(Untranslated("Could not open debug log file %s"),
119 0 : fs::PathToString(LogInstance().m_file_path)));
120 : }
121 :
122 0 : if (!LogInstance().m_log_timestamps)
123 0 : LogPrintf("Startup time: %s\n", FormatISO8601DateTime(GetTime()));
124 0 : LogPrintf("Default data directory %s\n", fs::PathToString(GetDefaultDataDir()));
125 0 : LogPrintf("Using data directory %s\n", fs::PathToString(gArgs.GetDataDirNet()));
126 :
127 : // Only log conf file usage message if conf file actually exists.
128 0 : fs::path config_file_path = args.GetConfigFilePath();
129 0 : if (fs::exists(config_file_path)) {
130 0 : LogPrintf("Config file: %s\n", fs::PathToString(config_file_path));
131 0 : } else if (args.IsArgSet("-conf")) {
132 : // Warn if no conf file exists at path provided by user
133 0 : InitWarning(strprintf(_("The specified config file %s does not exist"), fs::PathToString(config_file_path)));
134 0 : } else {
135 : // Not categorizing as "Warning" because it's the default behavior
136 0 : LogPrintf("Config file: %s (not found, skipping)\n", fs::PathToString(config_file_path));
137 : }
138 :
139 : // Log the config arguments to debug.log
140 0 : args.LogArgs();
141 :
142 0 : return true;
143 0 : }
144 :
145 69 : void LogPackageVersion()
146 : {
147 69 : std::string version_string = FormatFullVersion();
148 : #ifdef DEBUG
149 : version_string += " (debug build)";
150 : #else
151 69 : version_string += " (release build)";
152 : #endif
153 69 : LogPrintf(PACKAGE_NAME " version %s\n", version_string);
154 69 : }
155 : } // namespace init
|
