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 int64_t bt_component_sink_get_input_port_count(struct bt_component *component)
  64 {
  65         int64_t ret;
  66
  67         if (!component) {
  68                 BT_LOGW_STR("Invalid parameter: component is NULL.");
  69                 ret = (int64_t) -1;
  70                 goto end;
  71         }
  72
  73         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
  74                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
  75                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
  76                         component, bt_component_get_name(component),
  77                         bt_component_class_type_string(component->class->type));
  78                 ret = (int64_t) -1;
  79                 goto end;
  80         }
  81
  82         /* bt_component_get_input_port_count() logs details/errors */
  83         ret = bt_component_get_input_port_count(component);
  84
  85 end:
  86         return ret;
  87 }
  88
  89 struct bt_port *bt_component_sink_get_input_port_by_name(
  90                 struct bt_component *component, const char *name)
  91 {
  92         struct bt_port *port = NULL;
  93
  94         if (!component) {
  95                 BT_LOGW_STR("Invalid parameter: component is NULL.");
  96                 goto end;
  97         }
  98
  99         if (!name) {
 100                 BT_LOGW_STR("Invalid parameter: name is NULL.");
 101                 goto end;
 102         }
 103
 104         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 105                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 106                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 107                         component, bt_component_get_name(component),
 108                         bt_component_class_type_string(component->class->type));
 109                 goto end;
 110         }
 111
 112         /* bt_component_get_input_port_by_name() logs details/errors */
 113         port = bt_component_get_input_port_by_name(component, name);
 114
 115 end:
 116         return port;
 117 }
 118
 119 struct bt_port *bt_component_sink_get_input_port_by_index(
 120                 struct bt_component *component, uint64_t index)
 121 {
 122         struct bt_port *port = NULL;
 123
 124         if (!component) {
 125                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 126                 goto end;
 127         }
 128
 129         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 130                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 131                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 132                         component, bt_component_get_name(component),
 133                         bt_component_class_type_string(component->class->type));
 134                 goto end;
 135         }
 136
 137         /* bt_component_get_input_port_by_index() logs details/errors */
 138         port = bt_component_get_input_port_by_index(component, index);
 139
 140 end:
 141         return port;
 142 }
 143
 144 struct bt_private_port *
 145 bt_private_component_sink_get_input_private_port_by_index(
 146                 struct bt_private_component *private_component, uint64_t index)
 147 {
 148         /* bt_component_sink_get_input_port_by_index() logs details/errors */
 149         return bt_private_port_from_port(
 150                 bt_component_sink_get_input_port_by_index(
 151                         bt_component_borrow_from_private(private_component), index));
 152 }
 153
 154 struct bt_private_port *
 155 bt_private_component_sink_get_input_private_port_by_name(
 156                 struct bt_private_component *private_component,
 157                 const char *name)
 158 {
 159         /* bt_component_sink_get_input_port_by_name() logs details/errors */
 160         return bt_private_port_from_port(
 161                 bt_component_sink_get_input_port_by_name(
 162                         bt_component_borrow_from_private(private_component), name));
 163 }
 164
 165 enum bt_component_status bt_private_component_sink_add_input_private_port(
 166                 struct bt_private_component *private_component,
 167                 const char *name, void *user_data,
 168                 struct bt_private_port **user_priv_port)
 169 {
 170         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 171         struct bt_port *port = NULL;
 172         struct bt_component *component =
 173                 bt_component_borrow_from_private(private_component);
 174         struct bt_graph *graph;
 175
 176         if (!component) {
 177                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 178                 status = BT_COMPONENT_STATUS_INVALID;
 179                 goto end;
 180         }
 181
 182         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 183                 BT_LOGW("Invalid parameter: component's class is not a sink component class: "
 184                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 185                         component, bt_component_get_name(component),
 186                         bt_component_class_type_string(component->class->type));
 187                 status = BT_COMPONENT_STATUS_INVALID;
 188                 goto end;
 189         }
 190
 191         graph = bt_component_borrow_graph(component);
 192
 193         if (graph && bt_graph_is_canceled(graph)) {
 194                 BT_LOGW("Cannot add input port to sink component: graph is canceled: "
 195                         "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
 196                         component, bt_component_get_name(component),
 197                         bt_component_borrow_graph(component));
 198                 status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
 199                 goto end;
 200         }
 201
 202         /* bt_component_add_input_port() logs details/errors */
 203         port = bt_component_add_input_port(component, name, user_data);
 204         if (!port) {
 205                 status = BT_COMPONENT_STATUS_NOMEM;
 206                 goto end;
 207         }
 208
 209         if (user_priv_port) {
 210                 /* Move reference to user */
 211                 *user_priv_port = bt_private_port_from_port(port);
 212                 port = NULL;
 213         }
 214
 215 end:
 216         bt_object_put_ref(port);
 217         return status;
 218 }