Bitcoin Core  21.99.0
P2P Digital Currency
logging.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_LOGGING_H
7 #define BITCOIN_LOGGING_H
8 
9 #include <fs.h>
10 #include <tinyformat.h>
11 #include <threadsafety.h>
12 #include <util/string.h>
13 
14 #include <atomic>
15 #include <cstdint>
16 #include <list>
17 #include <mutex>
18 #include <string>
19 #include <vector>
20 
21 static const bool DEFAULT_LOGTIMEMICROS = false;
22 static const bool DEFAULT_LOGIPS = false;
23 static const bool DEFAULT_LOGTIMESTAMPS = true;
24 static const bool DEFAULT_LOGTHREADNAMES = false;
25 static const bool DEFAULT_LOGSOURCELOCATIONS = false;
26 extern const char * const DEFAULT_DEBUGLOGFILE;
27 
28 extern bool fLogIPs;
29 
30 struct LogCategory {
31  std::string category;
32  bool active;
33 };
34 
35 namespace BCLog {
36  enum LogFlags : uint32_t {
37  NONE = 0,
38  NET = (1 << 0),
39  TOR = (1 << 1),
40  MEMPOOL = (1 << 2),
41  HTTP = (1 << 3),
42  BENCH = (1 << 4),
43  ZMQ = (1 << 5),
44  WALLETDB = (1 << 6),
45  RPC = (1 << 7),
46  ESTIMATEFEE = (1 << 8),
47  ADDRMAN = (1 << 9),
48  SELECTCOINS = (1 << 10),
49  REINDEX = (1 << 11),
50  CMPCTBLOCK = (1 << 12),
51  RAND = (1 << 13),
52  PRUNE = (1 << 14),
53  PROXY = (1 << 15),
54  MEMPOOLREJ = (1 << 16),
55  LIBEVENT = (1 << 17),
56  COINDB = (1 << 18),
57  QT = (1 << 19),
58  LEVELDB = (1 << 20),
59  VALIDATION = (1 << 21),
60  I2P = (1 << 22),
61  ALL = ~(uint32_t)0,
62  };
63 
64  class Logger
65  {
66  private:
67  mutable StdMutex m_cs; // Can not use Mutex from sync.h because in debug mode it would cause a deadlock when a potential deadlock was detected
68 
69  FILE* m_fileout GUARDED_BY(m_cs) = nullptr;
70  std::list<std::string> m_msgs_before_open GUARDED_BY(m_cs);
71  bool m_buffering GUARDED_BY(m_cs) = true;
72 
78  std::atomic_bool m_started_new_line{true};
79 
81  std::atomic<uint32_t> m_categories{0};
82 
83  std::string LogTimestampStr(const std::string& str);
84 
86  std::list<std::function<void(const std::string&)>> m_print_callbacks GUARDED_BY(m_cs) {};
87 
88  public:
89  bool m_print_to_console = false;
90  bool m_print_to_file = false;
91 
96 
97  fs::path m_file_path;
98  std::atomic<bool> m_reopen_file{false};
99 
101  void LogPrintStr(const std::string& str, const std::string& logging_function, const std::string& source_file, const int source_line);
102 
104  bool Enabled() const
105  {
106  StdLockGuard scoped_lock(m_cs);
107  return m_buffering || m_print_to_console || m_print_to_file || !m_print_callbacks.empty();
108  }
109 
111  std::list<std::function<void(const std::string&)>>::iterator PushBackCallback(std::function<void(const std::string&)> fun)
112  {
113  StdLockGuard scoped_lock(m_cs);
114  m_print_callbacks.push_back(std::move(fun));
115  return --m_print_callbacks.end();
116  }
117 
119  void DeleteCallback(std::list<std::function<void(const std::string&)>>::iterator it)
120  {
121  StdLockGuard scoped_lock(m_cs);
122  m_print_callbacks.erase(it);
123  }
124 
126  bool StartLogging();
128  void DisconnectTestLogger();
129 
130  void ShrinkDebugFile();
131 
132  uint32_t GetCategoryMask() const { return m_categories.load(); }
133 
134  void EnableCategory(LogFlags flag);
135  bool EnableCategory(const std::string& str);
136  void DisableCategory(LogFlags flag);
137  bool DisableCategory(const std::string& str);
138 
139  bool WillLogCategory(LogFlags category) const;
141  std::vector<LogCategory> LogCategoriesList() const;
143  std::string LogCategoriesString() const
144  {
145  return Join(LogCategoriesList(), ", ", [&](const LogCategory& i) { return i.category; });
146  };
147 
148  bool DefaultShrinkDebugFile() const;
149  };
150 
151 } // namespace BCLog
152 
154 
156 static inline bool LogAcceptCategory(BCLog::LogFlags category)
157 {
158  return LogInstance().WillLogCategory(category);
159 }
160 
162 bool GetLogCategory(BCLog::LogFlags& flag, const std::string& str);
163 
164 // Be conservative when using LogPrintf/error or other things which
165 // unconditionally log to debug.log! It should not be the case that an inbound
166 // peer can fill up a user's disk with debug.log entries.
167 
168 template <typename... Args>
169 static inline void LogPrintf_(const std::string& logging_function, const std::string& source_file, const int source_line, const char* fmt, const Args&... args)
170 {
171  if (LogInstance().Enabled()) {
172  std::string log_msg;
173  try {
174  log_msg = tfm::format(fmt, args...);
175  } catch (tinyformat::format_error& fmterr) {
176  /* Original format string will have newline so don't add one here */
177  log_msg = "Error \"" + std::string(fmterr.what()) + "\" while formatting log message: " + fmt;
178  }
179  LogInstance().LogPrintStr(log_msg, logging_function, source_file, source_line);
180  }
181 }
182 
183 #define LogPrintf(...) LogPrintf_(__func__, __FILE__, __LINE__, __VA_ARGS__)
184 
185 // Use a macro instead of a function for conditional logging to prevent
186 // evaluating arguments when logging for the category is not enabled.
187 #define LogPrint(category, ...) \
188  do { \
189  if (LogAcceptCategory((category))) { \
190  LogPrintf(__VA_ARGS__); \
191  } \
192  } while (0)
193 
194 #endif // BITCOIN_LOGGING_H
DEFAULT_LOGTIMEMICROS
static const bool DEFAULT_LOGTIMEMICROS
Definition: logging.h:21
BCLog::LogFlags
LogFlags
Definition: logging.h:36
BCLog::Logger::m_print_to_file
bool m_print_to_file
Definition: logging.h:90
BCLog::Logger::DeleteCallback
void DeleteCallback(std::list< std::function< void(const std::string &)>>::iterator it)
Delete a connection.
Definition: logging.h:119
BCLog::ZMQ
@ ZMQ
Definition: logging.h:43
tinyformat::format
void format(std::ostream &out, const char *fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1062
BCLog::I2P
@ I2P
Definition: logging.h:60
BCLog::HTTP
@ HTTP
Definition: logging.h:41
LogCategory::active
bool active
Definition: logging.h:32
fs.h
BCLog::Logger::WillLogCategory
bool WillLogCategory(LogFlags category) const
Definition: logging.cpp:117
BCLog::Logger::m_categories
std::atomic< uint32_t > m_categories
Log categories bitfield.
Definition: logging.h:81
BCLog::Logger::StartLogging
bool StartLogging()
Start logging (and flush all buffered messages)
Definition: logging.cpp:43
string.h
DEFAULT_LOGIPS
static const bool DEFAULT_LOGIPS
Definition: logging.h:22
DEFAULT_DEBUGLOGFILE
const char *const DEFAULT_DEBUGLOGFILE
Definition: logging.cpp:13
LogCategory::category
std::string category
Definition: logging.h:31
BCLog::BENCH
@ BENCH
Definition: logging.h:42
BCLog::Logger::GetCategoryMask
uint32_t GetCategoryMask() const
Definition: logging.h:132
LogInstance
BCLog::Logger & LogInstance()
Definition: logging.cpp:15
DEFAULT_LOGTIMESTAMPS
static const bool DEFAULT_LOGTIMESTAMPS
Definition: logging.h:23
BCLog::ESTIMATEFEE
@ ESTIMATEFEE
Definition: logging.h:46
BCLog::Logger::LogCategoriesList
std::vector< LogCategory > LogCategoriesList() const
Returns a vector of the log categories.
Definition: logging.cpp:179
BCLog::PROXY
@ PROXY
Definition: logging.h:53
BCLog::PRUNE
@ PRUNE
Definition: logging.h:52
BCLog::Logger::DisconnectTestLogger
void DisconnectTestLogger()
Only for testing.
Definition: logging.cpp:82
BCLog::MEMPOOLREJ
@ MEMPOOLREJ
Definition: logging.h:54
tinyformat.h
BCLog::Logger::m_cs
StdMutex m_cs
Definition: logging.h:67
BCLog::RPC
@ RPC
Definition: logging.h:45
BCLog::Logger::m_log_timestamps
bool m_log_timestamps
Definition: logging.h:92
StdLockGuard
Definition: threadsafety.h:70
BCLog::Logger::GUARDED_BY
std::list< std::function< void(const std::string &)> > m_print_callbacks GUARDED_BY(m_cs)
Slots that connect to the print signal.
Definition: logging.h:86
BCLog::WALLETDB
@ WALLETDB
Definition: logging.h:44
threadsafety.h
BCLog::Logger::m_started_new_line
std::atomic_bool m_started_new_line
m_started_new_line is a state variable that will suppress printing of the timestamp when multiple cal...
Definition: logging.h:78
BCLog::Logger::LogCategoriesString
std::string LogCategoriesString() const
Returns a string with the log categories.
Definition: logging.h:143
BCLog::LEVELDB
@ LEVELDB
Definition: logging.h:58
BCLog::Logger::ShrinkDebugFile
void ShrinkDebugFile()
Definition: logging.cpp:289
BCLog::LIBEVENT
@ LIBEVENT
Definition: logging.h:55
BCLog::Logger::LogTimestampStr
std::string LogTimestampStr(const std::string &str)
Definition: logging.cpp:194
LogCategory
Definition: logging.h:30
BCLog::Logger::EnableCategory
void EnableCategory(LogFlags flag)
Definition: logging.cpp:91
BCLog::Logger::m_reopen_file
std::atomic< bool > m_reopen_file
Definition: logging.h:98
BCLog::TOR
@ TOR
Definition: logging.h:39
BCLog::REINDEX
@ REINDEX
Definition: logging.h:49
DEFAULT_LOGSOURCELOCATIONS
static const bool DEFAULT_LOGSOURCELOCATIONS
Definition: logging.h:25
BCLog::QT
@ QT
Definition: logging.h:57
BCLog::ALL
@ ALL
Definition: logging.h:61
BCLog::VALIDATION
@ VALIDATION
Definition: logging.h:59
StdMutex
Definition: threadsafety.h:57
BCLog::Logger::Enabled
bool Enabled() const
Returns whether logs will be written to any output.
Definition: logging.h:104
BCLog::Logger::GUARDED_BY
FILE *m_fileout GUARDED_BY(m_cs)
LogPrintf_
static void LogPrintf_(const std::string &logging_function, const std::string &source_file, const int source_line, const char *fmt, const Args &... args)
Definition: logging.h:169
tinyformat::format_error
Definition: tinyformat.h:182
BCLog::Logger::m_log_sourcelocations
bool m_log_sourcelocations
Definition: logging.h:95
BCLog::Logger::m_file_path
fs::path m_file_path
Definition: logging.h:97
BCLog::RAND
@ RAND
Definition: logging.h:51
DEFAULT_LOGTHREADNAMES
static const bool DEFAULT_LOGTHREADNAMES
Definition: logging.h:24
Join
auto Join(const std::vector< T > &list, const BaseType &separator, UnaryOp unary_op) -> decltype(unary_op(list.at(0)))
Join a list of items.
Definition: string.h:44
fLogIPs
bool fLogIPs
Definition: logging.cpp:36
BCLog::COINDB
@ COINDB
Definition: logging.h:56
BCLog::Logger::DefaultShrinkDebugFile
bool DefaultShrinkDebugFile() const
Definition: logging.cpp:122
GetLogCategory
bool GetLogCategory(BCLog::LogFlags &flag, const std::string &str)
Return true if str parses as a log category and set the flag.
Definition: logging.cpp:164
LogAcceptCategory
static bool LogAcceptCategory(BCLog::LogFlags category)
Return true if log accepts specified category.
Definition: logging.h:156
BCLog
Definition: timer.h:17
BCLog::MEMPOOL
@ MEMPOOL
Definition: logging.h:40
BCLog::Logger::m_print_to_console
bool m_print_to_console
Definition: logging.h:89
BCLog::Logger
Definition: logging.h:64
BCLog::Logger::m_log_time_micros
bool m_log_time_micros
Definition: logging.h:93
BCLog::Logger::PushBackCallback
std::list< std::function< void(const std::string &)> >::iterator PushBackCallback(std::function< void(const std::string &)> fun)
Connect a slot to the print signal and return the connection.
Definition: logging.h:111
BCLog::SELECTCOINS
@ SELECTCOINS
Definition: logging.h:48
BCLog::ADDRMAN
@ ADDRMAN
Definition: logging.h:47
BCLog::Logger::DisableCategory
void DisableCategory(LogFlags flag)
Definition: logging.cpp:104
BCLog::NET
@ NET
Definition: logging.h:38
BCLog::CMPCTBLOCK
@ CMPCTBLOCK
Definition: logging.h:50
BCLog::Logger::m_log_threadnames
bool m_log_threadnames
Definition: logging.h:94
it
auto it
Definition: validation.cpp:399
BCLog::NONE
@ NONE
Definition: logging.h:37
BCLog::Logger::LogPrintStr
void LogPrintStr(const std::string &str, const std::string &logging_function, const std::string &source_file, const int source_line)
Send a string to the log output.
Definition: logging.cpp:241