src/plugins/utils/dummy/dummy.c

   1 /*
   2  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_COMP_LOG_SELF_COMP self_comp
  24 #define BT_LOG_OUTPUT_LEVEL log_level
  25 #define BT_LOG_TAG "PLUGIN/SINK.UTILS.DUMMY"
  26 #include "logging/comp-logging.h"
  27
  28 #include <babeltrace2/babeltrace.h>
  29 #include "common/macros.h"
  30 #include "common/assert.h"
  31 #include "dummy.h"
  32 #include "plugins/common/param-validation/param-validation.h"
  33
  34 static
  35 const char * const in_port_name = "in";
  36
  37 static
  38 void destroy_private_dummy_data(struct dummy *dummy)
  39 {
  40         bt_self_component_port_input_message_iterator_put_ref(dummy->msg_iter);
  41         g_free(dummy);
  42
  43 }
  44
  45 BT_HIDDEN
  46 void dummy_finalize(bt_self_component_sink *comp)
  47 {
  48         struct dummy *dummy;
  49
  50         BT_ASSERT(comp);
  51         dummy = bt_self_component_get_data(
  52                         bt_self_component_sink_as_self_component(comp));
  53         BT_ASSERT(dummy);
  54         destroy_private_dummy_data(dummy);
  55 }
  56
  57 struct bt_param_validation_map_value_entry_descr dummy_params[] = {
  58         BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
  59 };
  60
  61 BT_HIDDEN
  62 bt_component_class_initialize_method_status dummy_init(
  63                 bt_self_component_sink *self_comp_sink,
  64                 bt_self_component_sink_configuration *config,
  65                 const bt_value *params,
  66                 __attribute__((unused)) void *init_method_data)
  67 {
  68         bt_self_component *self_comp =
  69                 bt_self_component_sink_as_self_component(self_comp_sink);
  70         const bt_component *comp = bt_self_component_as_component(self_comp);
  71         bt_logging_level log_level = bt_component_get_logging_level(comp);
  72         bt_component_class_initialize_method_status status;
  73         bt_self_component_add_port_status add_port_status;
  74         struct dummy *dummy = g_new0(struct dummy, 1);
  75         enum bt_param_validation_status validation_status;
  76         gchar *validate_error = NULL;
  77
  78         if (!dummy) {
  79                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
  80                 goto end;
  81         }
  82
  83         validation_status = bt_param_validation_validate(params,
  84                 dummy_params, &validate_error);
  85         if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
  86                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
  87                 goto error;
  88         } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
  89                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
  90                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validate_error);
  91                 goto error;
  92         }
  93
  94         add_port_status = bt_self_component_sink_add_input_port(self_comp_sink,
  95                 "in", NULL, NULL);
  96         if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
  97                 status = (int) add_port_status;
  98                 goto error;
  99         }
 100
 101         bt_self_component_set_data(self_comp, dummy);
 102
 103         status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 104         goto end;
 105
 106 error:
 107         destroy_private_dummy_data(dummy);
 108
 109 end:
 110         g_free(validate_error);
 111
 112         return status;
 113 }
 114
 115 BT_HIDDEN
 116 bt_component_class_sink_graph_is_configured_method_status dummy_graph_is_configured(
 117                 bt_self_component_sink *comp)
 118 {
 119         bt_component_class_sink_graph_is_configured_method_status status;
 120         bt_self_component_port_input_message_iterator_create_from_sink_component_status
 121                 msg_iter_status;
 122         struct dummy *dummy;
 123         bt_self_component_port_input_message_iterator *iterator;
 124
 125         dummy = bt_self_component_get_data(
 126                 bt_self_component_sink_as_self_component(comp));
 127         BT_ASSERT(dummy);
 128         msg_iter_status = bt_self_component_port_input_message_iterator_create_from_sink_component(
 129                 comp, bt_self_component_sink_borrow_input_port_by_name(comp,
 130                         in_port_name), &iterator);
 131         if (msg_iter_status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) {
 132                 status = (int) msg_iter_status;
 133                 goto end;
 134         }
 135
 136         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
 137                 dummy->msg_iter, iterator);
 138
 139         status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;
 140
 141 end:
 142         return status;
 143 }
 144
 145 BT_HIDDEN
 146 bt_component_class_sink_consume_method_status dummy_consume(
 147                 bt_self_component_sink *component)
 148 {
 149         bt_component_class_sink_consume_method_status status =
 150                 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
 151         bt_message_array_const msgs;
 152         uint64_t count;
 153         struct dummy *dummy;
 154         bt_message_iterator_next_status next_status;
 155         uint64_t i;
 156
 157         dummy = bt_self_component_get_data(
 158                 bt_self_component_sink_as_self_component(component));
 159         BT_ASSERT_DBG(dummy);
 160
 161         if (G_UNLIKELY(!dummy->msg_iter)) {
 162                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
 163                 goto end;
 164         }
 165
 166         /* Consume one message  */
 167         next_status = bt_self_component_port_input_message_iterator_next(
 168                 dummy->msg_iter, &msgs, &count);
 169         switch (next_status) {
 170         case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK:
 171                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
 172
 173                 for (i = 0; i < count; i++) {
 174                         bt_message_put_ref(msgs[i]);
 175                 }
 176
 177                 break;
 178         case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN:
 179                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN;
 180                 goto end;
 181         case BT_MESSAGE_ITERATOR_NEXT_STATUS_END:
 182                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
 183                 goto end;
 184         case BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR:
 185                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
 186                 goto end;
 187         case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
 188                 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR;
 189                 goto end;
 190         default:
 191                 break;
 192         }
 193
 194 end:
 195         return status;
 196 }