Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present 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 : : #include <logging.h>
7 : : #include <memusage.h>
8 : : #include <util/check.h>
9 : : #include <util/fs.h>
10 : : #include <util/string.h>
11 : : #include <util/threadnames.h>
12 : : #include <util/time.h>
13 : :
14 : : #include <array>
15 : : #include <cstring>
16 : : #include <map>
17 : : #include <optional>
18 : : #include <utility>
19 : :
20 : : using util::Join;
21 : : using util::RemovePrefixView;
22 : :
23 : : const char * const DEFAULT_DEBUGLOGFILE = "debug.log";
24 : : constexpr auto MAX_USER_SETABLE_SEVERITY_LEVEL{BCLog::Level::Info};
25 : :
26 : 882762 : BCLog::Logger& LogInstance()
27 : : {
28 : : /**
29 : : * NOTE: the logger instances is leaked on exit. This is ugly, but will be
30 : : * cleaned up by the OS/libc. Defining a logger as a global object doesn't work
31 : : * since the order of destruction of static/global objects is undefined.
32 : : * Consider if the logger gets destroyed, and then some later destructor calls
33 : : * LogPrintf, maybe indirectly, and you get a core dump at shutdown trying to
34 : : * access the logger. When the shutdown sequence is fully audited and tested,
35 : : * explicit destruction of these objects can be implemented by changing this
36 : : * from a raw pointer to a std::unique_ptr.
37 : : * Since the ~Logger() destructor is never called, the Logger class and all
38 : : * its subclasses must have implicitly-defined destructors.
39 : : *
40 : : * This method of initialization was originally introduced in
41 : : * ee3374234c60aba2cc4c5cd5cac1c0aefc2d817c.
42 : : */
43 [ + + + - : 882762 : static BCLog::Logger* g_logger{new BCLog::Logger()};
+ - ]
44 : 882762 : return *g_logger;
45 : : }
46 : :
47 : : bool fLogIPs = DEFAULT_LOGIPS;
48 : :
49 : 296625 : static int FileWriteStr(std::string_view str, FILE *fp)
50 : : {
51 : 296625 : return fwrite(str.data(), 1, str.size(), fp);
52 : : }
53 : :
54 : 626 : bool BCLog::Logger::StartLogging()
55 : : {
56 : 626 : StdLockGuard scoped_lock(m_cs);
57 : :
58 [ - + ]: 626 : assert(m_buffering);
59 [ - + ]: 626 : assert(m_fileout == nullptr);
60 : :
61 [ + - ]: 626 : if (m_print_to_file) {
62 [ - + ]: 626 : assert(!m_file_path.empty());
63 [ + - ]: 626 : m_fileout = fsbridge::fopen(m_file_path, "a");
64 [ + - ]: 626 : if (!m_fileout) {
65 : : return false;
66 : : }
67 : :
68 : 626 : setbuf(m_fileout, nullptr); // unbuffered
69 : :
70 : : // Add newlines to the logfile to distinguish this execution from the
71 : : // last one.
72 [ + - ]: 626 : FileWriteStr("\n\n\n\n\n", m_fileout);
73 : : }
74 : :
75 : : // dump buffered messages from before we opened the log
76 : 626 : m_buffering = false;
77 [ - + ]: 626 : if (m_buffer_lines_discarded > 0) {
78 [ # # # # ]: 0 : LogPrintStr_(strprintf("Early logging buffer overflowed, %d log lines discarded.\n", m_buffer_lines_discarded), std::source_location::current(), BCLog::ALL, Level::Info, /*should_ratelimit=*/false);
79 : : }
80 [ + + ]: 1876 : while (!m_msgs_before_open.empty()) {
81 [ - + ]: 1250 : const auto& buflog = m_msgs_before_open.front();
82 [ - + ]: 1250 : std::string s{buflog.str};
83 [ - + + - ]: 1250 : FormatLogStrInPlace(s, buflog.category, buflog.level, buflog.source_loc, buflog.threadname, buflog.now, buflog.mocktime);
84 : 1250 : m_msgs_before_open.pop_front();
85 : :
86 [ + - - + : 1250 : if (m_print_to_file) FileWriteStr(s, m_fileout);
+ - ]
87 [ - + - - : 1250 : if (m_print_to_console) fwrite(s.data(), 1, s.size(), stdout);
- - ]
88 [ + + ]: 2500 : for (const auto& cb : m_print_callbacks) {
89 [ + - ]: 1250 : cb(s);
90 : : }
91 : 1250 : }
92 : 626 : m_cur_buffer_memusage = 0;
93 [ - + - - ]: 626 : if (m_print_to_console) fflush(stdout);
94 : :
95 : : return true;
96 : 626 : }
97 : :
98 : 625 : void BCLog::Logger::DisconnectTestLogger()
99 : : {
100 : 625 : StdLockGuard scoped_lock(m_cs);
101 : 625 : m_buffering = true;
102 [ + - + - ]: 625 : if (m_fileout != nullptr) fclose(m_fileout);
103 : 625 : m_fileout = nullptr;
104 : 625 : m_print_callbacks.clear();
105 : 625 : m_max_buffer_memusage = DEFAULT_MAX_LOG_BUFFER;
106 : 625 : m_cur_buffer_memusage = 0;
107 : 625 : m_buffer_lines_discarded = 0;
108 : 625 : m_msgs_before_open.clear();
109 : 625 : }
110 : :
111 : 0 : void BCLog::Logger::DisableLogging()
112 : : {
113 : 0 : {
114 : 0 : StdLockGuard scoped_lock(m_cs);
115 [ # # ]: 0 : assert(m_buffering);
116 [ # # ]: 0 : assert(m_print_callbacks.empty());
117 : 0 : }
118 : 0 : m_print_to_file = false;
119 : 0 : m_print_to_console = false;
120 : 0 : StartLogging();
121 : 0 : }
122 : :
123 : 637 : void BCLog::Logger::EnableCategory(BCLog::LogFlags flag)
124 : : {
125 : 637 : m_categories |= flag;
126 : 637 : }
127 : :
128 : 625 : bool BCLog::Logger::EnableCategory(std::string_view str)
129 : : {
130 : 625 : BCLog::LogFlags flag;
131 [ + - ]: 625 : if (!GetLogCategory(flag, str)) return false;
132 : 625 : EnableCategory(flag);
133 : 625 : return true;
134 : : }
135 : :
136 : 1264 : void BCLog::Logger::DisableCategory(BCLog::LogFlags flag)
137 : : {
138 : 1264 : m_categories &= ~flag;
139 : 1264 : }
140 : :
141 : 1250 : bool BCLog::Logger::DisableCategory(std::string_view str)
142 : : {
143 : 1250 : BCLog::LogFlags flag;
144 [ + - ]: 1250 : if (!GetLogCategory(flag, str)) return false;
145 : 1250 : DisableCategory(flag);
146 : 1250 : return true;
147 : : }
148 : :
149 : 317120 : bool BCLog::Logger::WillLogCategory(BCLog::LogFlags category) const
150 : : {
151 : 317120 : return (m_categories.load(std::memory_order_relaxed) & category) != 0;
152 : : }
153 : :
154 : 278345 : bool BCLog::Logger::WillLogCategoryLevel(BCLog::LogFlags category, BCLog::Level level) const
155 : : {
156 : : // Log messages at Info, Warning and Error level unconditionally, so that
157 : : // important troubleshooting information doesn't get lost.
158 [ + + ]: 278345 : if (level >= BCLog::Level::Info) return true;
159 : :
160 [ + + ]: 278289 : if (!WillLogCategory(category)) return false;
161 : :
162 : 275541 : StdLockGuard scoped_lock(m_cs);
163 : 275541 : const auto it{m_category_log_levels.find(category)};
164 [ + + ]: 275541 : return level >= (it == m_category_log_levels.end() ? LogLevel() : it->second);
165 : 275541 : }
166 : :
167 : 1 : bool BCLog::Logger::DefaultShrinkDebugFile() const
168 : : {
169 : 1 : return m_categories == BCLog::NONE;
170 : : }
171 : :
172 : : static const std::map<std::string, BCLog::LogFlags, std::less<>> LOG_CATEGORIES_BY_STR{
173 : : {"net", BCLog::NET},
174 : : {"tor", BCLog::TOR},
175 : : {"mempool", BCLog::MEMPOOL},
176 : : {"http", BCLog::HTTP},
177 : : {"bench", BCLog::BENCH},
178 : : {"zmq", BCLog::ZMQ},
179 : : {"walletdb", BCLog::WALLETDB},
180 : : {"rpc", BCLog::RPC},
181 : : {"estimatefee", BCLog::ESTIMATEFEE},
182 : : {"addrman", BCLog::ADDRMAN},
183 : : {"selectcoins", BCLog::SELECTCOINS},
184 : : {"reindex", BCLog::REINDEX},
185 : : {"cmpctblock", BCLog::CMPCTBLOCK},
186 : : {"rand", BCLog::RAND},
187 : : {"prune", BCLog::PRUNE},
188 : : {"proxy", BCLog::PROXY},
189 : : {"mempoolrej", BCLog::MEMPOOLREJ},
190 : : {"libevent", BCLog::LIBEVENT},
191 : : {"coindb", BCLog::COINDB},
192 : : {"qt", BCLog::QT},
193 : : {"leveldb", BCLog::LEVELDB},
194 : : {"validation", BCLog::VALIDATION},
195 : : {"i2p", BCLog::I2P},
196 : : {"ipc", BCLog::IPC},
197 : : #ifdef DEBUG_LOCKCONTENTION
198 : : {"lock", BCLog::LOCK},
199 : : #endif
200 : : {"blockstorage", BCLog::BLOCKSTORAGE},
201 : : {"txreconciliation", BCLog::TXRECONCILIATION},
202 : : {"scan", BCLog::SCAN},
203 : : {"txpackages", BCLog::TXPACKAGES},
204 : : {"kernel", BCLog::KERNEL},
205 : : };
206 : :
207 : : static const std::unordered_map<BCLog::LogFlags, std::string> LOG_CATEGORIES_BY_FLAG{
208 : : // Swap keys and values from LOG_CATEGORIES_BY_STR.
209 : 144 : [](const auto& in) {
210 : 144 : std::unordered_map<BCLog::LogFlags, std::string> out;
211 [ + - + + ]: 4320 : for (const auto& [k, v] : in) {
212 : 4176 : const bool inserted{out.emplace(v, k).second};
213 [ - + ]: 4176 : assert(inserted);
214 : : }
215 : 144 : return out;
216 : 0 : }(LOG_CATEGORIES_BY_STR)
217 : : };
218 : :
219 : 1908 : bool GetLogCategory(BCLog::LogFlags& flag, std::string_view str)
220 : : {
221 [ + + + - : 1908 : if (str.empty() || str == "1" || str == "all") {
- + ]
222 : 625 : flag = BCLog::ALL;
223 : 625 : return true;
224 : : }
225 : 1283 : auto it = LOG_CATEGORIES_BY_STR.find(str);
226 [ + - ]: 1283 : if (it != LOG_CATEGORIES_BY_STR.end()) {
227 : 1283 : flag = it->second;
228 : 1283 : return true;
229 : : }
230 : : return false;
231 : : }
232 : :
233 : 3668 : std::string BCLog::Logger::LogLevelToStr(BCLog::Level level)
234 : : {
235 [ + + + + : 3668 : switch (level) {
+ - ]
236 : 1619 : case BCLog::Level::Trace:
237 : 1619 : return "trace";
238 : 1252 : case BCLog::Level::Debug:
239 : 1252 : return "debug";
240 : 672 : case BCLog::Level::Info:
241 : 672 : return "info";
242 : 14 : case BCLog::Level::Warning:
243 : 14 : return "warning";
244 : 111 : case BCLog::Level::Error:
245 : 111 : return "error";
246 : : }
247 : 0 : assert(false);
248 : : }
249 : :
250 : 273868 : static std::string LogCategoryToStr(BCLog::LogFlags category)
251 : : {
252 [ - + ]: 273868 : if (category == BCLog::ALL) {
253 : 0 : return "all";
254 : : }
255 : 273868 : auto it = LOG_CATEGORIES_BY_FLAG.find(category);
256 [ - + ]: 273868 : assert(it != LOG_CATEGORIES_BY_FLAG.end());
257 [ - + ]: 273868 : return it->second;
258 : : }
259 : :
260 : 631 : static std::optional<BCLog::Level> GetLogLevel(std::string_view level_str)
261 : : {
262 [ + + ]: 631 : if (level_str == "trace") {
263 : 627 : return BCLog::Level::Trace;
264 [ + + ]: 4 : } else if (level_str == "debug") {
265 : 2 : return BCLog::Level::Debug;
266 [ + - ]: 2 : } else if (level_str == "info") {
267 : 2 : return BCLog::Level::Info;
268 [ # # ]: 0 : } else if (level_str == "warning") {
269 : 0 : return BCLog::Level::Warning;
270 [ # # ]: 0 : } else if (level_str == "error") {
271 : 0 : return BCLog::Level::Error;
272 : : } else {
273 : 0 : return std::nullopt;
274 : : }
275 : : }
276 : :
277 : 1339 : std::vector<LogCategory> BCLog::Logger::LogCategoriesList() const
278 : : {
279 : 1339 : std::vector<LogCategory> ret;
280 [ + - ]: 1339 : ret.reserve(LOG_CATEGORIES_BY_STR.size());
281 [ - + + + ]: 40170 : for (const auto& [category, flag] : LOG_CATEGORIES_BY_STR) {
282 [ - + + - : 77662 : ret.push_back(LogCategory{.category = category, .active = WillLogCategory(flag)});
+ - ]
283 : : }
284 : 1339 : return ret;
285 : 0 : }
286 : :
287 : : /** Log severity levels that can be selected by the user. */
288 : : static constexpr std::array<BCLog::Level, 3> LogLevelsList()
289 : : {
290 : : return {BCLog::Level::Info, BCLog::Level::Debug, BCLog::Level::Trace};
291 : : }
292 : :
293 : 625 : std::string BCLog::Logger::LogLevelsString() const
294 : : {
295 : 625 : const auto& levels = LogLevelsList();
296 [ + - + - ]: 3125 : return Join(std::vector<BCLog::Level>{levels.begin(), levels.end()}, ", ", [](BCLog::Level level) { return LogLevelToStr(level); });
297 : : }
298 : :
299 : 296000 : std::string BCLog::Logger::LogTimestampStr(SystemClock::time_point now, std::chrono::seconds mocktime) const
300 : : {
301 [ + + ]: 296000 : std::string strStamped;
302 : :
303 [ + + ]: 296000 : if (!m_log_timestamps)
304 : : return strStamped;
305 : :
306 : 295904 : const auto now_seconds{std::chrono::time_point_cast<std::chrono::seconds>(now)};
307 [ + - ]: 295904 : strStamped = FormatISO8601DateTime(TicksSinceEpoch<std::chrono::seconds>(now_seconds));
308 [ + - + - ]: 295904 : if (m_log_time_micros && !strStamped.empty()) {
309 : 295904 : strStamped.pop_back();
310 [ + - ]: 591808 : strStamped += strprintf(".%06dZ", Ticks<std::chrono::microseconds>(now - now_seconds));
311 : : }
312 [ + + ]: 295904 : if (mocktime > 0s) {
313 [ + - + - : 576954 : strStamped += " (mocktime: " + FormatISO8601DateTime(count_seconds(mocktime)) + ")";
- + ]
314 : : }
315 [ + - ]: 591904 : strStamped += ' ';
316 : :
317 : : return strStamped;
318 : 0 : }
319 : :
320 : : namespace BCLog {
321 : : /** Belts and suspenders: make sure outgoing log messages don't contain
322 : : * potentially suspicious characters, such as terminal control codes.
323 : : *
324 : : * This escapes control characters except newline ('\n') in C syntax.
325 : : * It escapes instead of removes them to still allow for troubleshooting
326 : : * issues where they accidentally end up in strings.
327 : : */
328 : 296005 : std::string LogEscapeMessage(std::string_view str) {
329 : 296005 : std::string ret;
330 [ + + ]: 29880901 : for (char ch_in : str) {
331 : 29584896 : uint8_t ch = (uint8_t)ch_in;
332 [ + + + + ]: 29584896 : if ((ch >= 32 || ch == '\n') && ch != '\x7f') {
333 [ + - ]: 59169788 : ret += ch_in;
334 : : } else {
335 [ + - ]: 8 : ret += strprintf("\\x%02x", ch);
336 : : }
337 : : }
338 : 296005 : return ret;
339 : 0 : }
340 : : } // namespace BCLog
341 : :
342 : 296000 : std::string BCLog::Logger::GetLogPrefix(BCLog::LogFlags category, BCLog::Level level) const
343 : : {
344 [ + + ]: 296000 : if (category == LogFlags::NONE) category = LogFlags::ALL;
345 : :
346 [ + - + + ]: 296000 : const bool has_category{m_always_print_category_level || category != LogFlags::ALL};
347 : :
348 : : // If there is no category, Info is implied
349 [ + + ]: 296000 : if (!has_category && level == Level::Info) return {};
350 : :
351 : 273985 : std::string s{"["};
352 [ + + ]: 273985 : if (has_category) {
353 [ + - ]: 547736 : s += LogCategoryToStr(category);
354 : : }
355 : :
356 [ + - + + ]: 273985 : if (m_always_print_category_level || !has_category || level != Level::Debug) {
357 : : // If there is a category, Debug is implied, so don't add the level
358 : :
359 : : // Only add separator if we have a category
360 [ + + + - ]: 1168 : if (has_category) s += ":";
361 [ + - ]: 2336 : s += Logger::LogLevelToStr(level);
362 : : }
363 : :
364 [ + - ]: 273985 : s += "] ";
365 : 273985 : return s;
366 : 273985 : }
367 : :
368 : 1251 : static size_t MemUsage(const BCLog::Logger::BufferedLog& buflog)
369 : : {
370 : 1251 : return memusage::DynamicUsage(buflog.str) +
371 : 1251 : memusage::DynamicUsage(buflog.threadname) +
372 : 1251 : memusage::MallocUsage(sizeof(memusage::list_node<BCLog::Logger::BufferedLog>));
373 : : }
374 : :
375 : 3 : BCLog::LogRateLimiter::LogRateLimiter(uint64_t max_bytes, std::chrono::seconds reset_window)
376 : 3 : : m_max_bytes{max_bytes}, m_reset_window{reset_window} {}
377 : :
378 : 3 : std::shared_ptr<BCLog::LogRateLimiter> BCLog::LogRateLimiter::Create(
379 : : SchedulerFunction&& scheduler_func, uint64_t max_bytes, std::chrono::seconds reset_window)
380 : : {
381 [ + - ]: 3 : auto limiter{std::shared_ptr<LogRateLimiter>(new LogRateLimiter(max_bytes, reset_window))};
382 [ + - ]: 3 : std::weak_ptr<LogRateLimiter> weak_limiter{limiter};
383 [ + - + - : 60 : auto reset = [weak_limiter] {
+ - + - -
- ]
384 [ + - + - ]: 2 : if (auto shared_limiter{weak_limiter.lock()}) shared_limiter->Reset();
385 : 2 : };
386 [ + - + - ]: 3 : scheduler_func(reset, limiter->m_reset_window);
387 [ + - ]: 3 : return limiter;
388 [ + - ]: 6 : }
389 : :
390 : 93 : BCLog::LogRateLimiter::Status BCLog::LogRateLimiter::Consume(
391 : : const std::source_location& source_loc,
392 : : const std::string& str)
393 : : {
394 : 93 : StdLockGuard scoped_lock(m_mutex);
395 [ + - ]: 93 : auto& stats{m_source_locations.try_emplace(source_loc, m_max_bytes).first->second};
396 [ + + ]: 93 : Status status{stats.m_dropped_bytes > 0 ? Status::STILL_SUPPRESSED : Status::UNSUPPRESSED};
397 : :
398 [ - + + - : 93 : if (!stats.Consume(str.size()) && status == Status::UNSUPPRESSED) {
+ + + + ]
399 : 3 : status = Status::NEWLY_SUPPRESSED;
400 : 3 : m_suppression_active = true;
401 : : }
402 : :
403 : 93 : return status;
404 : 93 : }
405 : :
406 : 296000 : void BCLog::Logger::FormatLogStrInPlace(std::string& str, BCLog::LogFlags category, BCLog::Level level, const std::source_location& source_loc, std::string_view threadname, SystemClock::time_point now, std::chrono::seconds mocktime) const
407 : : {
408 [ - + ]: 300892 : if (!str.ends_with('\n')) str.push_back('\n');
409 : :
410 [ + - ]: 296000 : str.insert(0, GetLogPrefix(category, level));
411 : :
412 [ + + ]: 296000 : if (m_log_sourcelocations) {
413 [ + - + - : 1479555 : str.insert(0, strprintf("[%s:%d] [%s] ", RemovePrefixView(source_loc.file_name(), "./"), source_loc.line(), source_loc.function_name()));
+ - + - ]
414 : : }
415 : :
416 [ + + ]: 296000 : if (m_log_threadnames) {
417 [ + + + - ]: 591808 : str.insert(0, strprintf("[%s] ", (threadname.empty() ? "unknown" : threadname)));
418 : : }
419 : :
420 [ + - ]: 296000 : str.insert(0, LogTimestampStr(now, mocktime));
421 : 296000 : }
422 : :
423 : 296000 : void BCLog::Logger::LogPrintStr(std::string_view str, std::source_location&& source_loc, BCLog::LogFlags category, BCLog::Level level, bool should_ratelimit)
424 : : {
425 : 296000 : StdLockGuard scoped_lock(m_cs);
426 [ + - ]: 296000 : return LogPrintStr_(str, std::move(source_loc), category, level, should_ratelimit);
427 : 296000 : }
428 : :
429 : : // NOLINTNEXTLINE(misc-no-recursion)
430 : 296001 : void BCLog::Logger::LogPrintStr_(std::string_view str, std::source_location&& source_loc, BCLog::LogFlags category, BCLog::Level level, bool should_ratelimit)
431 : : {
432 : 296001 : std::string str_prefixed = LogEscapeMessage(str);
433 : :
434 [ + + ]: 296001 : if (m_buffering) {
435 : 1251 : {
436 : 1251 : BufferedLog buf{
437 : 1251 : .now = SystemClock::now(),
438 [ + - ]: 1251 : .mocktime = GetMockTime(),
439 : : .str = str_prefixed,
440 : : .threadname = util::ThreadGetInternalName(),
441 : : .source_loc = std::move(source_loc),
442 : : .category = category,
443 : : .level = level,
444 [ + - ]: 1251 : };
445 : 1251 : m_cur_buffer_memusage += MemUsage(buf);
446 [ + - ]: 1251 : m_msgs_before_open.push_back(std::move(buf));
447 : 0 : }
448 : :
449 [ - + ]: 1251 : while (m_cur_buffer_memusage > m_max_buffer_memusage) {
450 [ # # ]: 0 : if (m_msgs_before_open.empty()) {
451 : 0 : m_cur_buffer_memusage = 0;
452 : 0 : break;
453 : : }
454 : 0 : m_cur_buffer_memusage -= MemUsage(m_msgs_before_open.front());
455 : 0 : m_msgs_before_open.pop_front();
456 : 0 : ++m_buffer_lines_discarded;
457 : : }
458 : :
459 : 1251 : return;
460 : : }
461 : :
462 [ + - + - : 589500 : FormatLogStrInPlace(str_prefixed, category, level, source_loc, util::ThreadGetInternalName(), SystemClock::now(), GetMockTime());
+ - ]
463 : 294750 : bool ratelimit{false};
464 [ + + + + ]: 294750 : if (should_ratelimit && m_limiter) {
465 [ + - ]: 85 : auto status{m_limiter->Consume(source_loc, str_prefixed)};
466 [ + + ]: 85 : if (status == LogRateLimiter::Status::NEWLY_SUPPRESSED) {
467 : : // NOLINTNEXTLINE(misc-no-recursion)
468 [ + - ]: 2 : LogPrintStr_(strprintf(
469 : : "Excessive logging detected from %s:%d (%s): >%d bytes logged during "
470 : : "the last time window of %is. Suppressing logging to disk from this "
471 : : "source location until time window resets. Console logging "
472 : : "unaffected. Last log entry.",
473 [ + - + - : 3 : source_loc.file_name(), source_loc.line(), source_loc.function_name(),
+ - ]
474 [ + - ]: 1 : m_limiter->m_max_bytes,
475 : 1 : Ticks<std::chrono::seconds>(m_limiter->m_reset_window)),
476 [ + - ]: 1 : std::source_location::current(), LogFlags::ALL, Level::Warning, /*should_ratelimit=*/false); // with should_ratelimit=false, this cannot lead to infinite recursion
477 [ + + ]: 84 : } else if (status == LogRateLimiter::Status::STILL_SUPPRESSED) {
478 : 1 : ratelimit = true;
479 : : }
480 : : }
481 : :
482 : : // To avoid confusion caused by dropped log messages when debugging an issue,
483 : : // we prefix log lines with "[*]" when there are any suppressed source locations.
484 [ + + + + ]: 294750 : if (m_limiter && m_limiter->SuppressionsActive()) {
485 [ + - ]: 4 : str_prefixed.insert(0, "[*] ");
486 : : }
487 : :
488 [ - + ]: 294750 : if (m_print_to_console) {
489 : : // print to console
490 [ # # # # ]: 0 : fwrite(str_prefixed.data(), 1, str_prefixed.size(), stdout);
491 [ # # ]: 0 : fflush(stdout);
492 : : }
493 [ + + ]: 590372 : for (const auto& cb : m_print_callbacks) {
494 [ + - ]: 295622 : cb(str_prefixed);
495 : : }
496 [ + - + + ]: 294750 : if (m_print_to_file && !ratelimit) {
497 [ - + ]: 294749 : assert(m_fileout != nullptr);
498 : :
499 : : // reopen the log file, if requested
500 [ + + ]: 294749 : if (m_reopen_file) {
501 [ + - ]: 7 : m_reopen_file = false;
502 [ + - ]: 7 : FILE* new_fileout = fsbridge::fopen(m_file_path, "a");
503 [ + - ]: 7 : if (new_fileout) {
504 : 7 : setbuf(new_fileout, nullptr); // unbuffered
505 [ + - ]: 7 : fclose(m_fileout);
506 : 7 : m_fileout = new_fileout;
507 : : }
508 : : }
509 [ - + + - ]: 294749 : FileWriteStr(str_prefixed, m_fileout);
510 : : }
511 : 296001 : }
512 : :
513 : 0 : void BCLog::Logger::ShrinkDebugFile()
514 : : {
515 : : // Amount of debug.log to save at end when shrinking (must fit in memory)
516 : 0 : constexpr size_t RECENT_DEBUG_HISTORY_SIZE = 10 * 1000000;
517 : :
518 [ # # ]: 0 : assert(!m_file_path.empty());
519 : :
520 : : // Scroll debug.log if it's getting too big
521 : 0 : FILE* file = fsbridge::fopen(m_file_path, "r");
522 : :
523 : : // Special files (e.g. device nodes) may not have a size.
524 : 0 : size_t log_size = 0;
525 : 0 : try {
526 [ # # ]: 0 : log_size = fs::file_size(m_file_path);
527 [ - - ]: 0 : } catch (const fs::filesystem_error&) {}
528 : :
529 : : // If debug.log file is more than 10% bigger the RECENT_DEBUG_HISTORY_SIZE
530 : : // trim it down by saving only the last RECENT_DEBUG_HISTORY_SIZE bytes
531 [ # # ]: 0 : if (file && log_size > 11 * (RECENT_DEBUG_HISTORY_SIZE / 10))
532 : : {
533 : : // Restart the file with some of the end
534 : 0 : std::vector<char> vch(RECENT_DEBUG_HISTORY_SIZE, 0);
535 [ # # # # ]: 0 : if (fseek(file, -((long)vch.size()), SEEK_END)) {
536 [ # # ]: 0 : LogPrintf("Failed to shrink debug log file: fseek(...) failed\n");
537 [ # # ]: 0 : fclose(file);
538 : 0 : return;
539 : : }
540 [ # # # # ]: 0 : int nBytes = fread(vch.data(), 1, vch.size(), file);
541 [ # # ]: 0 : fclose(file);
542 : :
543 [ # # ]: 0 : file = fsbridge::fopen(m_file_path, "w");
544 [ # # ]: 0 : if (file)
545 : : {
546 [ # # ]: 0 : fwrite(vch.data(), 1, nBytes, file);
547 [ # # ]: 0 : fclose(file);
548 : : }
549 : 0 : }
550 [ # # ]: 0 : else if (file != nullptr)
551 : 0 : fclose(file);
552 : : }
553 : :
554 : 3 : void BCLog::LogRateLimiter::Reset()
555 : : {
556 [ + - ]: 3 : decltype(m_source_locations) source_locations;
557 : 3 : {
558 [ + - ]: 3 : StdLockGuard scoped_lock(m_mutex);
559 : 3 : source_locations.swap(m_source_locations);
560 : 3 : m_suppression_active = false;
561 : 3 : }
562 [ + + + + ]: 7 : for (const auto& [source_loc, stats] : source_locations) {
563 [ + + ]: 4 : if (stats.m_dropped_bytes == 0) continue;
564 [ + - + - : 12 : LogPrintLevel_(
+ - + - ]
565 : : LogFlags::ALL, Level::Warning, /*should_ratelimit=*/false,
566 : : "Restarting logging from %s:%d (%s): %d bytes were dropped during the last %ss.",
567 : : source_loc.file_name(), source_loc.line(), source_loc.function_name(),
568 : : stats.m_dropped_bytes, Ticks<std::chrono::seconds>(m_reset_window));
569 : : }
570 : 3 : }
571 : :
572 : 96 : bool BCLog::LogRateLimiter::Stats::Consume(uint64_t bytes)
573 : : {
574 [ + + ]: 96 : if (bytes > m_available_bytes) {
575 : 6 : m_dropped_bytes += bytes;
576 : 6 : m_available_bytes = 0;
577 : 6 : return false;
578 : : }
579 : :
580 : 90 : m_available_bytes -= bytes;
581 : 90 : return true;
582 : : }
583 : :
584 : 627 : bool BCLog::Logger::SetLogLevel(std::string_view level_str)
585 : : {
586 : 627 : const auto level = GetLogLevel(level_str);
587 [ + - + - ]: 627 : if (!level.has_value() || level.value() > MAX_USER_SETABLE_SEVERITY_LEVEL) return false;
588 : 627 : m_log_level = level.value();
589 : 627 : return true;
590 : : }
591 : :
592 : 4 : bool BCLog::Logger::SetCategoryLogLevel(std::string_view category_str, std::string_view level_str)
593 : : {
594 : 4 : BCLog::LogFlags flag;
595 [ + - ]: 4 : if (!GetLogCategory(flag, category_str)) return false;
596 : :
597 : 4 : const auto level = GetLogLevel(level_str);
598 [ + - + - ]: 4 : if (!level.has_value() || level.value() > MAX_USER_SETABLE_SEVERITY_LEVEL) return false;
599 : :
600 : 4 : StdLockGuard scoped_lock(m_cs);
601 [ + - ]: 4 : m_category_log_levels[flag] = level.value();
602 : 4 : return true;
603 : 4 : }
|
