2 * SPDX-FileCopyrightText: 2023 Philippe Proulx <pproulx@efficios.com>
3 * SPDX-License-Identifier: MIT
6 #ifndef BABELTRACE_CPP_COMMON_BT2C_LOGGING_HPP
7 #define BABELTRACE_CPP_COMMON_BT2C_LOGGING_HPP
17 #include <babeltrace2/babeltrace.h>
19 #include "common/assert.h"
20 #include "cpp-common/bt2/private-query-executor.hpp"
21 #include "cpp-common/bt2/self-component-class.hpp"
22 #include "cpp-common/bt2/self-component-port.hpp"
23 #include "cpp-common/bt2/self-message-iterator.hpp"
24 #include "cpp-common/bt2s/optional.hpp"
25 #include "cpp-common/bt2s/span.hpp"
26 #include "cpp-common/vendor/fmt/core.h"
27 #include "cpp-common/vendor/wise-enum/wise_enum.h"
28 #include "logging/log-api.h"
33 * A logger contains an actor (self component class, self component,
34 * self message iterator, or simple module name), a current logging
35 * level, and a logging tag.
37 * It offers the log(), logMem(), logErrno(), logErrorAndThrow(),
38 * logErrorAndRethrow(), logErrorErrnoAndThrow(), and
39 * logErrorErrnoAndRethrow() method templates to log using a given
40 * level, optionally append a cause to the error of the current thread
41 * using the correct actor, and optionally throw or rethrow.
43 * The methods above expect a format string and zero or more arguments
44 * to be formatted with fmt::format().
49 using MemData = bt2s::span<const std::uint8_t>;
51 /* clang-format off */
53 /* Available log levels */
54 WISE_ENUM_CLASS_MEMBER(Level,
55 (Trace, BT_LOG_TRACE),
56 (Debug, BT_LOG_DEBUG),
58 (Warning, BT_LOG_WARNING),
59 (Error, BT_LOG_ERROR),
60 (Fatal, BT_LOG_FATAL),
67 * Builds a logger from the self component class `selfCompCls` using
68 * the tag `tag` and the logging level of `privQueryExec`.
70 explicit Logger(const bt2::SelfComponentClass selfCompCls,
71 const bt2::PrivateQueryExecutor privQueryExec, std::string tag) noexcept :
72 _mSelfCompCls {selfCompCls},
73 _mLevel {static_cast<Level>(privQueryExec.loggingLevel())}, _mTag {std::move(tag)}
78 * Builds a logger from the self component `selfComp` using the tag
81 explicit Logger(const bt2::SelfComponent selfComp, std::string tag) noexcept :
82 _mSelfComp {selfComp}, _mLevel {static_cast<Level>(selfComp.loggingLevel())}, _mTag {
89 * Builds a logger from the self source component `selfComp` using
92 explicit Logger(const bt2::SelfSourceComponent selfComp, std::string tag) noexcept :
94 bt2::SelfComponent {bt_self_component_source_as_self_component(selfComp.libObjPtr())},
100 * Builds a logger from the self filter component `selfComp` using
103 explicit Logger(const bt2::SelfFilterComponent selfComp, std::string tag) noexcept :
105 bt2::SelfComponent {bt_self_component_filter_as_self_component(selfComp.libObjPtr())},
111 * Builds a logger from the self sink component `selfComp` using the
114 explicit Logger(const bt2::SelfSinkComponent selfComp, std::string tag) noexcept :
115 Logger {bt2::SelfComponent {bt_self_component_sink_as_self_component(selfComp.libObjPtr())},
121 * Builds a logger from the self message iterator `selfMsgIter`
122 * using the tag `tag`.
124 explicit Logger(const bt2::SelfMessageIterator selfMsgIter, std::string tag) noexcept :
125 _mSelfMsgIter {selfMsgIter},
126 _mLevel {static_cast<Level>(selfMsgIter.component().loggingLevel())}, _mTag {std::move(tag)}
131 * Builds a logger from the module named `moduleName` using the tag
132 * `tag` and logging level `logLevel`.
134 explicit Logger(std::string moduleName, std::string tag, const Level logLevel) noexcept :
135 _mModuleName {std::move(moduleName)}, _mLevel {logLevel}, _mTag {std::move(tag)}
140 * Builds a logger from another logger `other` using the new tag
143 explicit Logger(const Logger& other, std::string newTag) :
144 _mSelfCompCls {other._mSelfCompCls}, _mSelfComp {other._mSelfComp},
145 _mSelfMsgIter {other._mSelfMsgIter},
146 _mModuleName {other._mModuleName}, _mLevel {other._mLevel}, _mTag {std::move(newTag)}
151 * Current logging level.
153 Level level() const noexcept
159 * Current logging level converted to a `bt_log_level` value.
163 bt_log_level cLevel() const noexcept
165 return static_cast<bt_log_level>(_mLevel);
169 * Whether or not this logger would log at the level `level`.
171 bool wouldLog(const Level level) const noexcept
173 return BT_LOG_ON_CUR_LVL(static_cast<int>(level), static_cast<int>(_mLevel));
177 * Whether or not this logger would log at the trace level.
179 bool wouldLogT() const noexcept
181 return this->wouldLog(Level::Trace);
185 * Whether or not this logger would log at the debug level.
187 bool wouldLogD() const noexcept
189 return this->wouldLog(Level::Debug);
193 * Whether or not this logger would log at the info level.
195 bool wouldLogI() const noexcept
197 return this->wouldLog(Level::Info);
201 * Whether or not this logger would log at the warning level.
203 bool wouldLogW() const noexcept
205 return this->wouldLog(Level::Warning);
209 * Whether or not this logger would log at the error level.
211 bool wouldLogE() const noexcept
213 return this->wouldLog(Level::Error);
217 * Whether or not this logger would log at the fatal level.
219 bool wouldLogF() const noexcept
221 return this->wouldLog(Level::Fatal);
227 const std::string& tag() const noexcept
233 * Self component class actor, or `bt2s::nullopt` if none.
235 const bt2s::optional<bt2::SelfComponentClass>& selfCompCls() const noexcept
237 return _mSelfCompCls;
241 * Self component actor, or `bt2s::nullopt` if none.
243 const bt2s::optional<bt2::SelfComponent>& selfComp() const noexcept
249 * Self message iterator actor, or `bt2s::nullopt` if none.
251 const bt2s::optional<bt2::SelfMessageIterator>& selfMsgIter() const noexcept
253 return _mSelfMsgIter;
257 * Name of module actor, or `bt2s::nullopt` if none.
259 const bt2s::optional<std::string>& moduleName() const noexcept
265 struct _StdLogWriter final
267 static void write(const char * const fileName, const char * const funcName,
268 const unsigned lineNo, const Level level, const char * const tag, MemData,
269 const char * const initMsg, const char * const msg) noexcept
271 BT_ASSERT_DBG(initMsg && std::strcmp(initMsg, "") == 0);
272 bt_log_write(fileName, funcName, lineNo, static_cast<bt_log_level>(level), tag, msg);
278 * Logs using the level `LevelV`.
280 * This method forwards `fmt` and `args` to fmt::format() to create
283 * If `AppendCauseV` is true, this method also appends a cause to
284 * the error of the current thread using the same message.
286 template <Level LevelV, bool AppendCauseV, typename... ArgTs>
287 void log(const char * const fileName, const char * const funcName, const unsigned int lineNo,
288 const char * const fmt, ArgTs&&...args) const
290 this->_log<_StdLogWriter, LevelV, AppendCauseV>(fileName, funcName, lineNo, {}, "", fmt,
291 std::forward<ArgTs>(args)...);
295 * Logs `msg` using the level `LevelV`.
297 * If `AppendCauseV` is true, this method also appends a cause to
298 * the error of the current thread using the same message.
300 template <Level LevelV, bool AppendCauseV>
301 void logStr(const char * const fileName, const char * const funcName, const unsigned int lineNo,
302 const char * const msg) const
304 this->_logStr<_StdLogWriter, LevelV, AppendCauseV>(fileName, funcName, lineNo, {}, "", msg);
308 * Like log() with the `Level::Error` level, but also throws a
309 * default-constructed instance of `ExcT`.
311 template <bool AppendCauseV, typename ExcT, typename... ArgTs>
312 [[noreturn]] void logErrorAndThrow(const char * const fileName, const char * const funcName,
313 const unsigned int lineNo, const char * const fmt,
314 ArgTs&&...args) const
316 this->log<Level::Error, AppendCauseV>(fileName, funcName, lineNo, fmt,
317 std::forward<ArgTs>(args)...);
322 * Like logStr() with the `Level::Error` level, but also throws a
323 * default-constructed instance of `ExcT`.
325 template <bool AppendCauseV, typename ExcT>
326 [[noreturn]] void logErrorStrAndThrow(const char * const fileName, const char * const funcName,
327 const unsigned int lineNo, const char * const msg) const
329 this->logStr<Level::Error, AppendCauseV>(fileName, funcName, lineNo, msg);
334 * Like log() with the `Level::Error` level, but also rethrows.
336 template <bool AppendCauseV, typename... ArgTs>
337 [[noreturn]] void logErrorAndRethrow(const char * const fileName, const char * const funcName,
338 const unsigned int lineNo, const char * const fmt,
339 ArgTs&&...args) const
341 this->log<Level::Error, AppendCauseV>(fileName, funcName, lineNo, fmt,
342 std::forward<ArgTs>(args)...);
347 * Like logStr() with the `Level::Error` level, but also rethrows.
349 template <bool AppendCauseV>
350 [[noreturn]] void logErrorStrAndRethrow(const char * const fileName,
351 const char * const funcName, const unsigned int lineNo,
352 const char * const msg) const
354 this->logStr<Level::Error, AppendCauseV>(fileName, funcName, lineNo, msg);
359 struct _InitMsgLogWriter final
361 static void write(const char * const fileName, const char * const funcName,
362 const unsigned lineNo, const Level level, const char * const tag, MemData,
363 const char * const initMsg, const char * const msg) noexcept
365 bt_log_write_printf(funcName, fileName, lineNo, static_cast<bt_log_level>(level), tag,
366 "%s%s", initMsg, msg);
372 * Logs the message of `errno` using the level `LevelV`.
374 * The log message starts with `initMsg`, is followed with the
375 * message for `errno`, and then with what fmt::format() creates
376 * given `fmt` and `args`.
378 * If `AppendCauseV` is true, this method also appends a cause to
379 * the error of the current thread using the same message.
381 template <Level LevelV, bool AppendCauseV, typename... ArgTs>
382 void logErrno(const char * const fileName, const char * const funcName,
383 const unsigned int lineNo, const char * const initMsg, const char * const fmt,
384 ArgTs&&...args) const
386 this->_log<_InitMsgLogWriter, LevelV, AppendCauseV>(fileName, funcName, lineNo, {},
387 this->_errnoIntroStr(initMsg).c_str(),
388 fmt, std::forward<ArgTs>(args)...);
392 * Logs the message of `errno` using the level `LevelV`.
394 * The log message starts with `initMsg`, is followed with the
395 * message for `errno`, and then with `msg`.
397 * If `AppendCauseV` is true, this method also appends a cause to
398 * the error of the current thread using the same message.
400 template <Level LevelV, bool AppendCauseV>
401 void logErrnoStr(const char * const fileName, const char * const funcName,
402 const unsigned int lineNo, const char * const initMsg,
403 const char * const msg) const
405 this->_logStr<_InitMsgLogWriter, LevelV, AppendCauseV>(
406 fileName, funcName, lineNo, {}, this->_errnoIntroStr(initMsg).c_str(), msg);
410 * Like logErrno() with the `Level::Error` level, but also throws a
411 * default-constructed instance of `ExcT`.
413 template <bool AppendCauseV, typename ExcT, typename... ArgTs>
414 [[noreturn]] void logErrorErrnoAndThrow(const char * const fileName,
415 const char * const funcName, const unsigned int lineNo,
416 const char * const initMsg, const char * const fmt,
417 ArgTs&&...args) const
419 this->logErrno<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg, fmt,
420 std::forward<ArgTs>(args)...);
425 * Like logErrnoStr() with the `Level::Error` level, but also throws
426 * a default-constructed instance of `ExcT`.
428 template <bool AppendCauseV, typename ExcT>
430 logErrorErrnoStrAndThrow(const char * const fileName, const char * const funcName,
431 const unsigned int lineNo, const char * const initMsg,
432 const char * const msg) const
434 this->logErrnoStr<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg, msg);
439 * Like logErrno() with the `Level::Error` level, but also rethrows.
441 template <bool AppendCauseV, typename... ArgTs>
442 [[noreturn]] void logErrorErrnoAndRethrow(const char * const fileName,
443 const char * const funcName,
444 const unsigned int lineNo, const char * const initMsg,
445 const char * const fmt, ArgTs&&...args) const
447 this->logErrno<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg, fmt,
448 std::forward<ArgTs>(args)...);
453 * Like logErrnoStr() with the `Level::Error` level, but also
456 template <bool AppendCauseV>
458 logErrorErrnoStrAndRethrow(const char * const fileName, const char * const funcName,
459 const unsigned int lineNo, const char * const initMsg,
460 const char * const msg) const
462 this->logErrnoStr<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg, msg);
467 struct _MemLogWriter final
469 static void write(const char * const fileName, const char * const funcName,
470 const unsigned lineNo, const Level level, const char * const tag,
471 const MemData memData, const char *, const char * const msg) noexcept
473 bt_log_write_mem(funcName, fileName, lineNo, static_cast<bt_log_level>(level), tag,
474 memData.data(), memData.size(), msg);
480 * Logs memory data using the level `LevelV`.
482 * This method forwards `fmt` and `args` to fmt::format() to create
485 template <Level LevelV, typename... ArgTs>
486 void logMem(const char * const fileName, const char * const funcName, const unsigned int lineNo,
487 const MemData memData, const char * const fmt, ArgTs&&...args) const
489 this->_log<_MemLogWriter, LevelV, false>(fileName, funcName, lineNo, memData, "", fmt,
490 std::forward<ArgTs>(args)...);
494 * Logs memory data using the level `LevelV`, starting with the
497 template <Level LevelV>
498 void logMemStr(const char * const fileName, const char * const funcName,
499 const unsigned int lineNo, const MemData memData, const char * const msg) const
501 this->_logStr<_MemLogWriter, LevelV, false>(fileName, funcName, lineNo, memData, "", msg);
506 * Formats a log message with fmt::format() given `fmt` and `args`,
507 * and then forwards everything to _logStr().
509 template <typename LogWriterT, Level LevelV, bool AppendCauseV, typename... ArgTs>
510 void _log(const char * const fileName, const char * const funcName, const unsigned int lineNo,
511 const MemData memData, const char * const initMsg, const char * const fmt,
512 ArgTs&&...args) const
514 /* Only format arguments if logging or appending an error cause */
515 if (G_UNLIKELY(this->wouldLog(LevelV) || AppendCauseV)) {
517 * Format arguments to our buffer (fmt::format_to() doesn't
518 * append a null character).
521 fmt::format_to(std::back_inserter(_mBuf), fmt, std::forward<ArgTs>(args)...);
522 _mBuf.push_back('\0');
525 this->_logStr<LogWriterT, LevelV, AppendCauseV>(fileName, funcName, lineNo, memData,
526 initMsg, _mBuf.data());
530 * Calls LogWriterT::write() with its arguments to log using the
533 * If `AppendCauseV` is true, this method also appends a cause to
534 * the error of the current thread using the concatenation of
535 * `initMsg` and `msg` as the message.
537 template <typename LogWriterT, Level LevelV, bool AppendCauseV>
538 void _logStr(const char * const fileName, const char * const funcName,
539 const unsigned int lineNo, const MemData memData, const char * const initMsg,
540 const char * const msg) const
542 /* Initial message and main message are required */
547 if (this->wouldLog(LevelV)) {
548 LogWriterT::write(fileName, funcName, lineNo, LevelV, _mTag.data(), memData, initMsg,
552 /* Append an error cause if needed */
555 bt_current_thread_error_append_cause_from_message_iterator(
556 _mSelfMsgIter->libObjPtr(), fileName, lineNo, "%s%s", initMsg, msg);
557 } else if (_mSelfComp) {
558 bt_current_thread_error_append_cause_from_component(
559 _mSelfComp->libObjPtr(), fileName, lineNo, "%s%s", initMsg, msg);
560 } else if (_mSelfCompCls) {
561 bt_current_thread_error_append_cause_from_component_class(
562 _mSelfCompCls->libObjPtr(), fileName, lineNo, "%s%s", initMsg, msg);
564 BT_ASSERT(_mModuleName);
565 bt_current_thread_error_append_cause_from_unknown(_mModuleName->data(), fileName,
566 lineNo, "%s%s", initMsg, msg);
571 static std::string _errnoIntroStr(const char * const initMsg)
573 BT_ASSERT(errno != 0);
574 return fmt::format("{}: {}", initMsg, g_strerror(errno));
577 /* Exactly one of the following four members has a value */
578 bt2s::optional<bt2::SelfComponentClass> _mSelfCompCls;
579 bt2s::optional<bt2::SelfComponent> _mSelfComp;
580 bt2s::optional<bt2::SelfMessageIterator> _mSelfMsgIter;
581 bt2s::optional<std::string> _mModuleName;
583 /* Current logging level */
589 /* Formatting buffer */
590 mutable std::vector<char> _mBuf;
594 * Returns `s` if it's not `nullptr`, or the `(null)` string otherwise.
596 inline const char *maybeNull(const char * const s) noexcept
598 return s ? s : "(null)";
601 } /* namespace bt2c */
603 /* Internal: default logger name */
604 #define _BT_CPPLOG_DEF_LOGGER _mLogger
607 * Calls log() on `_logger` to log using the level `_lvl`.
609 #define BT_CPPLOG_EX(_lvl, _logger, _fmt, ...) \
611 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
612 (_logger).log<(_lvl), false>(__FILE__, __func__, __LINE__, (_fmt), ##__VA_ARGS__); \
617 * BT_CPPLOG_EX() with specific logging levels.
619 #define BT_CPPLOGT_SPEC(_logger, _fmt, ...) \
620 BT_CPPLOG_EX(bt2c::Logger::Level::Trace, (_logger), (_fmt), ##__VA_ARGS__)
621 #define BT_CPPLOGD_SPEC(_logger, _fmt, ...) \
622 BT_CPPLOG_EX(bt2c::Logger::Level::Debug, (_logger), (_fmt), ##__VA_ARGS__)
623 #define BT_CPPLOGI_SPEC(_logger, _fmt, ...) \
624 BT_CPPLOG_EX(bt2c::Logger::Level::Info, (_logger), (_fmt), ##__VA_ARGS__)
625 #define BT_CPPLOGW_SPEC(_logger, _fmt, ...) \
626 BT_CPPLOG_EX(bt2c::Logger::Level::Warning, (_logger), (_fmt), ##__VA_ARGS__)
627 #define BT_CPPLOGE_SPEC(_logger, _fmt, ...) \
628 BT_CPPLOG_EX(bt2c::Logger::Level::Error, (_logger), (_fmt), ##__VA_ARGS__)
629 #define BT_CPPLOGF_SPEC(_logger, _fmt, ...) \
630 BT_CPPLOG_EX(bt2c::Logger::Level::Fatal, (_logger), (_fmt), ##__VA_ARGS__)
633 * BT_CPPLOG_EX() with specific logging levels and using the default
636 #define BT_CPPLOGT(_fmt, ...) BT_CPPLOGT_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
637 #define BT_CPPLOGD(_fmt, ...) BT_CPPLOGD_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
638 #define BT_CPPLOGI(_fmt, ...) BT_CPPLOGI_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
639 #define BT_CPPLOGW(_fmt, ...) BT_CPPLOGW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
640 #define BT_CPPLOGE(_fmt, ...) BT_CPPLOGE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
641 #define BT_CPPLOGF(_fmt, ...) BT_CPPLOGF_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
644 * Calls logStr() on `_logger` to log using the level `_lvl`.
646 #define BT_CPPLOG_STR_EX(_lvl, _logger, _msg) \
647 (_logger).logStr<(_lvl), false>(__FILE__, __func__, __LINE__, (_msg))
650 * BT_CPPLOG_STR_EX() with specific logging levels.
652 #define BT_CPPLOGT_STR_SPEC(_logger, _msg) \
653 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Trace, (_logger), (_msg))
654 #define BT_CPPLOGD_STR_SPEC(_logger, _msg) \
655 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Debug, (_logger), (_msg))
656 #define BT_CPPLOGI_STR_SPEC(_logger, _msg) \
657 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Info, (_logger), (_msg))
658 #define BT_CPPLOGW_STR_SPEC(_logger, _msg) \
659 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Warning, (_logger), (_msg))
660 #define BT_CPPLOGE_STR_SPEC(_logger, _msg) \
661 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Error, (_logger), (_msg))
662 #define BT_CPPLOGF_STR_SPEC(_logger, _msg) \
663 BT_CPPLOG_STR_EX(bt2c::Logger::Level::Fatal, (_logger), (_msg))
666 * BT_CPPLOG_STR_EX() with specific logging levels and using the default
669 #define BT_CPPLOGT_STR(_msg) BT_CPPLOGT_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
670 #define BT_CPPLOGD_STR(_msg) BT_CPPLOGD_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
671 #define BT_CPPLOGI_STR(_msg) BT_CPPLOGI_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
672 #define BT_CPPLOGW_STR(_msg) BT_CPPLOGW_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
673 #define BT_CPPLOGE_STR(_msg) BT_CPPLOGE_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
674 #define BT_CPPLOGF_STR(_msg) BT_CPPLOGF_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
677 * Calls logMem() on `_logger` to log using the level `_lvl`.
679 #define BT_CPPLOG_MEM_EX(_lvl, _logger, _memData, _fmt, ...) \
681 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
682 (_logger).logMem<(_lvl)>(__FILE__, __func__, __LINE__, (_memData), (_fmt), \
688 * BT_CPPLOG_MEM_EX() with specific logging levels.
690 #define BT_CPPLOGT_MEM_SPEC(_logger, _memData, _fmt, ...) \
691 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Trace, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
692 #define BT_CPPLOGD_MEM_SPEC(_logger, _memData, _fmt, ...) \
693 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Debug, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
694 #define BT_CPPLOGI_MEM_SPEC(_logger, _memData, _fmt, ...) \
695 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Info, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
696 #define BT_CPPLOGW_MEM_SPEC(_logger, _memData, _fmt, ...) \
697 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Warning, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
698 #define BT_CPPLOGE_MEM_SPEC(_logger, _memData, _fmt, ...) \
699 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Error, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
700 #define BT_CPPLOGF_MEM_SPEC(_logger, _memData, _fmt, ...) \
701 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Fatal, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
704 * BT_CPPLOG_MEM_EX() with specific logging levels and using the default
707 #define BT_CPPLOGT_MEM(_memData, _fmt, ...) \
708 BT_CPPLOGT_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
709 #define BT_CPPLOGD_MEM(_memData, _fmt, ...) \
710 BT_CPPLOGD_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
711 #define BT_CPPLOGI_MEM(_memData, _fmt, ...) \
712 BT_CPPLOGI_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
713 #define BT_CPPLOGW_MEM(_memData, _fmt, ...) \
714 BT_CPPLOGW_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
715 #define BT_CPPLOGE_MEM(_memData, _fmt, ...) \
716 BT_CPPLOGE_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
717 #define BT_CPPLOGF_MEM(_memData, _fmt, ...) \
718 BT_CPPLOGF_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
721 * Calls logMemStr() on `_logger` to log using the level `_lvl`.
723 #define BT_CPPLOG_MEM_STR_EX(_lvl, _logger, _memData, _msg) \
724 (_logger).logMemStr<(_lvl)>(__FILE__, __func__, __LINE__, (_memData), (_msg))
727 * BT_CPPLOG_MEM_STR_EX() with specific logging levels.
729 #define BT_CPPLOGT_MEM_STR_SPEC(_logger, _memData, _msg) \
730 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::TRACE, (_logger), (_memData), (_msg))
731 #define BT_CPPLOGD_MEM_STR_SPEC(_logger, _memData, _msg) \
732 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::DEBUG, (_logger), (_memData), (_msg))
733 #define BT_CPPLOGI_MEM_STR_SPEC(_logger, _memData, _msg) \
734 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::INFO, (_logger), (_memData), (_msg))
735 #define BT_CPPLOGW_MEM_STR_SPEC(_logger, _memData, _msg) \
736 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::WARNING, (_logger), (_memData), (_msg))
737 #define BT_CPPLOGE_MEM_STR_SPEC(_logger, _memData, _msg) \
738 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::Error, (_logger), (_memData), (_msg))
739 #define BT_CPPLOGF_MEM_STR_SPEC(_logger, _memData, _msg) \
740 BT_CPPLOG_MEM_STR_EX(bt2c::Logger::Level::FATAL, (_logger), (_memData), (_msg))
743 * BT_CPPLOG_MEM_STR_EX() with specific logging levels and using the
746 #define BT_CPPLOGT_MEM_STR(_memData, _msg) \
747 BT_CPPLOGT_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
748 #define BT_CPPLOGD_MEM_STR(_memData, _msg) \
749 BT_CPPLOGD_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
750 #define BT_CPPLOGI_MEM_STR(_memData, _msg) \
751 BT_CPPLOGI_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
752 #define BT_CPPLOGW_MEM_STR(_memData, _msg) \
753 BT_CPPLOGW_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
754 #define BT_CPPLOGE_MEM_STR(_memData, _msg) \
755 BT_CPPLOGE_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
756 #define BT_CPPLOGF_MEM_STR(_memData, _msg) \
757 BT_CPPLOGF_MEM_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_msg))
760 * Calls logErrno() on `_logger` to log using the level `_lvl` and
761 * initial message `_initMsg`.
763 #define BT_CPPLOG_ERRNO_EX(_lvl, _logger, _initMsg, _fmt, ...) \
765 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
766 (_logger).logErrno<(_lvl), false>(__FILE__, __func__, __LINE__, (_initMsg), (_fmt), \
772 * BT_CPPLOG_ERRNO_EX() with specific logging levels.
774 #define BT_CPPLOGT_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
775 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Trace, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
776 #define BT_CPPLOGD_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
777 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Debug, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
778 #define BT_CPPLOGI_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
779 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Info, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
780 #define BT_CPPLOGW_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
781 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Warning, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
782 #define BT_CPPLOGE_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
783 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Error, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
784 #define BT_CPPLOGF_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
785 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Fatal, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
788 * BT_CPPLOG_ERRNO_EX() with specific logging levels and using the
791 #define BT_CPPLOGT_ERRNO(_initMsg, _fmt, ...) \
792 BT_CPPLOGT_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
793 #define BT_CPPLOGD_ERRNO(_initMsg, _fmt, ...) \
794 BT_CPPLOGD_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
795 #define BT_CPPLOGI_ERRNO(_initMsg, _fmt, ...) \
796 BT_CPPLOGI_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
797 #define BT_CPPLOGW_ERRNO(_initMsg, _fmt, ...) \
798 BT_CPPLOGW_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
799 #define BT_CPPLOGE_ERRNO(_initMsg, _fmt, ...) \
800 BT_CPPLOGE_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
801 #define BT_CPPLOGF_ERRNO(_initMsg, _fmt, ...) \
802 BT_CPPLOGF_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
805 * Calls logErrnoStr() on `_logger` to log using the level `_lvl` and
806 * initial message `_initMsg`.
808 #define BT_CPPLOG_ERRNO_STR_EX(_lvl, _logger, _initMsg, _msg) \
809 (_logger).logErrnoStr<(_lvl), false>(__FILE__, __func__, __LINE__, (_initMsg), (_msg))
812 * BT_CPPLOG_ERRNO_STR_EX() with specific logging levels.
814 #define BT_CPPLOGT_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
815 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Trace, (_logger), (_initMsg), (_msg))
816 #define BT_CPPLOGD_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
817 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Debug, (_logger), (_initMsg), (_msg))
818 #define BT_CPPLOGI_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
819 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Info, (_logger), (_initMsg), (_msg))
820 #define BT_CPPLOGW_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
821 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Warning, (_logger), (_initMsg), (_msg))
822 #define BT_CPPLOGE_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
823 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Error, (_logger), (_initMsg), (_msg))
824 #define BT_CPPLOGF_ERRNO_STR_SPEC(_logger, _initMsg, _msg) \
825 BT_CPPLOG_ERRNO_STR_EX(bt2c::Logger::Level::Fatal, (_logger), (_initMsg), (_msg))
828 * BT_CPPLOG_ERRNO_STR_EX() with specific logging levels and using the
831 #define BT_CPPLOGT_ERRNO_STR(_initMsg, _msg) \
832 BT_CPPLOGT_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
833 #define BT_CPPLOGD_ERRNO_STR(_initMsg, _msg) \
834 BT_CPPLOGD_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
835 #define BT_CPPLOGI_ERRNO_STR(_initMsg, _msg) \
836 BT_CPPLOGI_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
837 #define BT_CPPLOGW_ERRNO_STR(_initMsg, _msg) \
838 BT_CPPLOGW_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
839 #define BT_CPPLOGE_ERRNO_STR(_initMsg, _msg) \
840 BT_CPPLOGE_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
841 #define BT_CPPLOGF_ERRNO_STR(_initMsg, _msg) \
842 BT_CPPLOGF_ERRNO_STR_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
845 * Calls log() on `_logger` with the `Error` level to log an error and
846 * append a cause to the error of the current thread.
848 #define BT_CPPLOGE_APPEND_CAUSE_SPEC(_logger, _fmt, ...) \
849 (_logger).log<bt2c::Logger::Level::Error, true>(__FILE__, __func__, __LINE__, (_fmt), \
853 * BT_CPPLOGE_APPEND_CAUSE_SPEC() using the default logger.
855 #define BT_CPPLOGE_APPEND_CAUSE(_fmt, ...) \
856 BT_CPPLOGE_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
859 * Calls logStr() on `_logger` with the `Error` level to log an error and
860 * append a cause to the error of the current thread.
862 #define BT_CPPLOGE_STR_APPEND_CAUSE_SPEC(_logger, _msg) \
863 (_logger).logStr<bt2c::Logger::Level::Error, true>(__FILE__, __func__, __LINE__, (_msg))
866 * BT_CPPLOGE_STR_APPEND_CAUSE_SPEC() using the default logger.
868 #define BT_CPPLOGE_STR_APPEND_CAUSE(_msg) \
869 BT_CPPLOGE_STR_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
872 * Calls logErrorAndThrow() on `_logger` to log an error, append a cause
873 * to the error of the current thread, and throw an instance of
876 #define BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _fmt, ...) \
877 (_logger).logErrorAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, (_fmt), ##__VA_ARGS__)
880 * BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC() using the default logger.
882 #define BT_CPPLOGE_APPEND_CAUSE_AND_THROW(_excCls, _fmt, ...) \
883 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_fmt), ##__VA_ARGS__)
886 * Calls logErrorStrAndThrow() on `_logger` to log an error, append a
887 * cause to the error of the current thread, and throw an instance of
890 #define BT_CPPLOGE_STR_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _msg) \
891 (_logger).logErrorStrAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, (_msg))
894 * BT_CPPLOGE_STR_APPEND_CAUSE_AND_THROW_SPEC() using the default
897 #define BT_CPPLOGE_STR_APPEND_CAUSE_AND_THROW(_excCls, _msg) \
898 BT_CPPLOGE_STR_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_msg))
901 * Calls logErrorAndRethrow() on `_logger` to log an error, append a
902 * cause to the error of the current thread, and throw an instance of
905 #define BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _fmt, ...) \
906 (_logger).logErrorAndRethrow<true>(__FILE__, __func__, __LINE__, (_fmt), ##__VA_ARGS__)
909 * BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC() using the default logger.
911 #define BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW(_fmt, ...) \
912 BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
915 * Calls logErrorStrAndRethrow() on `_logger` to log an error, append a
916 * cause to the error of the current thread, and throw an instance of
919 #define BT_CPPLOGE_STR_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _msg) \
920 (_logger).logErrorStrAndRethrow<true>(__FILE__, __func__, __LINE__, (_msg))
923 * BT_CPPLOGE_STR_APPEND_CAUSE_AND_RETHROW_SPEC() using the default
926 #define BT_CPPLOGE_STR_APPEND_CAUSE_AND_RETHROW(_msg) \
927 BT_CPPLOGE_STR_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_msg))
930 * Calls logErrno() on `_logger` with the `Level::Error` level to log an
931 * error and append a cause to the error of the current thread.
933 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(_logger, _initMsg, _fmt, ...) \
934 (_logger).logErrno<bt2c::Logger::Level::Error, true>(__FILE__, __func__, __LINE__, (_initMsg), \
935 (_fmt), ##__VA_ARGS__)
938 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC() using the default logger.
940 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE(_initMsg, _fmt, ...) \
941 BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
944 * Calls logErrnoStr() on `_logger` with the `Level::Error` level to log
945 * an error and append a cause to the error of the current thread.
947 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_SPEC(_logger, _initMsg, _msg) \
948 (_logger).logErrnoStr<bt2c::Logger::Level::Error, true>(__FILE__, __func__, __LINE__, \
952 * BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_SPEC() using the default logger.
954 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE(_initMsg, _msg) \
955 BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
958 * Calls logErrorErrnoAndThrow() on `_logger` to log an error, append a
959 * cause to the error of the current thread, and throw an instance of
962 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _initMsg, _fmt, ...) \
963 (_logger).logErrorErrnoAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, (_initMsg), \
964 (_fmt), ##__VA_ARGS__)
967 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC() using the default
970 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW(_excCls, _initMsg, _fmt, ...) \
971 BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_initMsg), \
972 (_fmt), ##__VA_ARGS__)
975 * Calls logErrorErrnoStrAndThrow() on `_logger` to log an error, append
976 * a cause to the error of the current thread, and throw an instance of
979 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _initMsg, _msg) \
980 (_logger).logErrorErrnoStrAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, (_initMsg), \
984 * BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_THROW_SPEC() using the default
987 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_THROW(_excCls, _initMsg, _msg) \
988 BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_initMsg), \
992 * Calls logErrorErrnoAndRethrow() on `_logger` to log an error, append
993 * a cause to the error of the current thread, and throw an instance of
996 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _initMsg, _fmt, ...) \
997 (_logger).logErrorErrnoAndRethrow<true>(__FILE__, __func__, __LINE__, (_initMsg), (_fmt), \
1001 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC() using the default
1004 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW(_initMsg, _fmt, ...) \
1005 BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), \
1009 * Calls logErrorErrnoStrAndRethrow() on `_logger` to log an error,
1010 * append a cause to the error of the current thread, and throw an
1011 * instance of `_excCls`.
1013 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _initMsg, _msg) \
1014 (_logger).logErrorErrnoStrAndRethrow<true>(__FILE__, __func__, __LINE__, (_initMsg), (_msg))
1017 * BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_RETHROW_SPEC() using the
1020 #define BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_RETHROW(_initMsg, _msg) \
1021 BT_CPPLOGE_ERRNO_STR_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_msg))
1023 #endif /* BABELTRACE_CPP_COMMON_BT2C_LOGGING_HPP */