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