Bitcoin ABC  0.27.2
P2P Digital Currency
logging.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 The Bitcoin Core developers
3 // Copyright (c) 2017-2019 The Bitcoin developers
4 // Distributed under the MIT software license, see the accompanying
5 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
6 
7 #ifndef BITCOIN_LOGGING_H
8 #define BITCOIN_LOGGING_H
9 
10 #include <fs.h>
11 #include <threadsafety.h>
12 #include <tinyformat.h>
13 #include <util/string.h>
14 
15 #include <atomic>
16 #include <cstdint>
17 #include <list>
18 #include <mutex>
19 #include <string>
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 
27 extern bool fLogIPs;
28 extern const char *const DEFAULT_DEBUGLOGFILE;
29 
30 struct LogCategory {
31  std::string category;
32  bool active;
33 };
34 
35 namespace BCLog {
36 
37 enum LogFlags : uint32_t {
38  NONE = 0,
39  NET = (1 << 0),
40  TOR = (1 << 1),
41  MEMPOOL = (1 << 2),
42  HTTP = (1 << 3),
43  BENCH = (1 << 4),
44  ZMQ = (1 << 5),
45  WALLETDB = (1 << 6),
46  RPC = (1 << 7),
47  ESTIMATEFEE = (1 << 8),
48  ADDRMAN = (1 << 9),
49  SELECTCOINS = (1 << 10),
50  REINDEX = (1 << 11),
51  CMPCTBLOCK = (1 << 12),
52  RAND = (1 << 13),
53  PRUNE = (1 << 14),
54  PROXY = (1 << 15),
55  MEMPOOLREJ = (1 << 16),
56  LIBEVENT = (1 << 17),
57  COINDB = (1 << 18),
58  QT = (1 << 19),
59  LEVELDB = (1 << 20),
60  VALIDATION = (1 << 21),
61  AVALANCHE = (1 << 22),
62  I2P = (1 << 23),
63  CHRONIK = (1 << 24),
64 #ifdef DEBUG_LOCKCONTENTION
65  LOCK = (1 << 25),
66 #endif
67  BLOCKSTORE = (1 << 26),
68  ALL = ~uint32_t(0),
69 };
70 
71 class Logger {
72 private:
73  // Can not use Mutex from sync.h because in debug mode it would cause a
74  // deadlock when a potential deadlock was detected
75  mutable StdMutex m_cs;
76 
77  FILE *m_fileout GUARDED_BY(m_cs) = nullptr;
78  std::list<std::string> m_msgs_before_open GUARDED_BY(m_cs);
80  bool m_buffering GUARDED_BY(m_cs) = true;
81 
86  std::atomic_bool m_started_new_line{true};
87 
91  std::atomic<uint32_t> m_categories{0};
92 
93  std::string LogTimestampStr(const std::string &str);
94 
96  std::list<std::function<void(const std::string &)>>
97  m_print_callbacks GUARDED_BY(m_cs){};
98 
99 public:
100  bool m_print_to_console = false;
101  bool m_print_to_file = false;
102 
107 
109  std::atomic<bool> m_reopen_file{false};
110 
111  ~Logger();
112 
114  void LogPrintStr(const std::string &str,
115  const std::string &logging_function,
116  const std::string &source_file, const int source_line);
117 
119  bool Enabled() const {
120  StdLockGuard scoped_lock(m_cs);
121  return m_buffering || m_print_to_console || m_print_to_file ||
122  !m_print_callbacks.empty();
123  }
124 
126  std::list<std::function<void(const std::string &)>>::iterator
127  PushBackCallback(std::function<void(const std::string &)> fun) {
128  StdLockGuard scoped_lock(m_cs);
129  m_print_callbacks.push_back(std::move(fun));
130  return --m_print_callbacks.end();
131  }
132 
135  std::list<std::function<void(const std::string &)>>::iterator it) {
136  StdLockGuard scoped_lock(m_cs);
137  m_print_callbacks.erase(it);
138  }
139 
141  bool StartLogging();
143  void DisconnectTestLogger();
144 
145  void ShrinkDebugFile();
146 
147  uint32_t GetCategoryMask() const { return m_categories.load(); }
148 
149  void EnableCategory(LogFlags category);
150  bool EnableCategory(const std::string &str);
151  void DisableCategory(LogFlags category);
152  bool DisableCategory(const std::string &str);
153 
155  bool WillLogCategory(LogFlags category) const;
156 
158  std::vector<LogCategory> LogCategoriesList() const;
160  std::string LogCategoriesString() const {
161  return Join(LogCategoriesList(), ", ",
162  [&](const LogCategory &i) { return i.category; });
163  };
164 
166  bool DefaultShrinkDebugFile() const;
167 };
168 
169 } // namespace BCLog
170 
172 
174 static inline bool LogAcceptCategory(BCLog::LogFlags category) {
175  return LogInstance().WillLogCategory(category);
176 }
177 
179 bool GetLogCategory(BCLog::LogFlags &flag, const std::string &str);
180 
181 // Be conservative when using LogPrintf/error or other things which
182 // unconditionally log to debug.log! It should not be the case that an inbound
183 // peer can fill up a user's disk with debug.log entries.
184 template <typename... Args>
185 static inline void
186 LogPrintf_(const std::string &logging_function, const std::string &source_file,
187  const int source_line, const char *fmt, const Args &...args) {
188  if (LogInstance().Enabled()) {
189  std::string log_msg;
190  try {
191  log_msg = tfm::format(fmt, args...);
192  } catch (tinyformat::format_error &fmterr) {
196  log_msg = "Error \"" + std::string(fmterr.what()) +
197  "\" while formatting log message: " + fmt;
198  }
199  LogInstance().LogPrintStr(log_msg, logging_function, source_file,
200  source_line);
201  }
202 }
203 
204 #define LogPrintf(...) LogPrintf_(__func__, __FILE__, __LINE__, __VA_ARGS__)
205 
206 // Use a macro instead of a function for conditional logging to prevent
207 // evaluating arguments when logging for the category is not enabled.
208 #define LogPrint(category, ...) \
209  do { \
210  if (LogAcceptCategory((category))) { \
211  LogPrintf(__VA_ARGS__); \
212  } \
213  } while (0)
214 
220 #define LogPrintfToBeContinued LogPrintf
221 #define LogPrintToBeContinued LogPrint
222 
223 #endif // BITCOIN_LOGGING_H
bool m_buffering GUARDED_BY(m_cs)
Buffer messages before logging can be started.
bool WillLogCategory(LogFlags category) const
Return true if log accepts specified category.
Definition: logging.cpp:348
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:127
bool Enabled() const
Returns whether logs will be written to any output.
Definition: logging.h:119
std::string LogTimestampStr(const std::string &str)
Definition: logging.cpp:181
void DisconnectTestLogger()
Only for testing.
Definition: logging.cpp:88
std::list< std::string > m_msgs_before_open GUARDED_BY(m_cs)
std::atomic< uint32_t > m_categories
Log categories bitfield.
Definition: logging.h:91
bool DefaultShrinkDebugFile() const
Default for whether ShrinkDebugFile should be run.
Definition: logging.cpp:360
bool m_log_sourcelocations
Definition: logging.h:106
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:97
fs::path m_file_path
Definition: logging.h:108
bool m_log_time_micros
Definition: logging.h:104
bool m_log_threadnames
Definition: logging.h:105
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:86
std::vector< LogCategory > LogCategoriesList() const
Returns a vector of the log categories in alphabetical order.
Definition: logging.cpp:153
void DisableCategory(LogFlags category)
Definition: logging.cpp:335
void EnableCategory(LogFlags category)
Definition: logging.cpp:322
bool StartLogging()
Start logging (and flush all buffered messages)
Definition: logging.cpp:43
bool m_log_timestamps
Definition: logging.h:103
FILE *m_fileout GUARDED_BY(m_cs)
void DeleteCallback(std::list< std::function< void(const std::string &)>>::iterator it)
Delete a connection.
Definition: logging.h:134
std::atomic< bool > m_reopen_file
Definition: logging.h:109
void ShrinkDebugFile()
Definition: logging.cpp:283
bool m_print_to_file
Definition: logging.h:101
uint32_t GetCategoryMask() const
Definition: logging.h:147
bool m_print_to_console
Definition: logging.h:100
StdMutex m_cs
Definition: logging.h:75
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:230
std::string LogCategoriesString() const
Returns a string with the log categories in alphabetical order.
Definition: logging.h:160
Path class wrapper to prepare application code for transition from boost::filesystem library to std::...
Definition: fs.h:33
static const bool DEFAULT_LOGTIMESTAMPS
Definition: logging.h:23
static bool LogAcceptCategory(BCLog::LogFlags category)
Return true if log accepts specified category.
Definition: logging.h:174
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:186
static const bool DEFAULT_LOGIPS
Definition: logging.h:22
static const bool DEFAULT_LOGTHREADNAMES
Definition: logging.h:24
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:139
static const bool DEFAULT_LOGSOURCELOCATIONS
Definition: logging.h:25
bool fLogIPs
Definition: logging.cpp:16
static const bool DEFAULT_LOGTIMEMICROS
Definition: logging.h:21
const char *const DEFAULT_DEBUGLOGFILE
Definition: logging.cpp:17
BCLog::Logger & LogInstance()
Definition: logging.cpp:19
Definition: timer.h:17
LogFlags
Definition: logging.h:37
@ ESTIMATEFEE
Definition: logging.h:47
@ AVALANCHE
Definition: logging.h:61
@ RAND
Definition: logging.h:52
@ COINDB
Definition: logging.h:57
@ REINDEX
Definition: logging.h:50
@ WALLETDB
Definition: logging.h:45
@ ADDRMAN
Definition: logging.h:48
@ ALL
Definition: logging.h:68
@ RPC
Definition: logging.h:46
@ HTTP
Definition: logging.h:42
@ LEVELDB
Definition: logging.h:59
@ NONE
Definition: logging.h:38
@ VALIDATION
Definition: logging.h:60
@ MEMPOOLREJ
Definition: logging.h:55
@ PRUNE
Definition: logging.h:53
@ TOR
Definition: logging.h:40
@ LIBEVENT
Definition: logging.h:56
@ CMPCTBLOCK
Definition: logging.h:51
@ PROXY
Definition: logging.h:54
@ CHRONIK
Definition: logging.h:63
@ ZMQ
Definition: logging.h:44
@ MEMPOOL
Definition: logging.h:41
@ SELECTCOINS
Definition: logging.h:49
@ I2P
Definition: logging.h:62
@ BENCH
Definition: logging.h:43
@ NET
Definition: logging.h:39
@ QT
Definition: logging.h:58
@ BLOCKSTORE
Definition: logging.h:67
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:1111
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:46
bool active
Definition: logging.h:32
std::string category
Definition: logging.h:31
#define LOCK(cs)
Definition: sync.h:243