include/babeltrace/lib-logging-internal.h

   1 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
   2 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017 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 <babeltrace/babeltrace-internal.h>
  27 #include <stdarg.h>
  28
  29 #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
  30
  31 #include <babeltrace/logging-internal.h>
  32
  33 extern
  34 int bt_lib_log_level;
  35
  36 #define BT_LIB_LOG(_lvl, _fmt, ...)                                     \
  37         do {                                                            \
  38                 if (BT_LOG_ON(_lvl)) {                                  \
  39                         bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,   \
  40                                 __LINE__, _lvl, _BT_LOG_TAG,            \
  41                                 (_fmt), ##__VA_ARGS__);                 \
  42                 }                                                       \
  43         } while (0)
  44
  45 /*
  46  * The six macros below are logging statements which are specialized
  47  * for the Babeltrace library.
  48  *
  49  * `_fmt` is a typical printf()-style format string, with the following
  50  * limitations:
  51  *
  52  * * The `*` width specifier is not accepted.
  53  * * The `*` precision specifier is not accepted.
  54  * * The `j` and `t` length modifiers are not accepted.
  55  * * The `n` format specifier is not accepted.
  56  * * The format specifiers defined in <inttypes.h> are not accepted
  57  *   except for `PRId64`, `PRIu64`, `PRIx64`, `PRIX64`, `PRIo64`, and
  58  *   `PRIi64`.
  59  *
  60  * The Babeltrace extension conversion specifier is accepted. Its syntax
  61  * is:
  62  *
  63  * 1. Introductory `%!` sequence.
  64  *
  65  * 2. Optional: `[` followed by a custom prefix for the printed fields
  66  *    of this specifier, followed by `]`. The standard form is to end
  67  *    this prefix with `-` so that, for example, with the prefix
  68  *    `prefix-`, the complete field name is `prefix-addr`.
  69  *
  70  * 3. Optional: `+` to print extended fields. This depends on the
  71  *    provided format specifier.
  72  *
  73  * 4. Format specifier (see below).
  74  *
  75  * The available format specifiers are:
  76  *
  77  *   `r`:
  78  *       Reference count information. The parameter is any Babeltrace
  79  *       object.
  80  *
  81  *   `F`:
  82  *       CTF IR field type. The parameter type is `struct bt_field_type *`.
  83  *
  84  *   `f`:
  85  *       CTF IR field. The parameter type is `struct bt_field *`.
  86  *
  87  *   `P`:
  88  *       Field path. The parameter type is `struct bt_field_path *`.
  89  *
  90  *   `E`:
  91  *       CTF IR event class. The parameter type is `struct bt_event_class *`.
  92  *
  93  *   `e`:
  94  *       CTF IR event. The parameter type is `struct bt_event *`.
  95  *
  96  *   `S`:
  97  *       CTF IR stream class. The parameter type is `struct bt_stream_class *`.
  98  *
  99  *   `s`:
 100  *       CTF IR stream. The parameter type is `struct bt_stream *`.
 101  *
 102  *   `a`:
 103  *       Packet. The parameter type is `struct bt_packet *`.
 104  *
 105  *   `t`:
 106  *       CTF IR trace. The parameter type is `struct bt_trace *`.
 107  *
 108  *   `K`:
 109  *       Clock class. The parameter type is `struct bt_clock_class *`.
 110  *
 111  *   `k`:
 112  *       Clock value. The parameter type is `struct bt_clock_value *`.
 113  *
 114  *   `v`:
 115  *       Value. The parameter type is `struct bt_value *`.
 116  *
 117  *   `n`:
 118  *       Notification. The parameter type is `struct bt_notification *`.
 119  *
 120  *   `i`:
 121  *       Notification iterator. The parameter type is
 122  *       `struct bt_notification_iterator *`.
 123  *
 124  *   `C`:
 125  *       Component class. The parameter type is `struct bt_component_class *`.
 126  *
 127  *   `c`:
 128  *       Component. The parameter type is `struct bt_component *`.
 129  *
 130  *   `p`:
 131  *       Port. The parameter type is `struct bt_port *`.
 132  *
 133  *   `x`:
 134  *       Connection. The parameter type is `struct bt_connection *`.
 135  *
 136  *   `g`:
 137  *       Graph. The parameter type is `struct bt_graph *`.
 138  *
 139  *   `u`:
 140  *       Plugin. The parameter type is `struct bt_plugin *`.
 141  *
 142  *   `o`:
 143  *       Object pool. The parameter type is `struct bt_object_pool *`.
 144  *
 145  * Conversion specifier examples:
 146  *
 147  *     %!f
 148  *     %![my-event-]+e
 149  *     %!t
 150  *     %!+F
 151  *
 152  * The string `, ` is printed between individual fields, but not after
 153  * the last one. Therefore you must put this separator in the format
 154  * string between two Babeltrace objects, e.g.:
 155  *
 156  *     BT_LIB_LOGW("Message: count=%u, %!E, %!+C", count, event_class,
 157  *                 clock_class);
 158  *
 159  * Example with a custom prefix:
 160  *
 161  *     BT_LIB_LOGI("Some message: %![ec-a-]e, %![ec-b-]+e", ec_a, ec_b);
 162  *
 163  * It is safe to pass NULL as any Babeltrace object parameter: the
 164  * macros only print its null address.
 165  */
 166 #define BT_LIB_LOGF(_fmt, ...)  BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
 167 #define BT_LIB_LOGE(_fmt, ...)  BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
 168 #define BT_LIB_LOGW(_fmt, ...)  BT_LIB_LOG(BT_LOG_WARN, _fmt, ##__VA_ARGS__)
 169 #define BT_LIB_LOGI(_fmt, ...)  BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
 170 #define BT_LIB_LOGD(_fmt, ...)  BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
 171 #define BT_LIB_LOGV(_fmt, ...)  BT_LIB_LOG(BT_LOG_VERBOSE, _fmt, ##__VA_ARGS__)
 172
 173 /*
 174  * Log statement, specialized for the Babeltrace library.
 175  *
 176  * Use one of the BT_LIB_LOGF*() macros above instead of calling this
 177  * function directly.
 178  */
 179 BT_HIDDEN
 180 void bt_lib_log(const char *func, const char *file, unsigned line,
 181                 int lvl, const char *tag, const char *fmt, ...);
 182
 183 #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */