src/plugins/ctf/common/metadata/logging.hpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (c) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  */
   6
   7 #ifndef CTF_METADATA_LOGGING_H
   8 #define CTF_METADATA_LOGGING_H
   9
  10 #include <babeltrace2/babeltrace.h>
  11 #include "logging/log.h"
  12
  13 /*
  14  * This global log level is for the generated lexer and parser: we can't
  15  * use a contextual log level for their "tracing", so they rely on this.
  16  */
  17 BT_LOG_LEVEL_EXTERN_SYMBOL(ctf_plugin_metadata_log_level);
  18
  19 /*
  20  * To be used by functions without a context structure to pass all the
  21  * logging configuration at once.
  22  */
  23 struct meta_log_config
  24 {
  25     bt_logging_level log_level;
  26
  27     /* Weak, exactly one of these must be set */
  28     bt_self_component *self_comp;
  29     bt_self_component_class *self_comp_class;
  30 };
  31
  32 #define _BT_LOGT_LINENO(_lineno, _msg, args...)                                                    \
  33     BT_LOGT("At line %u in metadata stream: " _msg, _lineno, ##args)
  34
  35 #define _BT_LOGW_LINENO(_lineno, _msg, args...)                                                    \
  36     BT_LOGW("At line %u in metadata stream: " _msg, _lineno, ##args)
  37
  38 #define _BT_LOGE_APPEND_CAUSE_LINENO(_lineno, _msg, args...)                                       \
  39     do {                                                                                           \
  40         BT_LOGE("At line %u in metadata stream: " _msg, _lineno, ##args);                          \
  41         (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(                                  \
  42             "CTF metadata parser", "At line %u in metadata stream: " _msg, _lineno, ##args);       \
  43     } while (0)
  44
  45 #define _BT_COMP_LOGT_LINENO(_lineno, _msg, args...)                                               \
  46     BT_COMP_LOGT("At line %u in metadata stream: " _msg, _lineno, ##args)
  47
  48 #define _BT_COMP_LOGW_LINENO(_lineno, _msg, args...)                                               \
  49     BT_COMP_LOGW("At line %u in metadata stream: " _msg, _lineno, ##args)
  50
  51 #define _BT_COMP_LOGE_LINENO(_lineno, _msg, args...)                                               \
  52     BT_COMP_LOGE("At line %u in metadata stream: " _msg, _lineno, ##args)
  53
  54 #define _BT_COMP_LOGE_APPEND_CAUSE_LINENO(_lineno, _msg, args...)                                  \
  55     BT_COMP_LOGE_APPEND_CAUSE(BT_COMP_LOG_SELF_COMP, "At line %u in metadata stream: " _msg,       \
  56                               _lineno, ##args)
  57
  58 #define _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(_msg, args...)                                    \
  59     BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(BT_COMP_LOG_SELF_COMP, BT_COMP_LOG_SELF_COMP_CLASS,    \
  60                                             _msg, ##args)
  61
  62 #endif /* CTF_METADATA_LOGGING_H */