src/lib/graph/component-class-sink-colander.c

   1 /*
   2  * Copyright 2017-2018 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_LOG_TAG "LIB/COLANDER"
  24 #include "lib/logging.h"
  25
  26 #include "common/assert.h"
  27 #include "lib/assert-pre.h"
  28 #include "lib/object.h"
  29 #include <babeltrace2/graph/component-class-sink.h>
  30 #include <babeltrace2/graph/self-component-sink.h>
  31 #include <babeltrace2/graph/self-component-port.h>
  32 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
  33 #include <babeltrace2/graph/self-component.h>
  34 #include <glib.h>
  35
  36 #include "component-class-sink-colander.h"
  37 #include "lib/func-status.h"
  38
  39 static
  40 struct bt_component_class_sink *colander_comp_cls;
  41
  42 static
  43 enum bt_component_class_init_method_status colander_init(
  44                 struct bt_self_component_sink *self_comp,
  45                 const struct bt_value *params, void *init_method_data)
  46 {
  47         int status = BT_FUNC_STATUS_OK;
  48         struct bt_component_class_sink_colander_priv_data *colander_data = NULL;
  49         struct bt_component_class_sink_colander_data *user_provided_data =
  50                 init_method_data;
  51
  52         BT_ASSERT(init_method_data);
  53         colander_data = g_new0(
  54                 struct bt_component_class_sink_colander_priv_data, 1);
  55         if (!colander_data) {
  56                 BT_LOGE_STR("Failed to allocate colander data.");
  57                 status = BT_FUNC_STATUS_MEMORY_ERROR;
  58                 goto end;
  59         }
  60
  61         colander_data->msgs = user_provided_data->msgs;
  62         colander_data->count_addr = user_provided_data->count_addr;
  63         status = bt_self_component_sink_add_input_port(self_comp, "in",
  64                 NULL, NULL);
  65         if (status != BT_FUNC_STATUS_OK) {
  66                 BT_LOGE_STR("Cannot add input port.");
  67                 goto end;
  68         }
  69
  70         bt_self_component_set_data(
  71                 bt_self_component_sink_as_self_component(self_comp),
  72                 colander_data);
  73
  74 end:
  75         return status;
  76 }
  77
  78 static
  79 void colander_finalize(struct bt_self_component_sink *self_comp)
  80 {
  81         struct bt_component_class_sink_colander_priv_data *colander_data =
  82                 bt_self_component_get_data(
  83                         bt_self_component_sink_as_self_component(self_comp));
  84
  85         if (!colander_data) {
  86                 return;
  87         }
  88
  89         BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
  90         g_free(colander_data);
  91 }
  92
  93 static
  94 enum bt_component_class_sink_graph_is_configured_method_status
  95 colander_graph_is_configured(
  96         bt_self_component_sink *self_comp)
  97 {
  98         enum bt_component_class_sink_graph_is_configured_method_status status =
  99                 BT_FUNC_STATUS_OK;
 100         struct bt_component_class_sink_colander_priv_data *colander_data =
 101                 bt_self_component_get_data(
 102                         bt_self_component_sink_as_self_component(self_comp));
 103
 104         struct bt_self_component_port_input *self_port =
 105                 bt_self_component_sink_borrow_input_port_by_name(self_comp, "in");
 106         BT_ASSERT(self_port);
 107
 108         BT_ASSERT(colander_data);
 109         BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
 110         colander_data->msg_iter =
 111                 bt_self_component_port_input_message_iterator_create(
 112                         self_port);
 113         if (!colander_data->msg_iter) {
 114                 BT_LIB_LOGE("Cannot create message iterator on "
 115                         "self component input port: %![port-]+p",
 116                         self_port);
 117                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 118                 goto end;
 119         }
 120
 121 end:
 122         return status;
 123 }
 124
 125 static
 126 enum bt_component_class_sink_consume_method_status colander_consume(
 127                 struct bt_self_component_sink *self_comp)
 128 {
 129         enum bt_component_class_sink_consume_method_status status =
 130                 BT_FUNC_STATUS_OK;
 131         enum bt_message_iterator_next_status next_status;
 132         struct bt_component_class_sink_colander_priv_data *colander_data =
 133                 bt_self_component_get_data(
 134                         bt_self_component_sink_as_self_component(self_comp));
 135         bt_message_array_const msgs;
 136
 137         BT_ASSERT(colander_data);
 138         BT_ASSERT(colander_data->msg_iter);
 139         next_status = bt_self_component_port_input_message_iterator_next(
 140                 colander_data->msg_iter, &msgs,
 141                 colander_data->count_addr);
 142         switch (next_status) {
 143         case BT_FUNC_STATUS_AGAIN:
 144                 status = BT_FUNC_STATUS_AGAIN;
 145                 goto end;
 146         case BT_FUNC_STATUS_END:
 147                 status = BT_FUNC_STATUS_END;
 148                 goto end;
 149         case BT_FUNC_STATUS_OK:
 150                 /* Move messages to user (count already set) */
 151                 memcpy(colander_data->msgs, msgs,
 152                         sizeof(*msgs) * *colander_data->count_addr);
 153                 break;
 154         default:
 155                 status = BT_FUNC_STATUS_ERROR;
 156                 goto end;
 157         }
 158
 159 end:
 160         return status;
 161 }
 162
 163 struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
 164 {
 165         if (colander_comp_cls) {
 166                 goto end;
 167         }
 168
 169         colander_comp_cls = bt_component_class_sink_create("colander",
 170                 colander_consume);
 171         if (!colander_comp_cls) {
 172                 BT_LOGE_STR("Cannot create sink colander component class.");
 173                 goto end;
 174         }
 175
 176         (void) bt_component_class_sink_set_init_method(
 177                 colander_comp_cls, colander_init);
 178         (void) bt_component_class_sink_set_finalize_method(
 179                 colander_comp_cls, colander_finalize);
 180         (void) bt_component_class_sink_set_graph_is_configured_method(
 181                 colander_comp_cls, colander_graph_is_configured);
 182
 183 end:
 184         bt_object_get_ref(colander_comp_cls);
 185         return colander_comp_cls;
 186 }
 187
 188 __attribute__((destructor)) static
 189 void put_colander(void) {
 190         BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
 191 }