X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Flib-logging.c;h=82558067bfb2e5b78b9ed9272a6506edcd76b434;hb=5155b005cfadade509649b8f9a3bf2c055c6edfd;hp=ee11fad0ce5b0b682a0837f2acaf8dadf3b0c306;hpb=f80e9ec14e8608e514891297246112606975b5f8;p=babeltrace.git diff --git a/src/lib/lib-logging.c b/src/lib/lib-logging.c index ee11fad0..82558067 100644 --- a/src/lib/lib-logging.c +++ b/src/lib/lib-logging.c @@ -1,23 +1,7 @@ /* - * Copyright 2018 Philippe Proulx - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * SPDX-License-Identifier: MIT * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Copyright 2018 Philippe Proulx */ #define BT_LOG_TAG "LIB/LIB-LOGGING" @@ -28,6 +12,7 @@ #include #include #include +#include #include #include #include @@ -36,24 +21,19 @@ #include #include "logging.h" -#include "assert-pre.h" -#include "assert-post.h" +#include "assert-cond.h" #include "value.h" #include "integer-range-set.h" #include "object-pool.h" #include "graph/interrupter.h" #include "graph/component-class.h" -#include "graph/component-filter.h" #include "graph/component.h" -#include "graph/component-sink.h" -#include "graph/component-source.h" #include "graph/connection.h" #include "graph/graph.h" +#include "graph/iterator.h" #include "graph/message/discarded-items.h" #include "graph/message/event.h" -#include "graph/message/iterator.h" #include "graph/message/message.h" -#include "graph/message/message-iterator-inactivity.h" #include "graph/message/packet.h" #include "graph/message/stream.h" #include "graph/port.h" @@ -71,9 +51,7 @@ #include "trace-ir/stream.h" #include "trace-ir/trace-class.h" #include "trace-ir/trace.h" -#include "trace-ir/utils.h" #include "error.h" -#include "assert-pre.h" #define LIB_LOGGING_BUF_SIZE (4096 * 4) @@ -110,7 +88,7 @@ static __thread char lib_logging_buf[LIB_LOGGING_BUF_SIZE]; prefix, (_prefix2)); \ \ if (snprintf_ret < 0 || snprintf_ret >= TMP_PREFIX_LEN - 1) { \ - abort(); \ + bt_common_abort(); \ } \ \ tmp_prefix[TMP_PREFIX_LEN - 1] = '\0'; \ @@ -131,8 +109,8 @@ static inline void format_clock_snapshot(char **buf_ch, bool extended, static inline void format_field_path(char **buf_ch, bool extended, const char *prefix, const struct bt_field_path *field_path); -static inline void format_object(char **buf_ch, bool extended, - const char *prefix, const struct bt_object *obj) +static inline void format_object(char **buf_ch, const char *prefix, + const struct bt_object *obj) { BUF_APPEND(", %sref-count=%llu", prefix, obj->ref_count); } @@ -142,8 +120,8 @@ static inline void format_uuid(char **buf_ch, bt_uuid uuid) BUF_APPEND("\"" BT_UUID_FMT "\"", BT_UUID_FMT_VALUES(uuid)); } -static inline void format_object_pool(char **buf_ch, bool extended, - const char *prefix, const struct bt_object_pool *pool) +static inline void format_object_pool(char **buf_ch, const char *prefix, + const struct bt_object_pool *pool) { BUF_APPEND(", %ssize=%zu", PRFIELD(pool->size)); @@ -152,8 +130,7 @@ static inline void format_object_pool(char **buf_ch, bool extended, } } -static inline void format_integer_field_class(char **buf_ch, - bool extended, const char *prefix, +static inline void format_integer_field_class(char **buf_ch, const char *prefix, const struct bt_field_class *field_class) { const struct bt_field_class_integer *int_fc = @@ -164,8 +141,7 @@ static inline void format_integer_field_class(char **buf_ch, PRFIELD(bt_common_field_class_integer_preferred_display_base_string(int_fc->base))); } -static inline void format_array_field_class(char **buf_ch, - bool extended, const char *prefix, +static inline void format_array_field_class(char **buf_ch, const char *prefix, const struct bt_field_class *field_class) { const struct bt_field_class_array *array_fc = @@ -204,7 +180,7 @@ static inline void format_field_class(char **buf_ch, bool extended, case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER: case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER: { - format_integer_field_class(buf_ch, extended, prefix, field_class); + format_integer_field_class(buf_ch, prefix, field_class); break; } case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: @@ -213,7 +189,7 @@ static inline void format_field_class(char **buf_ch, bool extended, const struct bt_field_class_enumeration *enum_fc = (const void *) field_class; - format_integer_field_class(buf_ch, extended, prefix, field_class); + format_integer_field_class(buf_ch, prefix, field_class); BUF_APPEND(", %smapping-count=%u", PRFIELD(enum_fc->mappings->len)); break; @@ -235,7 +211,7 @@ static inline void format_field_class(char **buf_ch, bool extended, const struct bt_field_class_array_static *array_fc = (const void *) field_class; - format_array_field_class(buf_ch, extended, prefix, field_class); + format_array_field_class(buf_ch, prefix, field_class); BUF_APPEND(", %slength=%" PRIu64, PRFIELD(array_fc->length)); break; } @@ -245,7 +221,7 @@ static inline void format_field_class(char **buf_ch, bool extended, const struct bt_field_class_array_dynamic *array_fc = (const void *) field_class; - format_array_field_class(buf_ch, extended, prefix, field_class); + format_array_field_class(buf_ch, prefix, field_class); if (array_fc->length_fc) { SET_TMP_PREFIX("length-fc-"); @@ -346,6 +322,8 @@ static inline void format_field_integer_extended(char **buf_ch, fmt = ", %svalue=%" PRIx64; } +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wformat-nonliteral" if (field_class->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || field_class->common.type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION) { if (!fmt) { @@ -360,6 +338,7 @@ static inline void format_field_integer_extended(char **buf_ch, BUF_APPEND(fmt, PRFIELD(integer->value.u)); } +#pragma GCC diagnostic pop } static inline void format_field(char **buf_ch, bool extended, @@ -489,7 +468,7 @@ static inline void format_field_path(char **buf_ch, bool extended, BUF_APPEND("%s", ", "); break; default: - abort(); + bt_common_abort(); } } @@ -602,7 +581,7 @@ static inline void format_stream_class(char **buf_ch, bool extended, SET_TMP_PREFIX("trace-class-"); format_trace_class(buf_ch, false, tmp_prefix, trace_class); SET_TMP_PREFIX("pcf-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, + format_object_pool(buf_ch, tmp_prefix, &stream_class->packet_context_field_pool); } @@ -658,8 +637,7 @@ static inline void format_event_class(char **buf_ch, bool extended, SET_TMP_PREFIX("trace-class-"); format_trace_class(buf_ch, false, tmp_prefix, trace_class); SET_TMP_PREFIX("event-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, - &event_class->event_pool); + format_object_pool(buf_ch, tmp_prefix, &event_class->event_pool); } static inline void format_stream(char **buf_ch, bool extended, @@ -702,7 +680,7 @@ static inline void format_stream(char **buf_ch, bool extended, } SET_TMP_PREFIX("packet-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, &stream->packet_pool); + format_object_pool(buf_ch, tmp_prefix, &stream->packet_pool); } static inline void format_packet(char **buf_ch, bool extended, @@ -830,8 +808,7 @@ static inline void format_clock_class(char **buf_ch, bool extended, PRFIELD(clock_class->base_offset.value_ns)); SET_TMP_PREFIX("cs-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, - &clock_class->cs_pool); + format_object_pool(buf_ch, tmp_prefix, &clock_class->cs_pool); } static inline void format_clock_snapshot(char **buf_ch, bool extended, @@ -857,8 +834,8 @@ static inline void format_clock_snapshot(char **buf_ch, bool extended, } } -static inline void format_interrupter(char **buf_ch, bool extended, - const char *prefix, const struct bt_interrupter *intr) +static inline void format_interrupter(char **buf_ch, const char *prefix, + const struct bt_interrupter *intr) { BUF_APPEND(", %sis-set=%d", PRFIELD(intr->is_set)); } @@ -946,7 +923,7 @@ static inline void format_message(char **buf_ch, bool extended, char tmp_prefix[TMP_PREFIX_LEN]; BUF_APPEND(", %stype=%s", - PRFIELD(bt_message_type_string(msg->type))); + PRFIELD(bt_common_message_type_string(msg->type))); if (!extended) { return; @@ -1071,7 +1048,7 @@ static inline void format_component_class(char **buf_ch, bool extended, char tmp_prefix[TMP_PREFIX_LEN]; BUF_APPEND(", %stype=%s, %sname=\"%s\"", - PRFIELD(bt_component_class_type_string(comp_class->type)), + PRFIELD(bt_common_component_class_type_string(comp_class->type)), PRFIELD_GSTRING(comp_class->name)); if (comp_class->description) { @@ -1187,14 +1164,11 @@ static inline void format_graph(char **buf_ch, bool extended, } SET_TMP_PREFIX("en-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, - &graph->event_msg_pool); + format_object_pool(buf_ch, tmp_prefix, &graph->event_msg_pool); SET_TMP_PREFIX("pbn-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, - &graph->packet_begin_msg_pool); + format_object_pool(buf_ch, tmp_prefix, &graph->packet_begin_msg_pool); SET_TMP_PREFIX("pen-pool-"); - format_object_pool(buf_ch, extended, tmp_prefix, - &graph->packet_end_msg_pool); + format_object_pool(buf_ch, tmp_prefix, &graph->packet_end_msg_pool); } static inline void format_message_iterator(char **buf_ch, @@ -1202,7 +1176,7 @@ static inline void format_message_iterator(char **buf_ch, const struct bt_message_iterator *iterator) { char tmp_prefix[TMP_PREFIX_LEN]; - const struct bt_self_component_port_input_message_iterator * + const struct bt_message_iterator * port_in_iter = (const void *) iterator; if (port_in_iter->upstream_component) { @@ -1342,15 +1316,17 @@ static inline void format_error_cause(char **buf_ch, bool extended, if (comp_class_id) { BUF_APPEND(", %scomp-cls-type=%s, %scomp-cls-name=\"%s\", " "%splugin-name=\"%s\"", - PRFIELD(bt_component_class_type_string( + PRFIELD(bt_common_component_class_type_string( comp_class_id->type)), PRFIELD_GSTRING(comp_class_id->name), PRFIELD_GSTRING(comp_class_id->plugin_name)); } } -static inline void handle_conversion_specifier_bt(void *priv_data, - char **buf_ch, size_t avail_size, +static inline void handle_conversion_specifier_bt( + void *priv_data __attribute__((unused)), + char **buf_ch, + size_t avail_size __attribute__((unused)), const char **out_fmt_ch, va_list *args) { const char *fmt_ch = *out_fmt_ch; @@ -1446,6 +1422,9 @@ static inline void handle_conversion_specifier_bt(void *priv_data, case 'n': format_message(buf_ch, extended, prefix, obj); break; + case 'I': + /* Empty, the address is automatically printed. */ + break; case 'i': format_message_iterator(buf_ch, extended, prefix, obj); break; @@ -1468,19 +1447,19 @@ static inline void handle_conversion_specifier_bt(void *priv_data, format_graph(buf_ch, extended, prefix, obj); break; case 'z': - format_interrupter(buf_ch, extended, prefix, obj); + format_interrupter(buf_ch, prefix, obj); break; case 'o': - format_object_pool(buf_ch, extended, prefix, obj); + format_object_pool(buf_ch, prefix, obj); break; case 'O': - format_object(buf_ch, extended, prefix, obj); + format_object(buf_ch, prefix, obj); break; case 'r': format_error_cause(buf_ch, extended, prefix, obj); break; default: - abort(); + bt_common_abort(); } update_fmt: @@ -1488,19 +1467,47 @@ update_fmt: *out_fmt_ch = fmt_ch; } -void bt_lib_log(const char *func, const char *file, unsigned line, +/* + * This function would normally not be BT_EXPORTed, but it is used by the + * Python plugin provider, which is conceptually part of libbabeltrace2, but + * implemented as a separate shared object, for modularity. It is therefore + * exposed, but not part of the public ABI. + */ +BT_EXPORT +void bt_lib_log_v(const char *file, const char *func, unsigned line, + int lvl, const char *tag, const char *fmt, va_list *args) +{ + BT_ASSERT(fmt); + bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!', + handle_conversion_specifier_bt, NULL, fmt, args); + bt_log_write(file, func, line, lvl, tag, lib_logging_buf); +} + +/* + * This function would normally not be BT_EXPORTed, but it is used by the + * Python plugin provider, which is conceptually part of libbabeltrace2, but + * implemented as a separate shared object, for modularity. It is therefore + * exposed, but not part of the public ABI. + */ +BT_EXPORT +void bt_lib_log(const char *file, const char *func, unsigned line, int lvl, const char *tag, const char *fmt, ...) { va_list args; BT_ASSERT(fmt); va_start(args, fmt); - bt_common_custom_vsnprintf(lib_logging_buf, LIB_LOGGING_BUF_SIZE, '!', - handle_conversion_specifier_bt, NULL, fmt, &args); + bt_lib_log_v(file, func, line, lvl, tag, fmt, &args); va_end(args); - _bt_log_write_d(func, file, line, lvl, tag, "%s", lib_logging_buf); } +/* + * This function would normally not be BT_EXPORTed, but it is used by the + * Python plugin provider, which is conceptually part of libbabeltrace2, but + * implemented as a separate shared object, for modularity. It is therefore + * exposed, but not part of the ABI. + */ +BT_EXPORT void bt_lib_maybe_log_and_append_cause(const char *func, const char *file, unsigned line, int lvl, const char *tag, const char *fmt, ...) @@ -1516,12 +1523,12 @@ void bt_lib_maybe_log_and_append_cause(const char *func, const char *file, /* Log conditionally, but always append the error cause */ if (BT_LOG_ON(lvl)) { - _bt_log_write_d(func, file, line, lvl, tag, "%s", - lib_logging_buf); + bt_log_write(file, func, line, lvl, tag, lib_logging_buf); } status = bt_current_thread_error_append_cause_from_unknown( - "Babeltrace library", file, line, "%s", lib_logging_buf); + BT_LIB_LOG_LIBBABELTRACE2_NAME, file, line, "%s", + lib_logging_buf); if (status) { /* * Worst case: this error cause is not appended to the