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