sink.text.details: sprinkle BT_COMP_LOGE_APPEND_CAUSE liberally
[babeltrace.git] / src / plugins / text / details / details.c
index 4f304f7320f05554c83d7728dceb4613e2d19f36..f64a1e1ed782b886843231308cec94f08cb08931 100644 (file)
@@ -1,23 +1,7 @@
 /*
- * Copyright 2019 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 2019 Philippe Proulx <pproulx@efficios.com>
  */
 
 #define BT_COMP_LOG_SELF_COMP (details_comp->self_comp)
 #include "write.h"
 #include "plugins/common/param-validation/param-validation.h"
 
-#define LOG_WRONG_PARAM_TYPE(_name, _value, _exp_type)                 \
-       do {                                                            \
-               BT_COMP_LOGE("Wrong `%s` parameter type: type=%s, "     \
-                       "expected-type=%s",                             \
-                       (_name), bt_common_value_type_string(           \
-                               bt_value_get_type(_value)),             \
-                       bt_common_value_type_string(_exp_type));        \
-       } while (0)
-
 #define IN_PORT_NAME "in"
 #define COLOR_PARAM_NAME "color"
 #define WITH_METADATA_PARAM_NAME "with-metadata"
@@ -366,35 +341,40 @@ bt_component_class_initialize_method_status details_init(
                const bt_value *params,
                __attribute__((unused)) void *init_method_data)
 {
-       bt_component_class_initialize_method_status status =
-               BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
+       bt_component_class_initialize_method_status status;
        bt_self_component_add_port_status add_port_status;
-       struct details_comp *details_comp = NULL;
-
-       add_port_status = bt_self_component_sink_add_input_port(comp,
-               IN_PORT_NAME, NULL, NULL);
-       switch (add_port_status) {
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_OK:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
-               break;
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
-               break;
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
-               break;
-       default:
-               bt_common_abort();
-       }
+       struct details_comp *details_comp;
+       bt_self_component *self_comp =
+               bt_self_component_sink_as_self_component(comp);
+       bt_logging_level log_level =
+               bt_component_get_logging_level(
+                       bt_self_component_as_component(self_comp));
 
        details_comp = create_details_comp(comp);
        if (!details_comp) {
+               /*
+                * Don't use BT_COMP_LOGE_APPEND_CAUSE, as `details_comp` 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;
        }
 
-       if (configure_details_comp(details_comp, params)) {
-               BT_COMP_LOGE_STR("Failed to configure component.");
+       add_port_status = bt_self_component_sink_add_input_port(comp,
+               IN_PORT_NAME, NULL, NULL);
+       if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to add input port.");
+               status = (int) add_port_status;
+               goto error;
+       }
+
+       status = configure_details_comp(details_comp, params);
+       if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to configure component.");
                goto error;
        }
 
@@ -404,10 +384,6 @@ bt_component_class_initialize_method_status details_init(
        goto end;
 
 error:
-       if (status == BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
-       }
-
        destroy_details_comp(details_comp);
 
 end:
@@ -422,26 +398,28 @@ details_graph_is_configured(bt_self_component_sink *comp)
        bt_message_iterator_create_from_sink_component_status
                msg_iter_status;
        bt_message_iterator *iterator;
-       struct details_comp *details_comp;
        bt_self_component_port_input *in_port;
+       bt_self_component *self_comp =
+               bt_self_component_sink_as_self_component(comp);
+       struct details_comp *details_comp = bt_self_component_get_data(self_comp);
 
-       details_comp = bt_self_component_get_data(
-               bt_self_component_sink_as_self_component(comp));
        BT_ASSERT(details_comp);
+
        in_port = bt_self_component_sink_borrow_input_port_by_name(comp,
                IN_PORT_NAME);
        if (!bt_port_is_connected(bt_port_input_as_port_const(
                        bt_self_component_port_input_as_port_input(in_port)))) {
-               BT_COMP_LOGE("Single input port is not connected: "
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Single input port is not connected: "
                        "port-name=\"%s\"", IN_PORT_NAME);
                status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR;
                goto end;
        }
 
        msg_iter_status = bt_message_iterator_create_from_sink_component(
-               comp, bt_self_component_sink_borrow_input_port_by_name(comp,
-                       IN_PORT_NAME), &iterator);
+               comp, in_port, &iterator);
        if (msg_iter_status != BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) {
+               BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create message iterator: "
+                       "port-name=\"%s\"", IN_PORT_NAME);
                status = (int) msg_iter_status;
                goto end;
        }
@@ -459,68 +437,53 @@ BT_HIDDEN
 bt_component_class_sink_consume_method_status
 details_consume(bt_self_component_sink *comp)
 {
-       bt_component_class_sink_consume_method_status ret =
-               BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
+       bt_component_class_sink_consume_method_status status;
        bt_message_array_const msgs;
        uint64_t count;
-       struct details_comp *details_comp;
        bt_message_iterator_next_status next_status;
        uint64_t i;
+       bt_self_component *self_comp = bt_self_component_sink_as_self_component(comp);
+       struct details_comp *details_comp = bt_self_component_get_data(self_comp);
 
-       details_comp = bt_self_component_get_data(
-               bt_self_component_sink_as_self_component(comp));
        BT_ASSERT_DBG(details_comp);
        BT_ASSERT_DBG(details_comp->msg_iter);
 
        /* Consume messages */
        next_status = bt_message_iterator_next(
                details_comp->msg_iter, &msgs, &count);
-       switch (next_status) {
-       case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK:
-               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
-
-               for (i = 0; i < count; i++) {
-                       int print_ret = details_write_message(details_comp,
-                               msgs[i]);
-
-                       if (print_ret) {
-                               for (; i < count; i++) {
-                                       /* Put all remaining messages */
-                                       bt_message_put_ref(msgs[i]);
-                               }
+       if (next_status != BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) {
+               status = (int) next_status;
+               goto end;
+       }
 
-                               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
-                               goto end;
-                       }
+       for (i = 0; i < count; i++) {
+               int print_ret = details_write_message(details_comp,
+                       msgs[i]);
 
-                       /* Print output buffer to standard output and flush */
-                       if (details_comp->str->len > 0) {
-                               printf("%s", details_comp->str->str);
-                               fflush(stdout);
-                               details_comp->printed_something = true;
+               if (print_ret) {
+                       for (; i < count; i++) {
+                               /* Put all remaining messages */
+                               bt_message_put_ref(msgs[i]);
                        }
 
-                       /* Put this message */
-                       bt_message_put_ref(msgs[i]);
+                       BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to write message.");
+                       status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
+                       goto end;
                }
 
-               break;
-       case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN:
-               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN;
-               goto end;
-       case BT_MESSAGE_ITERATOR_NEXT_STATUS_END:
-               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
-               goto end;
-       case BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR:
-               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
-               goto end;
-       case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
-               ret = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR;
-               goto end;
-       default:
-               bt_common_abort();
+               /* Print output buffer to standard output and flush */
+               if (details_comp->str->len > 0) {
+                       printf("%s", details_comp->str->str);
+                       fflush(stdout);
+                       details_comp->printed_something = true;
+               }
+
+               /* Put this message */
+               bt_message_put_ref(msgs[i]);
        }
 
+       status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
+
 end:
-       return ret;
+       return status;
 }
This page took 0.026713 seconds and 4 git commands to generate.