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. Objet category: `w` for CTF writer objects, `_` for common
  74  *    objects, or nothing for default objects (includes CTF IR).
  75  *
  76  * 5. Format specifier (see below).
  77  *
  78  * The available format specifiers are:
  79  *
  80  * Default category:
  81  *   `r`:
  82  *       Reference count information. The parameter is any Babeltrace
  83  *       object.
  84  *
  85  *   `F`:
  86  *       CTF IR field type. The parameter type is `struct bt_field_type *`.
  87  *
  88  *   `f`:
  89  *       CTF IR field. The parameter type is `struct bt_field *`.
  90  *
  91  *   `P`:
  92  *       Field path. The parameter type is `struct bt_field_path *`.
  93  *
  94  *   `E`:
  95  *       CTF IR event class. The parameter type is `struct bt_event_class *`.
  96  *
  97  *   `e`:
  98  *       CTF IR event. The parameter type is `struct bt_event *`.
  99  *
 100  *   `S`:
 101  *       CTF IR stream class. The parameter type is `struct bt_stream_class *`.
 102  *
 103  *   `s`:
 104  *       CTF IR stream. The parameter type is `struct bt_stream *`.
 105  *
 106  *   `a`:
 107  *       Packet. The parameter type is `struct bt_packet *`.
 108  *
 109  *   `t`:
 110  *       CTF IR trace. The parameter type is `struct bt_trace *`.
 111  *
 112  *   `K`:
 113  *       Clock class. The parameter type is `struct bt_clock_class *`.
 114  *
 115  *   `k`:
 116  *       Clock value. The parameter type is `struct bt_clock_value *`.
 117  *
 118  *   `v`:
 119  *       Value. The parameter type is `struct bt_value *`.
 120  *
 121  *   `n`:
 122  *       Notification. The parameter type is `struct bt_notification *`.
 123  *
 124  *   `i`:
 125  *       Notification iterator. The parameter type is
 126  *       `struct bt_notification_iterator *`.
 127  *
 128  *   `C`:
 129  *       Component class. The parameter type is `struct bt_component_class *`.
 130  *
 131  *   `c`:
 132  *       Component. The parameter type is `struct bt_component *`.
 133  *
 134  *   `p`:
 135  *       Port. The parameter type is `struct bt_port *`.
 136  *
 137  *   `x`:
 138  *       Connection. The parameter type is `struct bt_connection *`.
 139  *
 140  *   `g`:
 141  *       Graph. The parameter type is `struct bt_graph *`.
 142  *
 143  *   `u`:
 144  *       Plugin. The parameter type is `struct bt_plugin *`.
 145  *
 146  *   `o`:
 147  *       Object pool. The parameter type is `struct bt_object_pool *`.
 148  *
 149  * CTF writer category:
 150  *   `F`:
 151  *       CTF writer field type. The parameter type is `struct bt_field_type *`.
 152  *
 153  *   `f`:
 154  *       CTF writer field. The parameter type is `struct bt_field *`.
 155  *
 156  *   `E`:
 157  *       CTF writer event class. The parameter type is
 158  *       `struct bt_event_class *`.
 159  *
 160  *   `e`:
 161  *       CTF writer event. The parameter type is `struct bt_event *`.
 162  *
 163  *   `S`:
 164  *       CTF writer stream class. The parameter type is
 165  *       `struct bt_stream_class *`.
 166  *
 167  *   `s`:
 168  *       CTF writer stream. The parameter type is `struct bt_stream *`.
 169  *
 170  *   `t`:
 171  *       CTF writer trace. The parameter type is `struct bt_trace *`.
 172  *
 173  *   `w`:
 174  *       CTF writer. The parameter type is `struct bt_ctf_writer *`.
 175  *
 176  * Common category:
 177  *   `F`:
 178  *       Common field type. The parameter type is `struct bt_field_type *`.
 179  *
 180  *   `f`:
 181  *       Common field. The parameter type is `struct bt_field *`.
 182  *
 183  *   `E`:
 184  *       Common event class. The parameter type is
 185  *       `struct bt_event_class *`.
 186  *
 187  *   `e`:
 188  *       Common event. The parameter type is `struct bt_event *`.
 189  *
 190  *   `S`:
 191  *       Common stream class. The parameter type is
 192  *       `struct bt_stream_class *`.
 193  *
 194  *   `s`:
 195  *       Common stream. The parameter type is `struct bt_stream *`.
 196  *
 197  *   `t`:
 198  *       Common trace. The parameter type is `struct bt_trace *`.
 199  *
 200  * Conversion specifier examples:
 201  *
 202  *     %!f
 203  *     %![my-event-]+e
 204  *     %!_t
 205  *     %![ctf-writer-ec-]wE
 206  *     %!+_F
 207  *
 208  * The string `, ` is printed between individual fields, but not after
 209  * the last one. Therefore you must put this separator in the format
 210  * string between two Babeltrace objects, e.g.:
 211  *
 212  *     BT_LIB_LOGW("Message: count=%u, %!E, %!+C", count, event_class,
 213  *                 clock_class);
 214  *
 215  * Example with a custom prefix:
 216  *
 217  *     BT_LIB_LOGI("Some message: %![ec-a-]e, %![ec-b-]+e", ec_a, ec_b);
 218  *
 219  * It is safe to pass NULL as any Babeltrace object parameter: the
 220  * macros only print its null address.
 221  */
 222 #define BT_LIB_LOGF(_fmt, ...)  BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
 223 #define BT_LIB_LOGE(_fmt, ...)  BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
 224 #define BT_LIB_LOGW(_fmt, ...)  BT_LIB_LOG(BT_LOG_WARN, _fmt, ##__VA_ARGS__)
 225 #define BT_LIB_LOGI(_fmt, ...)  BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
 226 #define BT_LIB_LOGD(_fmt, ...)  BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
 227 #define BT_LIB_LOGV(_fmt, ...)  BT_LIB_LOG(BT_LOG_VERBOSE, _fmt, ##__VA_ARGS__)
 228
 229 /*
 230  * Log statement, specialized for the Babeltrace library.
 231  *
 232  * Use one of the BT_LIB_LOGF*() macros above instead of calling this
 233  * function directly.
 234  */
 235 BT_HIDDEN
 236 void bt_lib_log(const char *func, const char *file, unsigned line,
 237                 int lvl, const char *tag, const char *fmt, ...);
 238
 239 #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */