1 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
2 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #include <babeltrace/babeltrace-internal.h>
30 # error Please define a tag with BT_LOG_TAG before including this file.
33 #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
35 #include <babeltrace/logging-internal.h>
40 #define BT_LIB_LOG(_lvl, _fmt, ...) \
42 if (BT_LOG_ON(_lvl)) { \
43 bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
44 __LINE__, _lvl, _BT_LOG_TAG, \
45 (_fmt), ##__VA_ARGS__); \
50 * The six macros below are logging statements which are specialized
51 * for the Babeltrace library.
53 * `_fmt` is a typical printf()-style format string, with the following
56 * * The `*` width specifier is not accepted.
57 * * The `*` precision specifier is not accepted.
58 * * The `j` and `t` length modifiers are not accepted.
59 * * The `n` format specifier is not accepted.
60 * * The format specifiers defined in <inttypes.h> are not accepted
61 * except for `PRId64`, `PRIu64`, `PRIx64`, `PRIX64`, `PRIo64`, and
64 * The Babeltrace extension conversion specifier is accepted. Its syntax
65 * is either `%!u` to format a UUID (`bt_uuid` type) or:
67 * 1. Introductory `%!` sequence.
69 * 2. Optional: `[` followed by a custom prefix for the printed fields
70 * of this specifier, followed by `]`. The standard form is to end
71 * this prefix with `-` so that, for example, with the prefix
72 * `prefix-`, the complete field name is `prefix-addr`.
74 * 3. Optional: `+` to print extended fields. This depends on the
75 * provided format specifier.
77 * 4. Format specifier (see below).
79 * The available format specifiers are:
82 * Trace IR field class. The parameter type is
83 * `struct bt_field_class *`.
86 * Trace IR field. The parameter type is `struct bt_field *`.
89 * Field path. The parameter type is `struct bt_field_path *`.
92 * Trace IR event class. The parameter type is
93 * `struct bt_event_class *`.
96 * Trace IR event. The parameter type is `struct bt_event *`.
99 * Trace IR stream class. The parameter type is
100 * `struct bt_stream_class *`.
103 * Trace IR stream. The parameter type is `struct bt_stream *`.
106 * Packet. The parameter type is `struct bt_packet *`.
109 * Trace IR trace class. The parameter type is `struct bt_trace_class *`.
112 * Trace IR trace. The parameter type is `struct bt_trace *`.
115 * Clock class. The parameter type is `struct bt_clock_class *`.
118 * Clock snapshot. The parameter type is `struct bt_clock_snapshot *`.
121 * Value. The parameter type is `struct bt_value *`.
124 * Message. The parameter type is `struct bt_message *`.
127 * Message iterator. The parameter type is
128 * `struct bt_message_iterator *`.
131 * Component class. The parameter type is
132 * `struct bt_component_class *`.
135 * Component. The parameter type is `struct bt_component *`.
138 * Port. The parameter type is `struct bt_port *`.
141 * Connection. The parameter type is `struct bt_connection *`.
144 * Graph. The parameter type is `struct bt_graph *`.
147 * Plugin. The parameter type is `const struct bt_plugin *`.
150 * Object pool. The parameter type is `struct bt_object_pool *`.
153 * Object. The parameter type is `struct bt_object *`.
155 * Conversion specifier examples:
162 * The string `, ` is printed between individual fields, but not after
163 * the last one. Therefore you must put this separator in the format
164 * string between two conversion specifiers, e.g.:
166 * BT_LIB_LOGW("Message: count=%u, %!E, %!+K", count, event_class,
169 * Example with a custom prefix:
171 * BT_LIB_LOGI("Some message: %![ec-a-]e, %![ec-b-]+e", ec_a, ec_b);
173 * It is safe to pass NULL as any Babeltrace object parameter: the
174 * macros only print its null address.
176 #define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
177 #define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
178 #define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARN, _fmt, ##__VA_ARGS__)
179 #define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
180 #define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
181 #define BT_LIB_LOGV(_fmt, ...) BT_LIB_LOG(BT_LOG_VERBOSE, _fmt, ##__VA_ARGS__)
184 * Log statement, specialized for the Babeltrace library.
186 * Use one of the BT_LIB_LOGF*() macros above instead of calling this
190 void bt_lib_log(const char *func
, const char *file
, unsigned line
,
191 int lvl
, const char *tag
, const char *fmt
, ...);
193 #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */
This page took 0.033711 seconds and 4 git commands to generate.