Move to kernel style SPDX license identifiers
[babeltrace.git] / src / lib / lib-logging.c
index b48c5db7b4274de39f04905cbad53bf2e9452aa1..88be5c769e6ac2b59fb953aa262bc2c5b508adfe 100644 (file)
@@ -1,23 +1,7 @@
 /*
- * Copyright 2018 Philippe Proulx <pproulx@efficios.com>
- *
- * 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 <pproulx@efficios.com>
  */
 
 #define BT_LOG_TAG "LIB/LIB-LOGGING"
 #include <stdlib.h>
 #include <string.h>
 #include <inttypes.h>
+#include <stdbool.h>
 #include <stdint.h>
 #include <wchar.h>
 #include <glib.h>
 #include "common/common.h"
 #include "common/uuid.h"
-#include <babeltrace2/trace-ir/event-const.h>
-#include <babeltrace2/trace-ir/packet-const.h>
-#include <babeltrace2/trace-ir/stream-const.h>
-#include <babeltrace2/current-thread.h>
+#include <babeltrace2/babeltrace.h>
 
 #include "logging.h"
 #include "assert-pre.h"
 #include "assert-post.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-class-sink-colander.h"
 #include "graph/component-filter.h"
 #include "graph/component.h"
 #include "graph/component-sink.h"
@@ -104,11 +87,17 @@ static __thread char lib_logging_buf[LIB_LOGGING_BUF_SIZE];
 
 #define PRFIELD_GSTRING(_expr) PRFIELD((_expr) ? (_expr)->str : NULL)
 
-#define TMP_PREFIX_LEN 64
+#define TMP_PREFIX_LEN 128
 #define SET_TMP_PREFIX(_prefix2)                                       \
        do {                                                            \
-               snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s",        \
-                       prefix, (_prefix2));                            \
+               int snprintf_ret =                                      \
+                       snprintf(tmp_prefix, TMP_PREFIX_LEN - 1, "%s%s", \
+                               prefix, (_prefix2));                    \
+                                                                       \
+               if (snprintf_ret < 0 || snprintf_ret >= TMP_PREFIX_LEN - 1) { \
+                       bt_common_abort();                                      \
+               }                                                       \
+                                                                       \
                tmp_prefix[TMP_PREFIX_LEN - 1] = '\0';                  \
        } while (0)
 
@@ -189,18 +178,18 @@ static inline void format_field_class(char **buf_ch, bool extended,
        }
 
        switch (field_class->type) {
-       case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
-       case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
+       case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
        {
-               format_integer_field_class(buf_ch, extended, prefix, field_class);
+               const struct bt_field_class_bit_array *ba_fc =
+                       (const void *) field_class;
+
+               BUF_APPEND(", %slength=%" PRIu64, PRFIELD(ba_fc->length));
                break;
        }
-       case BT_FIELD_CLASS_TYPE_REAL:
+       case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
+       case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
        {
-               const struct bt_field_class_real *real_fc = (void *) field_class;
-
-               BUF_APPEND(", %sis-single-precision=%d",
-                       PRFIELD(real_fc->is_single_precision));
+               format_integer_field_class(buf_ch, extended, prefix, field_class);
                break;
        }
        case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
@@ -228,16 +217,17 @@ static inline void format_field_class(char **buf_ch, bool extended,
        }
        case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
        {
-               const struct bt_field_class_static_array *array_fc =
+               const struct bt_field_class_array_static *array_fc =
                        (const void *) field_class;
 
                format_array_field_class(buf_ch, extended, prefix, field_class);
                BUF_APPEND(", %slength=%" PRIu64, PRFIELD(array_fc->length));
                break;
        }
-       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
        {
-               const struct bt_field_class_dynamic_array *array_fc =
+               const struct bt_field_class_array_dynamic *array_fc =
                        (const void *) field_class;
 
                format_array_field_class(buf_ch, extended, prefix, field_class);
@@ -256,7 +246,41 @@ static inline void format_field_class(char **buf_ch, bool extended,
 
                break;
        }
-       case BT_FIELD_CLASS_TYPE_VARIANT:
+       case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
+       {
+               const struct bt_field_class_option *opt_fc =
+                       (const void *) field_class;
+
+               BUF_APPEND(", %scontent-fc-addr=%p, %scontent-fc-type=%s",
+                       PRFIELD(opt_fc->content_fc),
+                       PRFIELD(bt_common_field_class_type_string(opt_fc->content_fc->type)));
+
+               if (field_class->type !=
+                               BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD) {
+                       const struct bt_field_class_option_with_selector_field *opt_with_sel_fc =
+                               (const void *) field_class;
+
+                       if (opt_with_sel_fc->selector_fc) {
+                               SET_TMP_PREFIX("selector-fc-");
+                               format_field_class(buf_ch, extended, tmp_prefix,
+                                       opt_with_sel_fc->selector_fc);
+                       }
+
+                       if (opt_with_sel_fc->selector_field_path) {
+                               SET_TMP_PREFIX("selector-field-path-");
+                               format_field_path(buf_ch, extended, tmp_prefix,
+                                       opt_with_sel_fc->selector_field_path);
+                       }
+               }
+
+               break;
+       }
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
        {
                const struct bt_field_class_variant *var_fc =
                        (const void *) field_class;
@@ -266,16 +290,22 @@ static inline void format_field_class(char **buf_ch, bool extended,
                                PRFIELD(var_fc->common.named_fcs->len));
                }
 
-               if (var_fc->selector_fc) {
-                       SET_TMP_PREFIX("selector-fc-");
-                       format_field_class(buf_ch, extended, tmp_prefix,
-                               var_fc->selector_fc);
-               }
+               if (field_class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD ||
+                               field_class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD) {
+                       const struct bt_field_class_variant_with_selector_field *var_with_sel_fc =
+                               (const void *) var_fc;
 
-               if (var_fc->selector_field_path) {
-                       SET_TMP_PREFIX("selector-field-path-");
-                       format_field_path(buf_ch, extended, tmp_prefix,
-                               var_fc->selector_field_path);
+                       if (var_with_sel_fc->selector_fc) {
+                               SET_TMP_PREFIX("selector-fc-");
+                               format_field_class(buf_ch, extended, tmp_prefix,
+                                       var_with_sel_fc->selector_fc);
+                       }
+
+                       if (var_with_sel_fc->selector_field_path) {
+                               SET_TMP_PREFIX("selector-field-path-");
+                               format_field_path(buf_ch, extended, tmp_prefix,
+                                       var_with_sel_fc->selector_field_path);
+                       }
                }
 
                break;
@@ -340,6 +370,21 @@ static inline void format_field(char **buf_ch, bool extended,
        }
 
        switch (field->class->type) {
+       case BT_FIELD_CLASS_TYPE_BOOL:
+       {
+               const struct bt_field_bool *bool_field = (const void *) field;
+
+               BUF_APPEND(", %svalue=%d", PRFIELD(bool_field->value));
+               break;
+       }
+       case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
+       {
+               const struct bt_field_bit_array *ba_field = (const void *) field;
+
+               BUF_APPEND(", %svalue-as-int=%" PRIx64,
+                       PRFIELD(ba_field->value_as_int));
+               break;
+       }
        case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
        case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
        case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
@@ -348,7 +393,8 @@ static inline void format_field(char **buf_ch, bool extended,
                format_field_integer_extended(buf_ch, prefix, field);
                break;
        }
-       case BT_FIELD_CLASS_TYPE_REAL:
+       case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
+       case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
        {
                const struct bt_field_real *real_field = (const void *) field;
 
@@ -368,7 +414,8 @@ static inline void format_field(char **buf_ch, bool extended,
                break;
        }
        case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
-       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
        {
                const struct bt_field_array *array_field = (const void *) field;
 
@@ -381,7 +428,9 @@ static inline void format_field(char **buf_ch, bool extended,
 
                break;
        }
-       case BT_FIELD_CLASS_TYPE_VARIANT:
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
        {
                const struct bt_field_variant *var_field = (const void *) field;
 
@@ -425,7 +474,7 @@ static inline void format_field_path(char **buf_ch, bool extended,
                        BUF_APPEND("%s", ", <CUR>");
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
        }
 
@@ -518,14 +567,16 @@ static inline void format_stream_class(char **buf_ch, bool extended,
        }
 
        BUF_APPEND(", %sassigns-auto-ec-id=%d, %sassigns-auto-stream-id=%d, "
-               "%spackets-have-default-beginning-cs=%d, "
-               "%spackets-have-default-end-cs=%d, "
+               "%ssupports-packets=%d, "
+               "%spackets-have-begin-default-cs=%d, "
+               "%spackets-have-end-default-cs=%d, "
                "%ssupports-discarded-events=%d, "
                "%sdiscarded-events-have-default-cs=%d, "
                "%ssupports-discarded-packets=%d, "
                "%sdiscarded-packets-have-default-cs=%d",
                PRFIELD(stream_class->assigns_automatic_event_class_id),
                PRFIELD(stream_class->assigns_automatic_stream_id),
+               PRFIELD(stream_class->supports_packets),
                PRFIELD(stream_class->packets_have_beginning_default_clock_snapshot),
                PRFIELD(stream_class->packets_have_end_default_clock_snapshot),
                PRFIELD(stream_class->supports_discarded_events),
@@ -674,8 +725,6 @@ static inline void format_packet(char **buf_ch, bool extended,
 static inline void format_event(char **buf_ch, bool extended,
                const char *prefix, const struct bt_event *event)
 {
-       const struct bt_packet *packet;
-       const struct bt_stream *stream;
        const struct bt_trace_class *trace_class;
        const struct bt_stream_class *stream_class;
        char tmp_prefix[TMP_PREFIX_LEN];
@@ -718,22 +767,17 @@ static inline void format_event(char **buf_ch, bool extended,
                }
        }
 
-       packet = bt_event_borrow_packet_const(event);
-       if (!packet) {
-               return;
+       if (event->stream) {
+               BUF_APPEND(", %sstream-addr=%p", PRFIELD(event->stream));
+               SET_TMP_PREFIX("stream-");
+               format_stream(buf_ch, false, tmp_prefix, event->stream);
        }
 
-       BUF_APPEND(", %spacket-addr=%p", PRFIELD(packet));
-       SET_TMP_PREFIX("packet-");
-       format_packet(buf_ch, false, tmp_prefix, packet);
-       stream = bt_packet_borrow_stream_const(packet);
-       if (!stream) {
-               return;
+       if (event->packet) {
+               BUF_APPEND(", %spacket-addr=%p", PRFIELD(event->packet));
+               SET_TMP_PREFIX("packet-");
+               format_packet(buf_ch, false, tmp_prefix, event->packet);
        }
-
-       BUF_APPEND(", %sstream-addr=%p", PRFIELD(stream));
-       SET_TMP_PREFIX("stream-");
-       format_stream(buf_ch, false, tmp_prefix, stream);
 }
 
 static inline void format_clock_class(char **buf_ch, bool extended,
@@ -798,6 +842,12 @@ 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)
+{
+       BUF_APPEND(", %sis-set=%d", PRFIELD(intr->is_set));
+}
+
 static inline void format_value(char **buf_ch, bool extended,
                const char *prefix, const struct bt_value *value)
 {
@@ -819,13 +869,13 @@ static inline void format_value(char **buf_ch, bool extended,
        case BT_VALUE_TYPE_UNSIGNED_INTEGER:
        {
                BUF_APPEND(", %svalue=%" PRIu64,
-                       PRFIELD(bt_value_unsigned_integer_get(value)));
+                       PRFIELD(bt_value_integer_unsigned_get(value)));
                break;
        }
        case BT_VALUE_TYPE_SIGNED_INTEGER:
        {
                BUF_APPEND(", %svalue=%" PRId64,
-                       PRFIELD(bt_value_signed_integer_get(value)));
+                       PRFIELD(bt_value_integer_signed_get(value)));
                break;
        }
        case BT_VALUE_TYPE_REAL:
@@ -844,9 +894,8 @@ static inline void format_value(char **buf_ch, bool extended,
        }
        case BT_VALUE_TYPE_ARRAY:
        {
-               int64_t count = bt_value_array_get_size(value);
+               uint64_t count = bt_value_array_get_length(value);
 
-               BT_ASSERT(count >= 0);
                BUF_APPEND(", %selement-count=%" PRId64, PRFIELD(count));
                break;
        }
@@ -863,6 +912,19 @@ static inline void format_value(char **buf_ch, bool extended,
        }
 }
 
+static inline void format_integer_range_set(char **buf_ch, bool extended,
+               const char *prefix,
+               const struct bt_integer_range_set *range_set)
+{
+       BUF_APPEND(", %srange-count=%u", PRFIELD(range_set->ranges->len));
+
+       if (!extended) {
+               return;
+       }
+
+       BUF_APPEND(", %sis-frozen=%d", PRFIELD(range_set->frozen));
+}
+
 static inline void format_message(char **buf_ch, bool extended,
                const char *prefix, const struct bt_message *msg)
 {
@@ -953,13 +1015,13 @@ static inline void format_message(char **buf_ch, bool extended,
                }
 
                if (msg_disc_items->default_begin_cs) {
-                       SET_TMP_PREFIX("default-begin-cs-");
+                       SET_TMP_PREFIX("begin-default-cs-");
                        format_clock_snapshot(buf_ch, true, tmp_prefix,
                                msg_disc_items->default_begin_cs);
                }
 
                if (msg_disc_items->default_end_cs) {
-                       SET_TMP_PREFIX("default-end-cs-");
+                       SET_TMP_PREFIX("end-default-cs-");
                        format_clock_snapshot(buf_ch, true, tmp_prefix,
                                msg_disc_items->default_end_cs);
                }
@@ -1091,9 +1153,7 @@ static inline void format_graph(char **buf_ch, bool extended,
 {
        char tmp_prefix[TMP_PREFIX_LEN];
 
-       BUF_APPEND(", %sis-canceled=%d, %scan-consume=%d, "
-               "%sconfig-state=%s",
-               PRFIELD(graph->canceled),
+       BUF_APPEND(", %scan-consume=%d, %sconfig-state=%s",
                PRFIELD(graph->can_consume),
                PRFIELD(bt_graph_configuration_state_string(graph->config_state)));
 
@@ -1122,70 +1182,45 @@ static inline void format_graph(char **buf_ch, bool extended,
                &graph->packet_end_msg_pool);
 }
 
+static inline void format_message_iterator_class(char **buf_ch,
+               bool extended, const char *prefix,
+               const struct bt_message_iterator_class *iterator_class)
+{
+       /* Empty, the address is automatically printed. */
+}
+
 static inline void format_message_iterator(char **buf_ch,
                bool extended, const char *prefix,
                const struct bt_message_iterator *iterator)
 {
-       const char *type;
        char tmp_prefix[TMP_PREFIX_LEN];
+       const struct bt_message_iterator *
+               port_in_iter = (const void *) iterator;
 
-       if (iterator->type == BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT) {
-               type = "BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT";
-       } else if (iterator->type == BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT) {
-               type = "BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT";
-       } else {
-               type = "(unknown)";
+       if (port_in_iter->upstream_component) {
+               SET_TMP_PREFIX("upstream-comp-");
+               format_component(buf_ch, false, tmp_prefix,
+                       port_in_iter->upstream_component);
        }
 
-       BUF_APPEND(", %stype=%s", PRFIELD(type));
-
-       switch (iterator->type) {
-       case BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT:
-       {
-               const struct bt_self_component_port_input_message_iterator *
-                       port_in_iter = (const void *) iterator;
-
-               if (port_in_iter->upstream_component) {
-                       SET_TMP_PREFIX("upstream-comp-");
-                       format_component(buf_ch, false, tmp_prefix,
-                               port_in_iter->upstream_component);
-               }
-
-               if (port_in_iter->upstream_port) {
-                       SET_TMP_PREFIX("upstream-port-");
-                       format_port(buf_ch, false, tmp_prefix,
-                               port_in_iter->upstream_port);
-               }
-
-               if (port_in_iter->connection) {
-                       SET_TMP_PREFIX("upstream-conn-");
-                       format_connection(buf_ch, false, tmp_prefix,
-                               port_in_iter->connection);
-               }
-               break;
+       if (!extended) {
+               goto end;
        }
-       case BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT:
-       {
-               const struct bt_port_output_message_iterator *port_out_iter =
-                       (const void *) iterator;
 
-               if (port_out_iter->graph) {
-                       SET_TMP_PREFIX("graph-");
-                       format_graph(buf_ch, false, tmp_prefix,
-                               port_out_iter->graph);
-               }
-
-               if (port_out_iter->colander) {
-                       SET_TMP_PREFIX("colander-comp-");
-                       format_component(buf_ch, false, tmp_prefix,
-                               (void *) port_out_iter->colander);
-               }
-
-               break;
+       if (port_in_iter->upstream_port) {
+               SET_TMP_PREFIX("upstream-port-");
+               format_port(buf_ch, false, tmp_prefix,
+                       port_in_iter->upstream_port);
        }
-       default:
-               break;
+
+       if (port_in_iter->connection) {
+               SET_TMP_PREFIX("upstream-conn-");
+               format_connection(buf_ch, false, tmp_prefix,
+                       port_in_iter->connection);
        }
+
+end:
+       return;
 }
 
 static inline void format_plugin(char **buf_ch, bool extended,
@@ -1397,9 +1432,15 @@ static inline void handle_conversion_specifier_bt(void *priv_data,
        case 'v':
                format_value(buf_ch, extended, prefix, obj);
                break;
+       case 'R':
+               format_integer_range_set(buf_ch, extended, prefix, obj);
+               break;
        case 'n':
                format_message(buf_ch, extended, prefix, obj);
                break;
+       case 'I':
+               format_message_iterator_class(buf_ch, extended, prefix, obj);
+               break;
        case 'i':
                format_message_iterator(buf_ch, extended, prefix, obj);
                break;
@@ -1421,6 +1462,9 @@ static inline void handle_conversion_specifier_bt(void *priv_data,
        case 'g':
                format_graph(buf_ch, extended, prefix, obj);
                break;
+       case 'z':
+               format_interrupter(buf_ch, extended, prefix, obj);
+               break;
        case 'o':
                format_object_pool(buf_ch, extended, prefix, obj);
                break;
@@ -1431,7 +1475,7 @@ static inline void handle_conversion_specifier_bt(void *priv_data,
                format_error_cause(buf_ch, extended, prefix, obj);
                break;
        default:
-               abort();
+               bt_common_abort();
        }
 
 update_fmt:
@@ -1472,7 +1516,8 @@ void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
        }
 
        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
This page took 0.029241 seconds and 4 git commands to generate.