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())},
83 _mTag {std::move(tag)}
88 * Builds a logger from the self source component `selfComp` using
91 explicit Logger(const bt2::SelfSourceComponent selfComp, std::string tag) noexcept :
93 bt2::SelfComponent {bt_self_component_source_as_self_component(selfComp.libObjPtr())},
99 * Builds a logger from the self filter component `selfComp` using
102 explicit Logger(const bt2::SelfFilterComponent selfComp, std::string tag) noexcept :
104 bt2::SelfComponent {bt_self_component_filter_as_self_component(selfComp.libObjPtr())},
110 * Builds a logger from the self sink component `selfComp` using the
113 explicit Logger(const bt2::SelfSinkComponent selfComp, std::string tag) noexcept :
114 Logger {bt2::SelfComponent {bt_self_component_sink_as_self_component(selfComp.libObjPtr())},
120 * Builds a logger from the self message iterator `selfMsgIter`
121 * using the tag `tag`.
123 explicit Logger(const bt2::SelfMessageIterator selfMsgIter, std::string tag) noexcept :
124 _mSelfMsgIter {selfMsgIter},
125 _mLevel {static_cast<Level>(selfMsgIter.component().loggingLevel())}, _mTag {std::move(tag)}
130 * Builds a logger from the module named `moduleName` using the tag
131 * `tag` and logging level `logLevel`.
133 explicit Logger(std::string moduleName, std::string tag, const Level logLevel) noexcept :
134 _mModuleName {std::move(moduleName)}, _mLevel {logLevel}, _mTag {std::move(tag)}
139 * Builds a logger from another logger `other` using the new tag
142 explicit Logger(const Logger& other, std::string newTag) :
143 _mSelfCompCls {other._mSelfCompCls}, _mSelfComp {other._mSelfComp},
144 _mSelfMsgIter {other._mSelfMsgIter}, _mModuleName {other._mModuleName},
145 _mLevel {other._mLevel}, _mTag {std::move(newTag)}
150 * Current logging level.
152 Level level() const noexcept
158 * Whether or not this logger would log at the level `level`.
160 bool wouldLog(const Level level) const noexcept
162 return BT_LOG_ON_CUR_LVL(static_cast<int>(level), static_cast<int>(_mLevel));
166 * Whether or not this logger would log at the trace level.
168 bool wouldLogT() const noexcept
170 return this->wouldLog(Level::Trace);
174 * Whether or not this logger would log at the debug level.
176 bool wouldLogD() const noexcept
178 return this->wouldLog(Level::Debug);
182 * Whether or not this logger would log at the info level.
184 bool wouldLogI() const noexcept
186 return this->wouldLog(Level::Info);
190 * Whether or not this logger would log at the warning level.
192 bool wouldLogW() const noexcept
194 return this->wouldLog(Level::Warning);
198 * Whether or not this logger would log at the error level.
200 bool wouldLogE() const noexcept
202 return this->wouldLog(Level::Error);
206 * Whether or not this logger would log at the fatal level.
208 bool wouldLogF() const noexcept
210 return this->wouldLog(Level::Fatal);
216 const std::string& tag() const noexcept
222 * Self component class actor, or `bt2s::nullopt` if none.
224 const bt2s::optional<bt2::SelfComponentClass>& selfCompCls() const noexcept
226 return _mSelfCompCls;
230 * Self component actor, or `bt2s::nullopt` if none.
232 const bt2s::optional<bt2::SelfComponent>& selfComp() const noexcept
238 * Self message iterator actor, or `bt2s::nullopt` if none.
240 const bt2s::optional<bt2::SelfMessageIterator>& selfMsgIter() const noexcept
242 return _mSelfMsgIter;
246 * Name of module actor, or `bt2s::nullopt` if none.
248 const bt2s::optional<std::string>& moduleName() const noexcept
254 struct _StdLogWriter final
256 static void write(const char * const fileName, const char * const funcName,
257 const unsigned lineNo, const Level level, const char * const tag, MemData,
258 const char * const initMsg, const char * const msg) noexcept
260 BT_ASSERT_DBG(initMsg && std::strcmp(initMsg, "") == 0);
261 bt_log_write(fileName, funcName, lineNo, static_cast<bt_log_level>(level), tag, msg);
267 * Logs using the level `LevelV`.
269 * This method forwards `fmt` and `args` to fmt::format() to create
272 * If `AppendCauseV` is true, this method also appends a cause to
273 * the error of the current thread using the same message.
275 template <Level LevelV, bool AppendCauseV, typename... ArgTs>
276 void log(const char * const fileName, const char * const funcName, const unsigned int lineNo,
277 fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
279 this->_log<_StdLogWriter, LevelV, AppendCauseV>(
280 fileName, funcName, lineNo, {}, "", std::move(fmt), std::forward<ArgTs>(args)...);
284 * Like log() with the `Level::Error` level, but also throws a
285 * default-constructed instance of `ExcT`.
287 template <bool AppendCauseV, typename ExcT, typename... ArgTs>
288 [[noreturn]] void logErrorAndThrow(const char * const fileName, const char * const funcName,
289 const unsigned int lineNo, fmt::format_string<ArgTs...> fmt,
290 ArgTs&&...args) const
292 this->log<Level::Error, AppendCauseV>(fileName, funcName, lineNo, std::move(fmt),
293 std::forward<ArgTs>(args)...);
298 * Like log() with the `Level::Error` level, but also rethrows.
300 template <bool AppendCauseV, typename... ArgTs>
301 [[noreturn]] void logErrorAndRethrow(const char * const fileName, const char * const funcName,
302 const unsigned int lineNo,
303 fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
305 this->log<Level::Error, AppendCauseV>(fileName, funcName, lineNo, std::move(fmt),
306 std::forward<ArgTs>(args)...);
311 struct _InitMsgLogWriter final
313 static void write(const char * const fileName, const char * const funcName,
314 const unsigned lineNo, const Level level, const char * const tag, MemData,
315 const char * const initMsg, const char * const msg) noexcept
317 bt_log_write_printf(funcName, fileName, lineNo, static_cast<bt_log_level>(level), tag,
318 "%s%s", initMsg, msg);
324 * Logs the message of `errno` using the level `LevelV`.
326 * The log message starts with `initMsg`, is followed with the
327 * message for `errno`, and then with what fmt::format() creates
328 * given `fmt` and `args`.
330 * If `AppendCauseV` is true, this method also appends a cause to
331 * the error of the current thread using the same message.
333 template <Level LevelV, bool AppendCauseV, typename... ArgTs>
334 void logErrno(const char * const fileName, const char * const funcName,
335 const unsigned int lineNo, const char * const initMsg,
336 fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
338 this->_log<_InitMsgLogWriter, LevelV, AppendCauseV>(
339 fileName, funcName, lineNo, {}, this->_errnoIntroStr(initMsg).c_str(), std::move(fmt),
340 std::forward<ArgTs>(args)...);
344 * Like logErrno() with the `Level::Error` level, but also throws a
345 * default-constructed instance of `ExcT`.
347 template <bool AppendCauseV, typename ExcT, typename... ArgTs>
348 [[noreturn]] void logErrorErrnoAndThrow(const char * const fileName,
349 const char * const funcName, const unsigned int lineNo,
350 const char * const initMsg,
351 fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
353 this->logErrno<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg,
354 std::move(fmt), std::forward<ArgTs>(args)...);
359 * Like logErrno() with the `Level::Error` level, but also rethrows.
361 template <bool AppendCauseV, typename... ArgTs>
363 logErrorErrnoAndRethrow(const char * const fileName, const char * const funcName,
364 const unsigned int lineNo, const char * const initMsg,
365 fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
367 this->logErrno<Level::Error, AppendCauseV>(fileName, funcName, lineNo, initMsg,
368 std::move(fmt), std::forward<ArgTs>(args)...);
373 struct _MemLogWriter final
375 static void write(const char * const fileName, const char * const funcName,
376 const unsigned lineNo, const Level level, const char * const tag,
377 const MemData memData, const char *, const char * const msg) noexcept
379 bt_log_write_mem(funcName, fileName, lineNo, static_cast<bt_log_level>(level), tag,
380 memData.data(), memData.size(), msg);
386 * Logs memory data using the level `LevelV`.
388 * This method forwards `fmt` and `args` to fmt::format() to create
391 template <Level LevelV, typename... ArgTs>
392 void logMem(const char * const fileName, const char * const funcName, const unsigned int lineNo,
393 const MemData memData, fmt::format_string<ArgTs...> fmt, ArgTs&&...args) const
395 this->_log<_MemLogWriter, LevelV, false>(fileName, funcName, lineNo, memData, "",
396 std::move(fmt), std::forward<ArgTs>(args)...);
401 * Formats a log message with fmt::format() given `fmt` and `args`,
404 * 1. Calls LogWriterT::write() with its arguments to log using the
407 * 2. If `AppendCauseV` is true, this method also appends a cause to
408 * the error of the current thread using the concatenation of
409 * `initMsg` and `msg` as the message.
411 template <typename LogWriterT, Level LevelV, bool AppendCauseV, typename... ArgTs>
412 void _log(const char * const fileName, const char * const funcName, const unsigned int lineNo,
413 const MemData memData, const char * const initMsg, fmt::format_string<ArgTs...> fmt,
414 ArgTs&&...args) const
416 const auto wouldLog = this->wouldLog(LevelV);
418 /* Only format arguments if logging or appending an error cause */
419 if (G_UNLIKELY(wouldLog || AppendCauseV)) {
421 * Format arguments to our buffer (fmt::format_to() doesn't
422 * append a null character).
425 fmt::format_to(std::back_inserter(_mBuf), std::move(fmt), std::forward<ArgTs>(args)...);
426 _mBuf.push_back('\0');
429 /* Initial message is required */
434 LogWriterT::write(fileName, funcName, lineNo, LevelV, _mTag.data(), memData, initMsg,
438 /* Append an error cause if needed */
441 bt_current_thread_error_append_cause_from_message_iterator(
442 _mSelfMsgIter->libObjPtr(), fileName, lineNo, "%s%s", initMsg, _mBuf.data());
443 } else if (_mSelfComp) {
444 bt_current_thread_error_append_cause_from_component(
445 _mSelfComp->libObjPtr(), fileName, lineNo, "%s%s", initMsg, _mBuf.data());
446 } else if (_mSelfCompCls) {
447 bt_current_thread_error_append_cause_from_component_class(
448 _mSelfCompCls->libObjPtr(), fileName, lineNo, "%s%s", initMsg, _mBuf.data());
450 BT_ASSERT(_mModuleName);
451 bt_current_thread_error_append_cause_from_unknown(
452 _mModuleName->data(), fileName, lineNo, "%s%s", initMsg, _mBuf.data());
457 static std::string _errnoIntroStr(const char * const initMsg)
459 BT_ASSERT(errno != 0);
460 return fmt::format("{}: {}", initMsg, g_strerror(errno));
463 /* Exactly one of the following four members has a value */
464 bt2s::optional<bt2::SelfComponentClass> _mSelfCompCls;
465 bt2s::optional<bt2::SelfComponent> _mSelfComp;
466 bt2s::optional<bt2::SelfMessageIterator> _mSelfMsgIter;
467 bt2s::optional<std::string> _mModuleName;
469 /* Current logging level */
475 /* Formatting buffer */
476 mutable std::vector<char> _mBuf;
480 * Returns `s` if it's not `nullptr`, or the `(null)` string otherwise.
482 inline const char *maybeNull(const char * const s) noexcept
484 return s ? s : "(null)";
487 } /* namespace bt2c */
489 /* Internal: default logger name */
490 #define _BT_CPPLOG_DEF_LOGGER _mLogger
493 * Calls log() on `_logger` to log using the level `_lvl`.
495 #define BT_CPPLOG_EX(_lvl, _logger, _fmt, ...) \
497 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
498 (_logger).template log<(_lvl), false>(__FILE__, __func__, __LINE__, (_fmt), \
504 * BT_CPPLOG_EX() with specific logging levels.
506 #define BT_CPPLOGT_SPEC(_logger, _fmt, ...) \
507 BT_CPPLOG_EX(bt2c::Logger::Level::Trace, (_logger), (_fmt), ##__VA_ARGS__)
508 #define BT_CPPLOGD_SPEC(_logger, _fmt, ...) \
509 BT_CPPLOG_EX(bt2c::Logger::Level::Debug, (_logger), (_fmt), ##__VA_ARGS__)
510 #define BT_CPPLOGI_SPEC(_logger, _fmt, ...) \
511 BT_CPPLOG_EX(bt2c::Logger::Level::Info, (_logger), (_fmt), ##__VA_ARGS__)
512 #define BT_CPPLOGW_SPEC(_logger, _fmt, ...) \
513 BT_CPPLOG_EX(bt2c::Logger::Level::Warning, (_logger), (_fmt), ##__VA_ARGS__)
514 #define BT_CPPLOGE_SPEC(_logger, _fmt, ...) \
515 BT_CPPLOG_EX(bt2c::Logger::Level::Error, (_logger), (_fmt), ##__VA_ARGS__)
516 #define BT_CPPLOGF_SPEC(_logger, _fmt, ...) \
517 BT_CPPLOG_EX(bt2c::Logger::Level::Fatal, (_logger), (_fmt), ##__VA_ARGS__)
520 * BT_CPPLOG_EX() with specific logging levels and using the default
523 #define BT_CPPLOGT(_fmt, ...) BT_CPPLOGT_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
524 #define BT_CPPLOGD(_fmt, ...) BT_CPPLOGD_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
525 #define BT_CPPLOGI(_fmt, ...) BT_CPPLOGI_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
526 #define BT_CPPLOGW(_fmt, ...) BT_CPPLOGW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
527 #define BT_CPPLOGE(_fmt, ...) BT_CPPLOGE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
528 #define BT_CPPLOGF(_fmt, ...) BT_CPPLOGF_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
531 * Calls logMem() on `_logger` to log using the level `_lvl`.
533 #define BT_CPPLOG_MEM_EX(_lvl, _logger, _memData, _fmt, ...) \
535 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
536 (_logger).template logMem<(_lvl)>(__FILE__, __func__, __LINE__, (_memData), (_fmt), \
542 * BT_CPPLOG_MEM_EX() with specific logging levels.
544 #define BT_CPPLOGT_MEM_SPEC(_logger, _memData, _fmt, ...) \
545 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Trace, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
546 #define BT_CPPLOGD_MEM_SPEC(_logger, _memData, _fmt, ...) \
547 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Debug, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
548 #define BT_CPPLOGI_MEM_SPEC(_logger, _memData, _fmt, ...) \
549 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Info, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
550 #define BT_CPPLOGW_MEM_SPEC(_logger, _memData, _fmt, ...) \
551 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Warning, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
552 #define BT_CPPLOGE_MEM_SPEC(_logger, _memData, _fmt, ...) \
553 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Error, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
554 #define BT_CPPLOGF_MEM_SPEC(_logger, _memData, _fmt, ...) \
555 BT_CPPLOG_MEM_EX(bt2c::Logger::Level::Fatal, (_logger), (_memData), (_fmt), ##__VA_ARGS__)
558 * BT_CPPLOG_MEM_EX() with specific logging levels and using the default
561 #define BT_CPPLOGT_MEM(_memData, _fmt, ...) \
562 BT_CPPLOGT_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
563 #define BT_CPPLOGD_MEM(_memData, _fmt, ...) \
564 BT_CPPLOGD_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
565 #define BT_CPPLOGI_MEM(_memData, _fmt, ...) \
566 BT_CPPLOGI_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
567 #define BT_CPPLOGW_MEM(_memData, _fmt, ...) \
568 BT_CPPLOGW_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
569 #define BT_CPPLOGE_MEM(_memData, _fmt, ...) \
570 BT_CPPLOGE_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
571 #define BT_CPPLOGF_MEM(_memData, _fmt, ...) \
572 BT_CPPLOGF_MEM_SPEC(_BT_CPPLOG_DEF_LOGGER, (_memData), (_fmt), ##__VA_ARGS__)
575 * Calls logErrno() on `_logger` to log using the level `_lvl` and
576 * initial message `_initMsg`.
578 #define BT_CPPLOG_ERRNO_EX(_lvl, _logger, _initMsg, _fmt, ...) \
580 if (G_UNLIKELY((_logger).wouldLog(_lvl))) { \
581 (_logger).template logErrno<(_lvl), false>(__FILE__, __func__, __LINE__, (_initMsg), \
582 (_fmt), ##__VA_ARGS__); \
587 * BT_CPPLOG_ERRNO_EX() with specific logging levels.
589 #define BT_CPPLOGT_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
590 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Trace, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
591 #define BT_CPPLOGD_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
592 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Debug, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
593 #define BT_CPPLOGI_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
594 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Info, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
595 #define BT_CPPLOGW_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
596 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Warning, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
597 #define BT_CPPLOGE_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
598 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Error, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
599 #define BT_CPPLOGF_ERRNO_SPEC(_logger, _initMsg, _fmt, ...) \
600 BT_CPPLOG_ERRNO_EX(bt2c::Logger::Level::Fatal, (_logger), (_initMsg), (_fmt), ##__VA_ARGS__)
603 * BT_CPPLOG_ERRNO_EX() with specific logging levels and using the
606 #define BT_CPPLOGT_ERRNO(_initMsg, _fmt, ...) \
607 BT_CPPLOGT_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
608 #define BT_CPPLOGD_ERRNO(_initMsg, _fmt, ...) \
609 BT_CPPLOGD_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
610 #define BT_CPPLOGI_ERRNO(_initMsg, _fmt, ...) \
611 BT_CPPLOGI_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
612 #define BT_CPPLOGW_ERRNO(_initMsg, _fmt, ...) \
613 BT_CPPLOGW_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
614 #define BT_CPPLOGE_ERRNO(_initMsg, _fmt, ...) \
615 BT_CPPLOGE_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
616 #define BT_CPPLOGF_ERRNO(_initMsg, _fmt, ...) \
617 BT_CPPLOGF_ERRNO_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
620 * Calls log() on `_logger` with the `Error` level to log an error and
621 * append a cause to the error of the current thread.
623 #define BT_CPPLOGE_APPEND_CAUSE_SPEC(_logger, _fmt, ...) \
624 (_logger).template log<bt2c::Logger::Level::Error, true>(__FILE__, __func__, __LINE__, (_fmt), \
628 * BT_CPPLOGE_APPEND_CAUSE_SPEC() using the default logger.
630 #define BT_CPPLOGE_APPEND_CAUSE(_fmt, ...) \
631 BT_CPPLOGE_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
634 * Calls logErrorAndThrow() on `_logger` to log an error, append a cause
635 * to the error of the current thread, and throw an instance of
638 #define BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _fmt, ...) \
639 (_logger).template logErrorAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, (_fmt), \
643 * BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC() using the default logger.
645 #define BT_CPPLOGE_APPEND_CAUSE_AND_THROW(_excCls, _fmt, ...) \
646 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_fmt), ##__VA_ARGS__)
649 * Calls logErrorAndRethrow() on `_logger` to log an error, append a
650 * cause to the error of the current thread, and throw an instance of
653 #define BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _fmt, ...) \
654 (_logger).template logErrorAndRethrow<true>(__FILE__, __func__, __LINE__, (_fmt), ##__VA_ARGS__)
657 * BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC() using the default logger.
659 #define BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW(_fmt, ...) \
660 BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_fmt), ##__VA_ARGS__)
663 * Calls logErrno() on `_logger` with the `Level::Error` level to log an
664 * error and append a cause to the error of the current thread.
666 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(_logger, _initMsg, _fmt, ...) \
667 (_logger).template logErrno<bt2c::Logger::Level::Error, true>( \
668 __FILE__, __func__, __LINE__, (_initMsg), (_fmt), ##__VA_ARGS__)
671 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC() using the default logger.
673 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE(_initMsg, _fmt, ...) \
674 BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), ##__VA_ARGS__)
677 * Calls logErrorErrnoAndThrow() on `_logger` to log an error, append a
678 * cause to the error of the current thread, and throw an instance of
681 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC(_logger, _excCls, _initMsg, _fmt, ...) \
682 (_logger).template logErrorErrnoAndThrow<true, _excCls>(__FILE__, __func__, __LINE__, \
683 (_initMsg), (_fmt), ##__VA_ARGS__)
686 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC() using the default
689 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW(_excCls, _initMsg, _fmt, ...) \
690 BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC(_BT_CPPLOG_DEF_LOGGER, _excCls, (_initMsg), \
691 (_fmt), ##__VA_ARGS__)
694 * Calls logErrorErrnoAndRethrow() on `_logger` to log an error, append
695 * a cause to the error of the current thread, and throw an instance of
698 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC(_logger, _initMsg, _fmt, ...) \
699 (_logger).template logErrorErrnoAndRethrow<true>(__FILE__, __func__, __LINE__, (_initMsg), \
700 (_fmt), ##__VA_ARGS__)
703 * BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC() using the default
706 #define BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW(_initMsg, _fmt, ...) \
707 BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_RETHROW_SPEC(_BT_CPPLOG_DEF_LOGGER, (_initMsg), (_fmt), \
710 #endif /* BABELTRACE_CPP_COMMON_BT2C_LOGGING_HPP */