lib/graph/sink.c

   1 /*
   2  * sink.c
   3  *
   4  * Babeltrace Sink Component
   5  *
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #define BT_LOG_TAG "COMP-SINK"
  30 #include <babeltrace/lib-logging-internal.h>
  31
  32 #include <babeltrace/compiler-internal.h>
  33 #include <babeltrace/values.h>
  34 #include <babeltrace/graph/private-component.h>
  35 #include <babeltrace/graph/component-sink-internal.h>
  36 #include <babeltrace/graph/component-internal.h>
  37 #include <babeltrace/graph/notification.h>
  38 #include <babeltrace/graph/graph.h>
  39 #include <babeltrace/assert-internal.h>
  40 #include <babeltrace/assert-internal.h>
  41
  42 BT_HIDDEN
  43 void bt_component_sink_destroy(struct bt_component *component)
  44 {
  45 }
  46
  47 BT_HIDDEN
  48 struct bt_component *bt_component_sink_create(
  49                 struct bt_component_class *class)
  50 {
  51         struct bt_component_sink *sink = NULL;
  52
  53         sink = g_new0(struct bt_component_sink, 1);
  54         if (!sink) {
  55                 BT_LOGE_STR("Failed to allocate one sink component.");
  56                 goto end;
  57         }
  58
  59 end:
  60         return sink ? &sink->parent : NULL;
  61 }
  62
  63 BT_HIDDEN
  64 enum bt_component_status bt_component_sink_consume(
  65                 struct bt_component *component)
  66 {
  67         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  68         struct bt_component_class_sink *sink_class = NULL;
  69
  70         BT_ASSERT(component);
  71         BT_ASSERT(bt_component_get_class_type(component) == BT_COMPONENT_CLASS_TYPE_SINK);
  72         sink_class = container_of(component->class, struct bt_component_class_sink, parent);
  73         BT_ASSERT(sink_class->methods.consume);
  74         BT_LOGD("Calling user's consume method: "
  75                 "comp-addr=%p, comp-name=\"%s\"",
  76                 component, bt_component_get_name(component));
  77         ret = sink_class->methods.consume(bt_private_component_from_component(component));
  78         BT_LOGD("User method returned: status=%s",
  79                 bt_component_status_string(ret));
  80         if (ret < 0) {
  81                 BT_LOGW_STR("Consume method failed.");
  82         }
  83
  84         return ret;
  85 }
  86
  87 int64_t bt_component_sink_get_input_port_count(struct bt_component *component)
  88 {
  89         int64_t ret;
  90
  91         if (!component) {
  92                 BT_LOGW_STR("Invalid parameter: component is NULL.");
  93                 ret = (int64_t) -1;
  94                 goto end;
  95         }
  96
  97         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
  98                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
  99                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 100                         component, bt_component_get_name(component),
 101                         bt_component_class_type_string(component->class->type));
 102                 ret = (int64_t) -1;
 103                 goto end;
 104         }
 105
 106         /* bt_component_get_input_port_count() logs details/errors */
 107         ret = bt_component_get_input_port_count(component);
 108
 109 end:
 110         return ret;
 111 }
 112
 113 struct bt_port *bt_component_sink_get_input_port_by_name(
 114                 struct bt_component *component, const char *name)
 115 {
 116         struct bt_port *port = NULL;
 117
 118         if (!component) {
 119                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 120                 goto end;
 121         }
 122
 123         if (!name) {
 124                 BT_LOGW_STR("Invalid parameter: name is NULL.");
 125                 goto end;
 126         }
 127
 128         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 129                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 130                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 131                         component, bt_component_get_name(component),
 132                         bt_component_class_type_string(component->class->type));
 133                 goto end;
 134         }
 135
 136         /* bt_component_get_input_port_by_name() logs details/errors */
 137         port = bt_component_get_input_port_by_name(component, name);
 138
 139 end:
 140         return port;
 141 }
 142
 143 struct bt_port *bt_component_sink_get_input_port_by_index(
 144                 struct bt_component *component, uint64_t index)
 145 {
 146         struct bt_port *port = NULL;
 147
 148         if (!component) {
 149                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 150                 goto end;
 151         }
 152
 153         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 154                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 155                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 156                         component, bt_component_get_name(component),
 157                         bt_component_class_type_string(component->class->type));
 158                 goto end;
 159         }
 160
 161         /* bt_component_get_input_port_by_index() logs details/errors */
 162         port = bt_component_get_input_port_by_index(component, index);
 163
 164 end:
 165         return port;
 166 }
 167
 168 struct bt_private_port *
 169 bt_private_component_sink_get_input_private_port_by_index(
 170                 struct bt_private_component *private_component, uint64_t index)
 171 {
 172         /* bt_component_sink_get_input_port_by_index() logs details/errors */
 173         return bt_private_port_from_port(
 174                 bt_component_sink_get_input_port_by_index(
 175                         bt_component_borrow_from_private(private_component), index));
 176 }
 177
 178 struct bt_private_port *
 179 bt_private_component_sink_get_input_private_port_by_name(
 180                 struct bt_private_component *private_component,
 181                 const char *name)
 182 {
 183         /* bt_component_sink_get_input_port_by_name() logs details/errors */
 184         return bt_private_port_from_port(
 185                 bt_component_sink_get_input_port_by_name(
 186                         bt_component_borrow_from_private(private_component), name));
 187 }
 188
 189 enum bt_component_status bt_private_component_sink_add_input_private_port(
 190                 struct bt_private_component *private_component,
 191                 const char *name, void *user_data,
 192                 struct bt_private_port **user_priv_port)
 193 {
 194         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 195         struct bt_port *port = NULL;
 196         struct bt_component *component =
 197                 bt_component_borrow_from_private(private_component);
 198         struct bt_graph *graph;
 199
 200         if (!component) {
 201                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 202                 status = BT_COMPONENT_STATUS_INVALID;
 203                 goto end;
 204         }
 205
 206         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 207                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 208                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 209                         component, bt_component_get_name(component),
 210                         bt_component_class_type_string(component->class->type));
 211                 status = BT_COMPONENT_STATUS_INVALID;
 212                 goto end;
 213         }
 214
 215         graph = bt_component_borrow_graph(component);
 216
 217         if (graph && bt_graph_is_canceled(graph)) {
 218                 BT_LOGW("Cannot add input port to sink component: graph is canceled: "
 219                         "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
 220                         component, bt_component_get_name(component),
 221                         bt_component_borrow_graph(component));
 222                 status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
 223                 goto end;
 224         }
 225
 226         /* bt_component_add_input_port() logs details/errors */
 227         port = bt_component_add_input_port(component, name, user_data);
 228         if (!port) {
 229                 status = BT_COMPONENT_STATUS_NOMEM;
 230                 goto end;
 231         }
 232
 233         if (user_priv_port) {
 234                 /* Move reference to user */
 235                 *user_priv_port = bt_private_port_from_port(port);
 236                 port = NULL;
 237         }
 238
 239 end:
 240         bt_put(port);
 241         return status;
 242 }