src/lib/logging.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
   8 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
   9
  10 #include "common/macros.h"
  11 #include <stdarg.h>
  12
  13 #ifndef BT_LOG_TAG
  14 # error Please define a tag with BT_LOG_TAG before including this file.
  15 #endif
  16
  17 #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
  18
  19 #include "logging/log.h"
  20
  21 #define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2"
  22
  23 extern
  24 int bt_lib_log_level;
  25
  26 #define BT_LIB_LOG(_lvl, _fmt, ...)                                     \
  27         do {                                                            \
  28                 if (BT_LOG_ON(_lvl)) {                                  \
  29                         bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,   \
  30                                 __LINE__, _lvl, _BT_LOG_TAG,            \
  31                                 (_fmt), ##__VA_ARGS__);                 \
  32                 }                                                       \
  33         } while (0)
  34
  35 /* See `CONTRIBUTING.adoc` for usage */
  36 #define BT_LIB_LOGF(_fmt, ...)  BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
  37 #define BT_LIB_LOGE(_fmt, ...)  BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
  38 #define BT_LIB_LOGW(_fmt, ...)  BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
  39 #define BT_LIB_LOGI(_fmt, ...)  BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
  40 #define BT_LIB_LOGD(_fmt, ...)  BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
  41 #define BT_LIB_LOGT(_fmt, ...)  BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)
  42
  43 /*
  44  * Log statement, specialized for the Babeltrace library.
  45  *
  46  * This function does NOT check that logging is enabled for level `lvl`:
  47  * you must check it manually with BT_LOG_ON().
  48  *
  49  * Use one of the BT_LIB_LOG*() macros above instead of calling this
  50  * function directly.
  51  */
  52 void bt_lib_log(const char *func, const char *file, unsigned line,
  53                 int lvl, const char *tag, const char *fmt, ...);
  54
  55 void bt_lib_log_v(const char *func, const char *file, unsigned line,
  56                 int lvl, const char *tag, const char *fmt, va_list *args);
  57
  58 #define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...)                          \
  59         do {                                                            \
  60                 bt_lib_maybe_log_and_append_cause(                      \
  61                         _BT_LOG_SRCLOC_FUNCTION, __FILE__,              \
  62                         __LINE__, _lvl, _BT_LOG_TAG,                    \
  63                         (_fmt), ##__VA_ARGS__);                         \
  64         } while (0)
  65
  66 /* See `CONTRIBUTING.adoc` for usage */
  67 #define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...)                             \
  68         BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
  69 #define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...)                             \
  70         BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
  71
  72 /*
  73  * Like bt_lib_log(), but also appends a cause to the current thread's
  74  * error object.
  75  *
  76  * Note that, unlike bt_lib_log(), this function does check that logging
  77  * is enabled for level `lvl` before logging. This is to ensure that,
  78  * even though logging is disabled, the function still appends an error
  79  * cause, as the error reporting system does not rely on logging.
  80  *
  81  * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
  82  * calling this function directly.
  83  */
  84 void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
  85                 unsigned line, int lvl, const char *tag,
  86                 const char *fmt, ...);
  87
  88 #define BT_LIB_LOG_SUPPORTED
  89
  90 #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */