src/lib/logging.h

   1 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
   2 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include "common/macros.h"
  27 #include <stdarg.h>
  28
  29 #ifndef BT_LOG_TAG
  30 # error Please define a tag with BT_LOG_TAG before including this file.
  31 #endif
  32
  33 #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
  34
  35 #include "logging/log.h"
  36
  37 #define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2"
  38
  39 extern
  40 int bt_lib_log_level;
  41
  42 #define BT_LIB_LOG(_lvl, _fmt, ...)                                     \
  43         do {                                                            \
  44                 if (BT_LOG_ON(_lvl)) {                                  \
  45                         bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,   \
  46                                 __LINE__, _lvl, _BT_LOG_TAG,            \
  47                                 (_fmt), ##__VA_ARGS__);                 \
  48                 }                                                       \
  49         } while (0)
  50
  51 /* See `CONTRIBUTING.adoc` for usage */
  52 #define BT_LIB_LOGF(_fmt, ...)  BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
  53 #define BT_LIB_LOGE(_fmt, ...)  BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
  54 #define BT_LIB_LOGW(_fmt, ...)  BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
  55 #define BT_LIB_LOGI(_fmt, ...)  BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
  56 #define BT_LIB_LOGD(_fmt, ...)  BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
  57 #define BT_LIB_LOGT(_fmt, ...)  BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)
  58
  59 /*
  60  * Log statement, specialized for the Babeltrace library.
  61  *
  62  * This function does NOT check that logging is enabled for level `lvl`:
  63  * you must check it manually with BT_LOG_ON().
  64  *
  65  * Use one of the BT_LIB_LOG*() macros above instead of calling this
  66  * function directly.
  67  *
  68  * This function would normally be BT_HIDDEN, but it is used by the Python
  69  * plugin provider, which is conceptually part of libbabeltrace2, but
  70  * implemented as a separate shared object, for modularity.  It is therefore
  71  * exposed, but not part of the public ABI.
  72  */
  73 void bt_lib_log(const char *func, const char *file, unsigned line,
  74                 int lvl, const char *tag, const char *fmt, ...);
  75
  76 #define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...)                          \
  77         do {                                                            \
  78                 bt_lib_maybe_log_and_append_cause(                      \
  79                         _BT_LOG_SRCLOC_FUNCTION, __FILE__,              \
  80                         __LINE__, _lvl, _BT_LOG_TAG,                    \
  81                         (_fmt), ##__VA_ARGS__);                         \
  82         } while (0)
  83
  84 /* See `CONTRIBUTING.adoc` for usage */
  85 #define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...)                             \
  86         BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
  87 #define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...)                             \
  88         BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
  89
  90 /*
  91  * Like bt_lib_log(), but also appends a cause to the current thread's
  92  * error object.
  93  *
  94  * Note that, unlike bt_lib_log(), this function does check that logging
  95  * is enabled for level `lvl` before logging. This is to ensure that,
  96  * even though logging is disabled, the function still appends an error
  97  * cause, as the error reporting system does not rely on logging.
  98  *
  99  * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
 100  * calling this function directly.
 101  *
 102  * This function would normally be BT_HIDDEN, but it is used by the Python
 103  * plugin provider, which is conceptually part of libbabeltrace2, but
 104  * implemented as a separate shared object, for modularity.  It is therefore
 105  * exposed, but not part of the ABI.
 106  */
 107 void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
 108                 unsigned line, int lvl, const char *tag,
 109                 const char *fmt, ...);
 110
 111 #define BT_LIB_LOG_SUPPORTED
 112
 113 #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */