Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 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 <threadsafety.h>
10 : : #include <tinyformat.h>
11 : : #include <util/fs.h>
12 : : #include <util/string.h>
13 : : #include <util/time.h>
14 : :
15 : : #include <atomic>
16 : : #include <cstdint>
17 : : #include <functional>
18 : : #include <list>
19 : : #include <mutex>
20 : : #include <string>
21 : : #include <unordered_map>
22 : : #include <vector>
23 : :
24 : : static const bool DEFAULT_LOGTIMEMICROS = false;
25 : : static const bool DEFAULT_LOGIPS = false;
26 : : static const bool DEFAULT_LOGTIMESTAMPS = true;
27 : : static const bool DEFAULT_LOGTHREADNAMES = false;
28 : : static const bool DEFAULT_LOGSOURCELOCATIONS = false;
29 : : static constexpr bool DEFAULT_LOGLEVELALWAYS = false;
30 : : extern const char * const DEFAULT_DEBUGLOGFILE;
31 : :
32 : : extern bool fLogIPs;
33 : :
34 : 336 : struct LogCategory {
35 : : std::string category;
36 : : bool active;
37 : : };
38 : :
39 : : namespace BCLog {
40 : : using CategoryMask = uint64_t;
41 : : enum LogFlags : CategoryMask {
42 : : NONE = CategoryMask{0},
43 : : NET = (CategoryMask{1} << 0),
44 : : TOR = (CategoryMask{1} << 1),
45 : : MEMPOOL = (CategoryMask{1} << 2),
46 : : HTTP = (CategoryMask{1} << 3),
47 : : BENCH = (CategoryMask{1} << 4),
48 : : ZMQ = (CategoryMask{1} << 5),
49 : : WALLETDB = (CategoryMask{1} << 6),
50 : : RPC = (CategoryMask{1} << 7),
51 : : ESTIMATEFEE = (CategoryMask{1} << 8),
52 : : ADDRMAN = (CategoryMask{1} << 9),
53 : : SELECTCOINS = (CategoryMask{1} << 10),
54 : : REINDEX = (CategoryMask{1} << 11),
55 : : CMPCTBLOCK = (CategoryMask{1} << 12),
56 : : RAND = (CategoryMask{1} << 13),
57 : : PRUNE = (CategoryMask{1} << 14),
58 : : PROXY = (CategoryMask{1} << 15),
59 : : MEMPOOLREJ = (CategoryMask{1} << 16),
60 : : LIBEVENT = (CategoryMask{1} << 17),
61 : : COINDB = (CategoryMask{1} << 18),
62 : : QT = (CategoryMask{1} << 19),
63 : : LEVELDB = (CategoryMask{1} << 20),
64 : : VALIDATION = (CategoryMask{1} << 21),
65 : : I2P = (CategoryMask{1} << 22),
66 : : IPC = (CategoryMask{1} << 23),
67 : : #ifdef DEBUG_LOCKCONTENTION
68 : : LOCK = (CategoryMask{1} << 24),
69 : : #endif
70 : : BLOCKSTORAGE = (CategoryMask{1} << 25),
71 : : TXRECONCILIATION = (CategoryMask{1} << 26),
72 : : SCAN = (CategoryMask{1} << 27),
73 : : TXPACKAGES = (CategoryMask{1} << 28),
74 : : ALL = ~NONE,
75 : : };
76 : : enum class Level {
77 : : Trace = 0, // High-volume or detailed logging for development/debugging
78 : : Debug, // Reasonably noisy logging, but still usable in production
79 : : Info, // Default
80 : : Warning,
81 : : Error,
82 : : };
83 : : constexpr auto DEFAULT_LOG_LEVEL{Level::Debug};
84 : : constexpr size_t DEFAULT_MAX_LOG_BUFFER{1'000'000}; // buffer up to 1MB of log data prior to StartLogging
85 : :
86 : : class Logger
87 : : {
88 : : public:
89 : : struct BufferedLog {
90 : : SystemClock::time_point now;
91 : : std::chrono::seconds mocktime;
92 : : std::string str, logging_function, source_file, threadname;
93 : : int source_line;
94 : : LogFlags category;
95 : : Level level;
96 : : };
97 : :
98 : : private:
99 : : 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
100 : :
101 : : FILE* m_fileout GUARDED_BY(m_cs) = nullptr;
102 : : std::list<BufferedLog> m_msgs_before_open GUARDED_BY(m_cs);
103 : : bool m_buffering GUARDED_BY(m_cs) = true; //!< Buffer messages before logging can be started.
104 : : size_t m_max_buffer_memusage GUARDED_BY(m_cs){DEFAULT_MAX_LOG_BUFFER};
105 : : size_t m_cur_buffer_memusage GUARDED_BY(m_cs){0};
106 : : size_t m_buffer_lines_discarded GUARDED_BY(m_cs){0};
107 : :
108 : : /**
109 : : * m_started_new_line is a state variable that will suppress printing of
110 : : * the timestamp when multiple calls are made that don't end in a
111 : : * newline.
112 : : */
113 : : std::atomic_bool m_started_new_line{true};
114 : :
115 : : //! Category-specific log level. Overrides `m_log_level`.
116 : : std::unordered_map<LogFlags, Level> m_category_log_levels GUARDED_BY(m_cs);
117 : :
118 : : //! If there is no category-specific log level, all logs with a severity
119 : : //! level lower than `m_log_level` will be ignored.
120 : : std::atomic<Level> m_log_level{DEFAULT_LOG_LEVEL};
121 : :
122 : : /** Log categories bitfield. */
123 : : std::atomic<CategoryMask> m_categories{BCLog::NONE};
124 : :
125 : : void FormatLogStrInPlace(std::string& str, LogFlags category, Level level, std::string_view source_file, int source_line, std::string_view logging_function, std::string_view threadname, SystemClock::time_point now, std::chrono::seconds mocktime) const;
126 : :
127 : : std::string LogTimestampStr(SystemClock::time_point now, std::chrono::seconds mocktime) const;
128 : :
129 : : /** Slots that connect to the print signal */
130 : : std::list<std::function<void(const std::string&)>> m_print_callbacks GUARDED_BY(m_cs) {};
131 : :
132 : : /** Send a string to the log output (internal) */
133 : : void LogPrintStr_(std::string_view str, std::string_view logging_function, std::string_view source_file, int source_line, BCLog::LogFlags category, BCLog::Level level)
134 : : EXCLUSIVE_LOCKS_REQUIRED(m_cs);
135 : :
136 : : std::string GetLogPrefix(LogFlags category, Level level) const;
137 : :
138 : : public:
139 : : bool m_print_to_console = false;
140 : : bool m_print_to_file = false;
141 : :
142 : : bool m_log_timestamps = DEFAULT_LOGTIMESTAMPS;
143 : : bool m_log_time_micros = DEFAULT_LOGTIMEMICROS;
144 : : bool m_log_threadnames = DEFAULT_LOGTHREADNAMES;
145 : : bool m_log_sourcelocations = DEFAULT_LOGSOURCELOCATIONS;
146 : : bool m_always_print_category_level = DEFAULT_LOGLEVELALWAYS;
147 : :
148 : : fs::path m_file_path;
149 : : std::atomic<bool> m_reopen_file{false};
150 : :
151 : : /** Send a string to the log output */
152 : : void LogPrintStr(std::string_view str, std::string_view logging_function, std::string_view source_file, int source_line, BCLog::LogFlags category, BCLog::Level level)
153 : : EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
154 : :
155 : : /** Returns whether logs will be written to any output */
156 : 127 : bool Enabled() const EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
157 : : {
158 : 127 : StdLockGuard scoped_lock(m_cs);
159 [ + + + - : 127 : return m_buffering || m_print_to_console || m_print_to_file || !m_print_callbacks.empty();
+ - - + ]
160 : 127 : }
161 : :
162 : : /** Connect a slot to the print signal and return the connection */
163 : 0 : std::list<std::function<void(const std::string&)>>::iterator PushBackCallback(std::function<void(const std::string&)> fun) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
164 : : {
165 : 0 : StdLockGuard scoped_lock(m_cs);
166 [ # # ]: 0 : m_print_callbacks.push_back(std::move(fun));
167 : 0 : return --m_print_callbacks.end();
168 : 0 : }
169 : :
170 : : /** Delete a connection */
171 : 0 : void DeleteCallback(std::list<std::function<void(const std::string&)>>::iterator it) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
172 : : {
173 : 0 : StdLockGuard scoped_lock(m_cs);
174 : 0 : m_print_callbacks.erase(it);
175 : 0 : }
176 : :
177 : : /** Start logging (and flush all buffered messages) */
178 : : bool StartLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
179 : : /** Only for testing */
180 : : void DisconnectTestLogger() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
181 : :
182 : : /** Disable logging
183 : : * This offers a slight speedup and slightly smaller memory usage
184 : : * compared to leaving the logging system in its default state.
185 : : * Mostly intended for libbitcoin-kernel apps that don't want any logging.
186 : : * Should be used instead of StartLogging().
187 : : */
188 : : void DisableLogging() EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
189 : :
190 : : void ShrinkDebugFile();
191 : :
192 : : std::unordered_map<LogFlags, Level> CategoryLevels() const EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
193 : : {
194 : : StdLockGuard scoped_lock(m_cs);
195 : : return m_category_log_levels;
196 : : }
197 : : void SetCategoryLogLevel(const std::unordered_map<LogFlags, Level>& levels) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
198 : : {
199 : : StdLockGuard scoped_lock(m_cs);
200 : : m_category_log_levels = levels;
201 : : }
202 : : bool SetCategoryLogLevel(std::string_view category_str, std::string_view level_str) EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
203 : :
204 : 0 : Level LogLevel() const { return m_log_level.load(); }
205 : : void SetLogLevel(Level level) { m_log_level = level; }
206 : : bool SetLogLevel(std::string_view level);
207 : :
208 [ # # ]: 0 : CategoryMask GetCategoryMask() const { return m_categories.load(); }
209 : :
210 : : void EnableCategory(LogFlags flag);
211 : : bool EnableCategory(std::string_view str);
212 : : void DisableCategory(LogFlags flag);
213 : : bool DisableCategory(std::string_view str);
214 : :
215 : : bool WillLogCategory(LogFlags category) const;
216 : : bool WillLogCategoryLevel(LogFlags category, Level level) const EXCLUSIVE_LOCKS_REQUIRED(!m_cs);
217 : :
218 : : /** Returns a vector of the log categories in alphabetical order. */
219 : : std::vector<LogCategory> LogCategoriesList() const;
220 : : /** Returns a string with the log categories in alphabetical order. */
221 : 4 : std::string LogCategoriesString() const
222 : : {
223 [ + - + - ]: 116 : return util::Join(LogCategoriesList(), ", ", [&](const LogCategory& i) { return i.category; });
224 : : };
225 : :
226 : : //! Returns a string with all user-selectable log levels.
227 : : std::string LogLevelsString() const;
228 : :
229 : : //! Returns the string representation of a log level.
230 : : static std::string LogLevelToStr(BCLog::Level level);
231 : :
232 : : bool DefaultShrinkDebugFile() const;
233 : : };
234 : :
235 : : } // namespace BCLog
236 : :
237 : : BCLog::Logger& LogInstance();
238 : :
239 : : /** Return true if log accepts specified category, at the specified level. */
240 : 27 : static inline bool LogAcceptCategory(BCLog::LogFlags category, BCLog::Level level)
241 : : {
242 : 27 : return LogInstance().WillLogCategoryLevel(category, level);
243 : : }
244 : :
245 : : /** Return true if str parses as a log category and set the flag */
246 : : bool GetLogCategory(BCLog::LogFlags& flag, std::string_view str);
247 : :
248 : : // Be conservative when using functions that
249 : : // unconditionally log to debug.log! It should not be the case that an inbound
250 : : // peer can fill up a user's disk with debug.log entries.
251 : :
252 : : template <typename... Args>
253 : 127 : static inline void LogPrintf_(std::string_view logging_function, std::string_view source_file, const int source_line, const BCLog::LogFlags flag, const BCLog::Level level, const char* fmt, const Args&... args)
254 : : {
255 [ + + ]: 127 : if (LogInstance().Enabled()) {
256 : 5 : std::string log_msg;
257 : : try {
258 [ + - ]: 5 : log_msg = tfm::format(fmt, args...);
259 [ - - ]: 0 : } catch (tinyformat::format_error& fmterr) {
260 : : /* Original format string will have newline so don't add one here */
261 [ - - - - : 0 : log_msg = "Error \"" + std::string(fmterr.what()) + "\" while formatting log message: " + fmt;
- - ]
262 : : }
263 [ + - + - ]: 5 : LogInstance().LogPrintStr(log_msg, logging_function, source_file, source_line, flag, level);
264 : 5 : }
265 : 127 : }
266 : :
267 : : #define LogPrintLevel_(category, level, ...) LogPrintf_(__func__, __FILE__, __LINE__, category, level, __VA_ARGS__)
268 : :
269 : : // Log unconditionally.
270 : : #define LogInfo(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, __VA_ARGS__)
271 : : #define LogWarning(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Warning, __VA_ARGS__)
272 : : #define LogError(...) LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Error, __VA_ARGS__)
273 : :
274 : : // Deprecated unconditional logging.
275 : : #define LogPrintf(...) LogInfo(__VA_ARGS__)
276 : :
277 : : // Use a macro instead of a function for conditional logging to prevent
278 : : // evaluating arguments when logging for the category is not enabled.
279 : :
280 : : // Log conditionally, prefixing the output with the passed category name and severity level.
281 : : #define LogPrintLevel(category, level, ...) \
282 : : do { \
283 : : if (LogAcceptCategory((category), (level))) { \
284 : : LogPrintLevel_(category, level, __VA_ARGS__); \
285 : : } \
286 : : } while (0)
287 : :
288 : : // Log conditionally, prefixing the output with the passed category name.
289 : : #define LogDebug(category, ...) LogPrintLevel(category, BCLog::Level::Debug, __VA_ARGS__)
290 : : #define LogTrace(category, ...) LogPrintLevel(category, BCLog::Level::Trace, __VA_ARGS__)
291 : :
292 : : #endif // BITCOIN_LOGGING_H
|
