sink.text.pretty: add optional `print-enum-flags` parameter

[babeltrace.git] / src / plugins / text / pretty / pretty.c

diff --git a/src/plugins/text/pretty/pretty.c b/src/plugins/text/pretty/pretty.c
index a114818fa844020f2658cb370f8e5b030fb5ddae..cad275145392b9391d74667d3abc1f6907e72ce0 100644 (file)
--- a/src/plugins/text/pretty/pretty.c
+++ b/src/plugins/text/pretty/pretty.c
@@ -28,6 +28,7 @@ const char * const in_port_name = "in";
 static
 void destroy_pretty_data(struct pretty_component *pretty)
 {
+       uint64_t i;
        if (!pretty) {
                goto end;
        }
@@ -50,6 +51,13 @@ void destroy_pretty_data(struct pretty_component *pretty)
                        perror("close output file");
                }
        }
+
+       for (i = 0; i < ENUMERATION_MAX_BITFLAGS_COUNT; i++) {
+               if (pretty->enum_bit_labels[i]) {
+                       g_ptr_array_free(pretty->enum_bit_labels[i], true);
+               }
+       }
+
        g_free(pretty->options.output_path);
        g_free(pretty);
 
@@ -103,12 +111,16 @@ bt_message_iterator_class_next_method_status handle_message(
        switch (bt_message_get_type(message)) {
        case BT_MESSAGE_TYPE_EVENT:
                if (pretty_print_event(pretty, message)) {
+                       BT_COMP_LOGE_APPEND_CAUSE(pretty->self_comp,
+                               "Failed to print one event.");
                        ret = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
                }
                break;
        case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
        case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
                if (pretty_print_discarded_items(pretty, message)) {
+                       BT_COMP_LOGE_APPEND_CAUSE(pretty->self_comp,
+                               "Failed to print discarded items.");
                        ret = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
                }
                break;
@@ -188,6 +200,8 @@ bt_component_class_sink_consume_method_status pretty_consume(
                bt_message_put_ref(msgs[i]);
        }
 
+       status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
+
 end:
        for (; i < count; i++) {
                bt_message_put_ref(msgs[i]);
@@ -306,6 +320,7 @@ struct bt_param_validation_map_value_entry_descr pretty_params[] = {
        { "field-loglevel", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
        { "field-emf", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
        { "field-callsite", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
+       { "print-enum-flags", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
        BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
 };
 
@@ -349,6 +364,8 @@ bt_component_class_initialize_method_status apply_params(
        apply_one_string("path", params, &pretty->options.output_path);
        ret = open_output_file(pretty);
        if (ret) {
+               BT_COMP_LOGE_APPEND_CAUSE(pretty->self_comp,
+                       "Failed to open output file: %s", validate_error);
                status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
                goto end;
        }
@@ -373,6 +390,9 @@ bt_component_class_initialize_method_status apply_params(
        apply_one_bool_with_default("verbose", params,
                &pretty->options.verbose, false);
 
+       apply_one_bool_with_default("print-enum-flags", params,
+               &pretty->options.print_enum_flags, false);
+
        /* Names. */
        value = bt_value_map_borrow_entry_value_const(params, "name-default");
        if (value) {
@@ -539,6 +559,14 @@ bt_component_class_initialize_method_status pretty_init(
        bt_logging_level log_level = bt_component_get_logging_level(comp);
 
        if (!pretty) {
+               /*
+                * Don't use BT_COMP_LOGE_APPEND_CAUSE, as `pretty` is not
+                * initialized yet.
+                */
+               BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
+                       "Failed to allocate component.");
+               BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
+                       self_comp, "Failed to allocate component.");
                status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
@@ -568,6 +596,18 @@ bt_component_class_initialize_method_status pretty_init(
        }
 
        set_use_colors(pretty);
+
+       if (pretty->options.print_enum_flags) {
+               uint64_t i;
+               /*
+                * Allocate all label arrays during the initialization of the
+                * component and reuse the same set of arrays for all
+                * enumerations.
+                */
+               for (i = 0; i < ENUMERATION_MAX_BITFLAGS_COUNT; i++) {
+                       pretty->enum_bit_labels[i] = g_ptr_array_new();
+               }
+       }
        bt_self_component_set_data(self_comp, pretty);
 
        status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;