Branch data 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 : : #include <config/bitcoin-config.h> // IWYU pragma: keep
6 : :
7 : : #include <clientversion.h>
8 : : #include <common/args.h>
9 : : #include <logging.h>
10 : : #include <node/interface_ui.h>
11 : : #include <tinyformat.h>
12 : : #include <util/fs.h>
13 : : #include <util/fs_helpers.h>
14 : : #include <util/result.h>
15 : : #include <util/string.h>
16 : : #include <util/time.h>
17 : : #include <util/translation.h>
18 : :
19 : : #include <algorithm>
20 : : #include <string>
21 : : #include <vector>
22 : :
23 : : using util::SplitString;
24 : :
25 : : namespace init {
26 : 583 : void AddLoggingArgs(ArgsManager& argsman)
27 : : {
28 [ + - + - ]: 1166 : 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 [ + - + - ]: 1166 : argsman.AddArg("-debug=<category>", "Output debug and trace logging (default: -nodebug, supplying <category> is optional). "
30 [ + - + - ]: 1749 : "If <category> is not supplied or if <category> is 1 or \"all\", output all debug logging. If <category> is 0 or \"none\", any other categories are ignored. Other valid values for <category> are: " + LogInstance().LogCategoriesString() + ". This option can be specified multiple times to output multiple categories.",
31 : 583 : ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
32 [ + - + - ]: 1166 : 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. This takes priority over \"-debug\"", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
33 [ + - + - ]: 1166 : argsman.AddArg("-logips", strprintf("Include IP addresses in debug output (default: %u)", DEFAULT_LOGIPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
34 [ + - + - : 1166 : 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. Possible values are %s (default=%s). The following levels are always logged: error, warning, info. 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 [ + - + - ]: 1166 : argsman.AddArg("-logtimestamps", strprintf("Prepend debug output with timestamp (default: %u)", DEFAULT_LOGTIMESTAMPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
36 [ + - + - ]: 1166 : argsman.AddArg("-logthreadnames", strprintf("Prepend debug output with name of the originating thread (default: %u)", DEFAULT_LOGTHREADNAMES), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
37 [ + - + - ]: 1166 : 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);
38 [ + - + - ]: 1166 : argsman.AddArg("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
39 [ + - + - ]: 1166 : argsman.AddArg("-loglevelalways", strprintf("Always prepend a category and level (default: %u)", DEFAULT_LOGLEVELALWAYS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
40 [ + - + - ]: 1166 : 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);
41 [ + - + - ]: 1166 : argsman.AddArg("-shrinkdebugfile", "Shrink debug.log file on client startup (default: 1 when no -debug)", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
42 : 583 : }
43 : :
44 : 583 : void SetLoggingOptions(const ArgsManager& args)
45 : : {
46 [ + - + - ]: 583 : LogInstance().m_print_to_file = !args.IsArgNegated("-debuglogfile");
47 [ + - + - : 1749 : LogInstance().m_file_path = AbsPathForConfigVal(args, args.GetPathArg("-debuglogfile", DEFAULT_DEBUGLOGFILE));
+ - + - ]
48 [ + - + - : 583 : LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", !args.GetBoolArg("-daemon", false));
+ - + - ]
49 [ + - + - ]: 583 : LogInstance().m_log_timestamps = args.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
50 [ + - + - ]: 583 : LogInstance().m_log_time_micros = args.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
51 [ + - + - ]: 583 : LogInstance().m_log_threadnames = args.GetBoolArg("-logthreadnames", DEFAULT_LOGTHREADNAMES);
52 [ + - + - ]: 583 : LogInstance().m_log_sourcelocations = args.GetBoolArg("-logsourcelocations", DEFAULT_LOGSOURCELOCATIONS);
53 [ + - + - ]: 583 : LogInstance().m_always_print_category_level = args.GetBoolArg("-loglevelalways", DEFAULT_LOGLEVELALWAYS);
54 : :
55 [ + - ]: 583 : fLogIPs = args.GetBoolArg("-logips", DEFAULT_LOGIPS);
56 : 583 : }
57 : :
58 : 586 : util::Result<void> SetLoggingLevel(const ArgsManager& args)
59 : : {
60 [ + - + - ]: 586 : if (args.IsArgSet("-loglevel")) {
61 [ + - + + ]: 1174 : for (const std::string& level_str : args.GetArgs("-loglevel")) {
62 [ + + ]: 588 : if (level_str.find_first_of(':', 3) == std::string::npos) {
63 : : // user passed a global log level, i.e. -loglevel=<level>
64 [ + - + - : 585 : if (!LogInstance().SetLogLevel(level_str)) {
- + ]
65 [ # # # # : 0 : return util::Error{strprintf(_("Unsupported global logging level %s=%s. Valid values: %s."), "-loglevel", level_str, LogInstance().LogLevelsString())};
# # # # ]
66 : : }
67 : : } else {
68 : : // user passed a category-specific log level, i.e. -loglevel=<category>:<level>
69 [ + - ]: 3 : const auto& toks = SplitString(level_str, ':');
70 [ + - + - : 3 : if (!(toks.size() == 2 && LogInstance().SetCategoryLogLevel(toks[0], toks[1]))) {
+ - - + ]
71 [ # # # # : 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())};
# # # # #
# # # ]
72 : : }
73 : 3 : }
74 : 586 : }
75 : : }
76 : 586 : return {};
77 : : }
78 : :
79 : 583 : util::Result<void> SetLoggingCategories(const ArgsManager& args)
80 : : {
81 [ + - + - ]: 583 : if (args.IsArgSet("-debug")) {
82 : : // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
83 [ + - ]: 583 : const std::vector<std::string> categories = args.GetArgs("-debug");
84 : :
85 [ + - + - ]: 583 : if (std::none_of(categories.begin(), categories.end(),
86 [ + - - + ]: 583 : [](std::string cat){return cat == "0" || cat == "none";})) {
87 [ + + ]: 1166 : for (const auto& cat : categories) {
88 [ + - + - : 583 : if (!LogInstance().EnableCategory(cat)) {
- + ]
89 [ # # # # ]: 0 : return util::Error{strprintf(_("Unsupported logging category %s=%s."), "-debug", cat)};
90 : : }
91 : : }
92 : : }
93 : 583 : }
94 : :
95 : : // Now remove the logging categories which were explicitly excluded
96 [ + - + + ]: 1749 : for (const std::string& cat : args.GetArgs("-debugexclude")) {
97 [ + - + - : 1166 : if (!LogInstance().DisableCategory(cat)) {
- + ]
98 [ # # # # ]: 0 : return util::Error{strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat)};
99 : : }
100 : 583 : }
101 : 583 : return {};
102 : : }
103 : :
104 : 0 : bool StartLogging(const ArgsManager& args)
105 : : {
106 [ # # ]: 0 : if (LogInstance().m_print_to_file) {
107 [ # # # # ]: 0 : 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
110 : 0 : LogInstance().ShrinkDebugFile();
111 : : }
112 : : }
113 [ # # ]: 0 : if (!LogInstance().StartLogging()) {
114 [ # # # # : 0 : return InitError(strprintf(Untranslated("Could not open debug log file %s"),
# # # # ]
115 [ # # ]: 0 : fs::PathToString(LogInstance().m_file_path)));
116 : : }
117 : :
118 [ # # ]: 0 : if (!LogInstance().m_log_timestamps)
119 [ # # ]: 0 : LogPrintf("Startup time: %s\n", FormatISO8601DateTime(GetTime()));
120 [ # # # # ]: 0 : LogPrintf("Default data directory %s\n", fs::PathToString(GetDefaultDataDir()));
121 [ # # # # ]: 0 : LogPrintf("Using data directory %s\n", fs::PathToString(gArgs.GetDataDirNet()));
122 : :
123 : : // Only log conf file usage message if conf file actually exists.
124 : 0 : fs::path config_file_path = args.GetConfigFilePath();
125 [ # # # # ]: 0 : if (fs::exists(config_file_path)) {
126 [ # # # # ]: 0 : LogPrintf("Config file: %s\n", fs::PathToString(config_file_path));
127 [ # # # # : 0 : } else if (args.IsArgSet("-conf")) {
# # ]
128 : : // Warn if no conf file exists at path provided by user
129 [ # # # # : 0 : 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 [ # # # # ]: 0 : LogPrintf("Config file: %s (not found, skipping)\n", fs::PathToString(config_file_path));
133 : : }
134 : :
135 : : // Log the config arguments to debug.log
136 [ # # ]: 0 : args.LogArgs();
137 : :
138 : 0 : return true;
139 : 0 : }
140 : :
141 : 583 : void LogPackageVersion()
142 : : {
143 : 583 : std::string version_string = FormatFullVersion();
144 : : #ifdef DEBUG
145 : : version_string += " (debug build)";
146 : : #else
147 [ + - ]: 583 : version_string += " (release build)";
148 : : #endif
149 [ + - ]: 583 : LogPrintf(PACKAGE_NAME " version %s\n", version_string);
150 : 583 : }
151 : : } // namespace init
|
