Bitcoin ABC  0.25.11
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  ALL = ~uint32_t(0),
64 };
65 
66 class Logger {
67 private:
68  // Can not use Mutex from sync.h because in debug mode it would cause a
69  // deadlock when a potential deadlock was detected
70  mutable StdMutex m_cs;
71 
72  FILE *m_fileout GUARDED_BY(m_cs) = nullptr;
73  std::list<std::string> m_msgs_before_open GUARDED_BY(m_cs);
75  bool m_buffering GUARDED_BY(m_cs) = true;
76 
81  std::atomic_bool m_started_new_line{true};
82 
86  std::atomic<uint32_t> m_categories{0};
87 
88  std::string LogTimestampStr(const std::string &str);
89 
91  std::list<std::function<void(const std::string &)>>
92  m_print_callbacks GUARDED_BY(m_cs){};
93 
94 public:
95  bool m_print_to_console = false;
96  bool m_print_to_file = false;
97 
102 
104  std::atomic<bool> m_reopen_file{false};
105 
106  ~Logger();
107 
109  void LogPrintStr(const std::string &str,
110  const std::string &logging_function,
111  const std::string &source_file, const int source_line);
112 
114  bool Enabled() const {
115  StdLockGuard scoped_lock(m_cs);
116  return m_buffering || m_print_to_console || m_print_to_file ||
117  !m_print_callbacks.empty();
118  }
119 
121  std::list<std::function<void(const std::string &)>>::iterator
122  PushBackCallback(std::function<void(const std::string &)> fun) {
123  StdLockGuard scoped_lock(m_cs);
124  m_print_callbacks.push_back(std::move(fun));
125  return --m_print_callbacks.end();
126  }
127 
130  std::list<std::function<void(const std::string &)>>::iterator it) {
131  StdLockGuard scoped_lock(m_cs);
132  m_print_callbacks.erase(it);
133  }
134 
136  bool StartLogging();
138  void DisconnectTestLogger();
139 
140  void ShrinkDebugFile();
141 
142  uint32_t GetCategoryMask() const { return m_categories.load(); }
143 
144  void EnableCategory(LogFlags category);
145  bool EnableCategory(const std::string &str);
146  void DisableCategory(LogFlags category);
147  bool DisableCategory(const std::string &str);
148 
150  bool WillLogCategory(LogFlags category) const;
151 
153  std::vector<LogCategory> LogCategoriesList() const;
155  std::string LogCategoriesString() const {
156  return Join(LogCategoriesList(), ", ",
157  [&](const LogCategory &i) { return i.category; });
158  };
159 
161  bool DefaultShrinkDebugFile() const;
162 };
163 
164 } // namespace BCLog
165 
167 
169 static inline bool LogAcceptCategory(BCLog::LogFlags category) {
170  return LogInstance().WillLogCategory(category);
171 }
172 
174 bool GetLogCategory(BCLog::LogFlags &flag, const std::string &str);
175 
176 // Be conservative when using LogPrintf/error or other things which
177 // unconditionally log to debug.log! It should not be the case that an inbound
178 // peer can fill up a user's disk with debug.log entries.
179 template <typename... Args>
180 static inline void
181 LogPrintf_(const std::string &logging_function, const std::string &source_file,
182  const int source_line, const char *fmt, const Args &...args) {
183  if (LogInstance().Enabled()) {
184  std::string log_msg;
185  try {
186  log_msg = tfm::format(fmt, args...);
187  } catch (tinyformat::format_error &fmterr) {
191  log_msg = "Error \"" + std::string(fmterr.what()) +
192  "\" while formatting log message: " + fmt;
193  }
194  LogInstance().LogPrintStr(log_msg, logging_function, source_file,
195  source_line);
196  }
197 }
198 
199 #define LogPrintf(...) LogPrintf_(__func__, __FILE__, __LINE__, __VA_ARGS__)
200 
201 // Use a macro instead of a function for conditional logging to prevent
202 // evaluating arguments when logging for the category is not enabled.
203 #define LogPrint(category, ...) \
204  do { \
205  if (LogAcceptCategory((category))) { \
206  LogPrintf(__VA_ARGS__); \
207  } \
208  } while (0)
209 
215 #define LogPrintfToBeContinued LogPrintf
216 #define LogPrintToBeContinued LogPrint
217 
218 #endif // BITCOIN_LOGGING_H
DEFAULT_LOGTIMEMICROS
static const bool DEFAULT_LOGTIMEMICROS
Definition: logging.h:21
BCLog::LogFlags
LogFlags
Definition: logging.h:37
BCLog::Logger::m_print_to_file
bool m_print_to_file
Definition: logging.h:96
BCLog::Logger::DeleteCallback
void DeleteCallback(std::list< std::function< void(const std::string &)>>::iterator it)
Delete a connection.
Definition: logging.h:129
BCLog::ZMQ
@ ZMQ
Definition: logging.h:44
BCLog::I2P
@ I2P
Definition: logging.h:62
BCLog::HTTP
@ HTTP
Definition: logging.h:42
LogCategory::active
bool active
Definition: logging.h:32
fs.h
BCLog::Logger::WillLogCategory
bool WillLogCategory(LogFlags category) const
Return true if log accepts specified category.
Definition: logging.cpp:333
BCLog::Logger::m_categories
std::atomic< uint32_t > m_categories
Log categories bitfield.
Definition: logging.h:86
BCLog::Logger::StartLogging
bool StartLogging()
Start logging (and flush all buffered messages)
Definition: logging.cpp:40
string.h
DEFAULT_LOGIPS
static const bool DEFAULT_LOGIPS
Definition: logging.h:22
DEFAULT_DEBUGLOGFILE
const char *const DEFAULT_DEBUGLOGFILE
Definition: logging.cpp:14
LogCategory::category
std::string category
Definition: logging.h:31
BCLog::BENCH
@ BENCH
Definition: logging.h:43
BCLog::Logger::GetCategoryMask
uint32_t GetCategoryMask() const
Definition: logging.h:142
LogInstance
BCLog::Logger & LogInstance()
Definition: logging.cpp:16
DEFAULT_LOGTIMESTAMPS
static const bool DEFAULT_LOGTIMESTAMPS
Definition: logging.h:23
BCLog::Logger::~Logger
~Logger()
Definition: logging.cpp:160
BCLog::ESTIMATEFEE
@ ESTIMATEFEE
Definition: logging.h:47
BCLog::Logger::LogCategoriesList
std::vector< LogCategory > LogCategoriesList() const
Returns a vector of the log categories.
Definition: logging.cpp:145
BCLog::PROXY
@ PROXY
Definition: logging.h:54
BCLog::PRUNE
@ PRUNE
Definition: logging.h:53
BCLog::Logger::DisconnectTestLogger
void DisconnectTestLogger()
Only for testing.
Definition: logging.cpp:85
BCLog::MEMPOOLREJ
@ MEMPOOLREJ
Definition: logging.h:55
tinyformat.h
BCLog::Logger::m_cs
StdMutex m_cs
Definition: logging.h:70
BCLog::RPC
@ RPC
Definition: logging.h:46
BCLog::Logger::m_log_timestamps
bool m_log_timestamps
Definition: logging.h:98
StdLockGuard
Definition: threadsafety.h:77
BCLog::WALLETDB
@ WALLETDB
Definition: logging.h:45
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:81
fs::path
Path class wrapper to prepare application code for transition from boost::filesystem library to std::...
Definition: fs.h:33
BCLog::Logger::LogCategoriesString
std::string LogCategoriesString() const
Returns a string with the log categories.
Definition: logging.h:155
BCLog::LEVELDB
@ LEVELDB
Definition: logging.h:59
BCLog::Logger::ShrinkDebugFile
void ShrinkDebugFile()
Definition: logging.cpp:268
BCLog::LIBEVENT
@ LIBEVENT
Definition: logging.h:56
BCLog::Logger::LogTimestampStr
std::string LogTimestampStr(const std::string &str)
Definition: logging.cpp:166
LogCategory
Definition: logging.h:30
BCLog::Logger::m_reopen_file
std::atomic< bool > m_reopen_file
Definition: logging.h:104
BCLog::TOR
@ TOR
Definition: logging.h:40
BCLog::REINDEX
@ REINDEX
Definition: logging.h:50
DEFAULT_LOGSOURCELOCATIONS
static const bool DEFAULT_LOGSOURCELOCATIONS
Definition: logging.h:25
BCLog::QT
@ QT
Definition: logging.h:58
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:122
BCLog::ALL
@ ALL
Definition: logging.h:63
BCLog::VALIDATION
@ VALIDATION
Definition: logging.h:60
StdMutex
Definition: threadsafety.h:64
BCLog::Logger::Enabled
bool Enabled() const
Returns whether logs will be written to any output.
Definition: logging.h:114
BCLog::Logger::GUARDED_BY
FILE *m_fileout GUARDED_BY(m_cs)
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:92
tinyformat::format_error
Definition: tinyformat.h:184
BCLog::Logger::EnableCategory
void EnableCategory(LogFlags category)
Definition: logging.cpp:307
BCLog::Logger::m_log_sourcelocations
bool m_log_sourcelocations
Definition: logging.h:101
BCLog::Logger::m_file_path
fs::path m_file_path
Definition: logging.h:103
BCLog::RAND
@ RAND
Definition: logging.h:52
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:13
BCLog::COINDB
@ COINDB
Definition: logging.h:57
BCLog::Logger::DefaultShrinkDebugFile
bool DefaultShrinkDebugFile() const
Default for whether ShrinkDebugFile should be run.
Definition: logging.cpp:345
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:131
LogAcceptCategory
static bool LogAcceptCategory(BCLog::LogFlags category)
Return true if log accepts specified category.
Definition: logging.h:169
BCLog
Definition: timer.h:16
BCLog::MEMPOOL
@ MEMPOOL
Definition: logging.h:41
BCLog::AVALANCHE
@ AVALANCHE
Definition: logging.h:61
BCLog::Logger::m_print_to_console
bool m_print_to_console
Definition: logging.h:95
BCLog::Logger
Definition: logging.h:66
BCLog::Logger::m_log_time_micros
bool m_log_time_micros
Definition: logging.h:99
BCLog::SELECTCOINS
@ SELECTCOINS
Definition: logging.h:49
BCLog::ADDRMAN
@ ADDRMAN
Definition: logging.h:48
BCLog::NET
@ NET
Definition: logging.h:39
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:181
BCLog::CMPCTBLOCK
@ CMPCTBLOCK
Definition: logging.h:51
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:1111
BCLog::Logger::m_log_threadnames
bool m_log_threadnames
Definition: logging.h:100
BCLog::Logger::DisableCategory
void DisableCategory(LogFlags category)
Definition: logging.cpp:320
BCLog::NONE
@ NONE
Definition: logging.h:38
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:215