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