Move to kernel style SPDX license identifiers
[babeltrace.git] / src / plugins / utils / counter / counter.c
index 200b9aa752866a68ba96443df5f78f787de902fb..be03014d69ecdef9f8be4ea615fabbc51e6d4d7b 100644 (file)
@@ -1,35 +1,22 @@
 /*
- * Copyright 2017 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 2017 Philippe Proulx <pproulx@efficios.com>
  */
 
-#define BT_LOG_TAG "PLUGIN-UTILS-COUNTER-FLT"
-#include "logging.h"
+#define BT_COMP_LOG_SELF_COMP (counter->self_comp)
+#define BT_LOG_OUTPUT_LEVEL (counter->log_level)
+#define BT_LOG_TAG "PLUGIN/FLT.UTILS.COUNTER"
+#include "logging/comp-logging.h"
 
 #include <babeltrace2/babeltrace.h>
 #include "common/macros.h"
 #include "common/common.h"
-#include "plugins/plugins-common.h"
 #include "common/assert.h"
 #include <inttypes.h>
+#include <stdbool.h>
 #include <stdint.h>
+#include "plugins/common/param-validation/param-validation.h"
 
 #include "counter.h"
 
@@ -52,8 +39,6 @@ uint64_t get_total_count(struct counter *counter)
        return counter->count.event +
                counter->count.stream_begin +
                counter->count.stream_end +
-               counter->count.stream_activity_begin +
-               counter->count.stream_activity_end +
                counter->count.packet_begin +
                counter->count.packet_end +
                counter->count.disc_events +
@@ -70,8 +55,6 @@ void print_count(struct counter *counter)
        PRINTF_COUNT("Event", event);
        PRINTF_COUNT("Stream beginning", stream_begin);
        PRINTF_COUNT("Stream end", stream_end);
-       PRINTF_COUNT("Stream activity beginning", stream_activity_begin);
-       PRINTF_COUNT("Stream activity end", stream_activity_end);
        PRINTF_COUNT("Packet beginning", packet_begin);
        PRINTF_COUNT("Packet end", packet_end);
        PRINTF_COUNT("Discarded event", disc_events);
@@ -115,10 +98,14 @@ void try_print_last(struct counter *counter)
        }
 }
 
+static
 void destroy_private_counter_data(struct counter *counter)
 {
-       bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
-       g_free(counter);
+       if (counter) {
+               bt_message_iterator_put_ref(
+                       counter->msg_iter);
+               g_free(counter);
+       }
 }
 
 BT_HIDDEN
@@ -131,29 +118,57 @@ void counter_finalize(bt_self_component_sink *comp)
                        bt_self_component_sink_as_self_component(comp));
        BT_ASSERT(counter);
        try_print_last(counter);
-       bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
+       bt_message_iterator_put_ref(counter->msg_iter);
        g_free(counter);
 }
 
+static
+struct bt_param_validation_map_value_entry_descr counter_params[] = {
+       { "step", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_UNSIGNED_INTEGER } },
+       { "hide-zero", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
+       BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
+};
+
 BT_HIDDEN
-bt_self_component_status counter_init(
+bt_component_class_initialize_method_status counter_init(
                bt_self_component_sink *component,
+               bt_self_component_sink_configuration *config,
                const bt_value *params,
-               UNUSED_VAR void *init_method_data)
+               __attribute__((unused)) void *init_method_data)
 {
-       bt_self_component_status ret;
+       bt_component_class_initialize_method_status status;
+       bt_self_component_add_port_status add_port_status;
        struct counter *counter = g_new0(struct counter, 1);
        const bt_value *step = NULL;
        const bt_value *hide_zero = NULL;
+       enum bt_param_validation_status validation_status;
+       gchar *validate_error = NULL;
 
        if (!counter) {
-               ret = BT_SELF_COMPONENT_STATUS_NOMEM;
+               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
-       ret = bt_self_component_sink_add_input_port(component,
+       counter->self_comp =
+               bt_self_component_sink_as_self_component(component);
+       counter->log_level = bt_component_get_logging_level(
+               bt_self_component_as_component(counter->self_comp));
+       add_port_status = bt_self_component_sink_add_input_port(component,
                "in", NULL, NULL);
-       if (ret != BT_SELF_COMPONENT_STATUS_OK) {
+       if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
+               status = (int) add_port_status;
+               goto error;
+       }
+
+       validation_status = bt_param_validation_validate(params,
+               counter_params, &validate_error);
+       if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
+               goto error;
+       } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
+               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
+               BT_COMP_LOGE_APPEND_CAUSE(counter->self_comp,
+                       "%s", validate_error);
                goto error;
        }
 
@@ -161,104 +176,98 @@ bt_self_component_status counter_init(
        counter->step = 10000;
        step = bt_value_map_borrow_entry_value_const(params, "step");
        if (step) {
-               if (!bt_value_is_unsigned_integer(step)) {
-                       BT_LOGE("`step` parameter: expecting an unsigned integer value: "
-                               "type=%s", bt_common_value_type_string(
-                                       bt_value_get_type(step)));
-                       goto error;
-               }
-
-               counter->step = bt_value_unsigned_integer_get(step);
+               counter->step = bt_value_integer_unsigned_get(step);
        }
 
        hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
        if (hide_zero) {
-               if (!bt_value_is_bool(hide_zero)) {
-                       BT_LOGE("`hide-zero` parameter: expecting a boolean value: "
-                               "type=%s", bt_common_value_type_string(
-                                       bt_value_get_type(hide_zero)));
-                       goto error;
-               }
-
                counter->hide_zero = (bool) bt_value_bool_get(hide_zero);
        }
 
        bt_self_component_set_data(
                bt_self_component_sink_as_self_component(component),
                counter);
+
+       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
        goto end;
 
 error:
        destroy_private_counter_data(counter);
-       ret = BT_SELF_COMPONENT_STATUS_ERROR;
 
 end:
-       return ret;
+       g_free(validate_error);
+       return status;
 }
 
 BT_HIDDEN
-bt_self_component_status counter_graph_is_configured(
+bt_component_class_sink_graph_is_configured_method_status
+counter_graph_is_configured(
                bt_self_component_sink *comp)
 {
-       bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
+       bt_component_class_sink_graph_is_configured_method_status status;
+       bt_message_iterator_create_from_sink_component_status
+               msg_iter_status;
        struct counter *counter;
-       bt_self_component_port_input_message_iterator *iterator;
+       bt_message_iterator *iterator;
 
        counter = bt_self_component_get_data(
                bt_self_component_sink_as_self_component(comp));
        BT_ASSERT(counter);
-       iterator = bt_self_component_port_input_message_iterator_create(
-               bt_self_component_sink_borrow_input_port_by_name(comp,
-                       in_port_name));
-       if (!iterator) {
-               status = BT_SELF_COMPONENT_STATUS_NOMEM;
+
+       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);
+       if (msg_iter_status != BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) {
+               status = (int) msg_iter_status;
                goto end;
        }
 
-       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
+       BT_MESSAGE_ITERATOR_MOVE_REF(
                counter->msg_iter, iterator);
 
+       status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;
 end:
        return status;
 }
 
 BT_HIDDEN
-bt_self_component_status counter_consume(
+bt_component_class_sink_consume_method_status counter_consume(
                bt_self_component_sink *comp)
 {
-       bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
+       bt_component_class_sink_consume_method_status status =
+               BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
        struct counter *counter;
-       bt_message_iterator_status it_ret;
+       bt_message_iterator_next_status next_status;
        uint64_t msg_count;
        bt_message_array_const msgs;
 
        counter = bt_self_component_get_data(
                        bt_self_component_sink_as_self_component(comp));
-       BT_ASSERT(counter);
+       BT_ASSERT_DBG(counter);
 
        if (G_UNLIKELY(!counter->msg_iter)) {
                try_print_last(counter);
-               ret = BT_SELF_COMPONENT_STATUS_END;
+               status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
                goto end;
        }
 
        /* Consume messages */
-       it_ret = bt_self_component_port_input_message_iterator_next(
+       next_status = bt_message_iterator_next(
                counter->msg_iter, &msgs, &msg_count);
-       if (it_ret < 0) {
-               ret = BT_SELF_COMPONENT_STATUS_ERROR;
+       if (next_status < 0) {
+               status = (int) next_status;
                goto end;
        }
 
-       switch (it_ret) {
-       case BT_MESSAGE_ITERATOR_STATUS_OK:
+       switch (next_status) {
+       case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK:
        {
                uint64_t i;
 
                for (i = 0; i < msg_count; i++) {
                        const bt_message *msg = msgs[i];
 
-                       BT_ASSERT(msg);
+                       BT_ASSERT_DBG(msg);
                        switch (bt_message_get_type(msg)) {
                        case BT_MESSAGE_TYPE_EVENT:
                                counter->count.event++;
@@ -278,12 +287,6 @@ bt_self_component_status counter_consume(
                        case BT_MESSAGE_TYPE_STREAM_END:
                                counter->count.stream_end++;
                                break;
-                       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
-                               counter->count.stream_activity_begin++;
-                               break;
-                       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
-                               counter->count.stream_activity_end++;
-                               break;
                        case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
                                counter->count.disc_events++;
                                break;
@@ -297,18 +300,18 @@ bt_self_component_status counter_consume(
                        bt_message_put_ref(msg);
                }
 
-               ret = BT_SELF_COMPONENT_STATUS_OK;
+               status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
                break;
        }
-       case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
-               ret = BT_SELF_COMPONENT_STATUS_AGAIN;
+       case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN:
+               status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN;
                goto end;
-       case BT_MESSAGE_ITERATOR_STATUS_END:
+       case BT_MESSAGE_ITERATOR_NEXT_STATUS_END:
                try_print_last(counter);
-               ret = BT_SELF_COMPONENT_STATUS_END;
+               status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
                goto end;
-       case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
-               ret = BT_SELF_COMPONENT_STATUS_NOMEM;
+       case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
+               status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR;
                goto end;
        default:
                break;
@@ -317,5 +320,5 @@ bt_self_component_status counter_consume(
        try_print_count(counter, msg_count);
 
 end:
-       return ret;
+       return status;
 }
This page took 0.027791 seconds and 4 git commands to generate.