lib/component/connection.c

   1 /*
   2  * connection.c
   3  *
   4  * Babeltrace Connection
   5  *
   6  * Copyright 2017 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 #include <babeltrace/component/notification/iterator-internal.h>
  30 #include <babeltrace/component/component-internal.h>
  31 #include <babeltrace/component/component-source-internal.h>
  32 #include <babeltrace/component/component-filter-internal.h>
  33 #include <babeltrace/component/connection-internal.h>
  34 #include <babeltrace/component/private-connection.h>
  35 #include <babeltrace/component/graph-internal.h>
  36 #include <babeltrace/component/port-internal.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <babeltrace/compiler.h>
  39 #include <glib.h>
  40
  41 static
  42 void bt_connection_destroy(struct bt_object *obj)
  43 {
  44         struct bt_connection *connection = container_of(obj,
  45                         struct bt_connection, base);
  46
  47         /*
  48          * No bt_put on ports as a connection only holds _weak_ references
  49          * to them.
  50          */
  51         g_free(connection);
  52 }
  53
  54 struct bt_connection *bt_connection_from_private_connection(
  55                 struct bt_private_connection *private_connection)
  56 {
  57         return bt_get(bt_connection_from_private(private_connection));
  58 }
  59
  60 BT_HIDDEN
  61 struct bt_connection *bt_connection_create(
  62                 struct bt_graph *graph,
  63                 struct bt_port *upstream_port,
  64                 struct bt_port *downstream_port)
  65 {
  66         struct bt_connection *connection = NULL;
  67
  68         if (bt_port_get_type(upstream_port) != BT_PORT_TYPE_OUTPUT) {
  69                 goto end;
  70         }
  71         if (bt_port_get_type(downstream_port) != BT_PORT_TYPE_INPUT) {
  72                 goto end;
  73         }
  74
  75         connection = g_new0(struct bt_connection, 1);
  76         if (!connection) {
  77                 goto end;
  78         }
  79
  80         bt_object_init(connection, bt_connection_destroy);
  81         /* Weak references are taken, see comment in header. */
  82         connection->upstream_port = upstream_port;
  83         connection->downstream_port = downstream_port;
  84         bt_port_set_connection(upstream_port, connection);
  85         bt_port_set_connection(downstream_port, connection);
  86         bt_object_set_parent(connection, &graph->base);
  87 end:
  88         return connection;
  89 }
  90
  91 BT_HIDDEN
  92 void bt_connection_disconnect_ports(struct bt_connection *conn,
  93                 struct bt_component *acting_comp)
  94 {
  95         struct bt_component *downstream_comp = NULL;
  96         struct bt_component *upstream_comp = NULL;
  97         struct bt_port *downstream_port = conn->downstream_port;
  98         struct bt_port *upstream_port = conn->upstream_port;
  99
 100         if (downstream_port) {
 101                 downstream_comp = bt_port_get_component(downstream_port);
 102                 bt_port_set_connection(downstream_port, NULL);
 103                 conn->downstream_port = NULL;
 104         }
 105
 106         if (upstream_port) {
 107                 upstream_comp = bt_port_get_component(upstream_port);
 108                 bt_port_set_connection(upstream_port, NULL);
 109                 conn->upstream_port = NULL;
 110         }
 111
 112         if (downstream_comp && downstream_comp != acting_comp) {
 113                 bt_component_port_disconnected(downstream_comp,
 114                         downstream_port);
 115         }
 116
 117         if (upstream_comp && upstream_comp != acting_comp) {
 118                 bt_component_port_disconnected(upstream_comp, upstream_port);
 119         }
 120
 121         if (upstream_comp) {
 122                 struct bt_graph *graph = bt_component_get_graph(upstream_comp);
 123
 124                 assert(graph);
 125                 bt_graph_notify_port_disconnected(graph, upstream_comp,
 126                         upstream_port);
 127                 bt_put(graph);
 128         }
 129
 130         if (downstream_comp) {
 131                 struct bt_graph *graph =
 132                         bt_component_get_graph(downstream_comp);
 133
 134                 assert(graph);
 135                 bt_graph_notify_port_disconnected(graph, downstream_comp,
 136                         downstream_port);
 137                 bt_put(graph);
 138         }
 139
 140         bt_put(downstream_comp);
 141         bt_put(upstream_comp);
 142 }
 143
 144 struct bt_port *bt_connection_get_upstream_port(
 145                 struct bt_connection *connection)
 146 {
 147         return connection ? bt_get(connection->upstream_port) : NULL;
 148 }
 149
 150 struct bt_port *bt_connection_get_downstream_port(
 151                 struct bt_connection *connection)
 152 {
 153         return connection ? bt_get(connection->downstream_port) : NULL;
 154 }
 155
 156 struct bt_notification_iterator *
 157 bt_private_connection_create_notification_iterator(
 158                 struct bt_private_connection *private_connection)
 159 {
 160         enum bt_notification_iterator_status ret_iterator;
 161         enum bt_component_class_type upstream_comp_class_type;
 162         struct bt_notification_iterator *iterator = NULL;
 163         struct bt_port *upstream_port = NULL;
 164         struct bt_component *upstream_component = NULL;
 165         struct bt_component_class *upstream_comp_class = NULL;
 166         struct bt_connection *connection = NULL;
 167         bt_component_class_notification_iterator_init_method init_method = NULL;
 168
 169         if (!private_connection) {
 170                 goto error;
 171         }
 172
 173         connection = bt_connection_from_private(private_connection);
 174
 175         if (!connection->upstream_port || !connection->downstream_port) {
 176                 goto error;
 177         }
 178
 179         upstream_port = connection->upstream_port;
 180         assert(upstream_port);
 181         upstream_component = bt_port_get_component(upstream_port);
 182         assert(upstream_component);
 183         upstream_comp_class = upstream_component->class;
 184
 185         if (!upstream_component) {
 186                 goto error;
 187         }
 188
 189         upstream_comp_class_type =
 190                 bt_component_get_class_type(upstream_component);
 191         if (upstream_comp_class_type != BT_COMPONENT_CLASS_TYPE_SOURCE &&
 192                         upstream_comp_class_type != BT_COMPONENT_CLASS_TYPE_FILTER) {
 193                 /* Unsupported operation. */
 194                 goto error;
 195         }
 196
 197         iterator = bt_notification_iterator_create(upstream_component);
 198         if (!iterator) {
 199                 goto error;
 200         }
 201
 202         switch (upstream_comp_class_type) {
 203         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 204         {
 205                 struct bt_component_class_source *source_class =
 206                         container_of(upstream_comp_class,
 207                                 struct bt_component_class_source, parent);
 208                 init_method = source_class->methods.iterator.init;
 209                 break;
 210         }
 211         case BT_COMPONENT_CLASS_TYPE_FILTER:
 212         {
 213                 struct bt_component_class_filter *filter_class =
 214                         container_of(upstream_comp_class,
 215                                 struct bt_component_class_filter, parent);
 216                 init_method = filter_class->methods.iterator.init;
 217                 break;
 218         }
 219         default:
 220                 /* Unreachable. */
 221                 assert(0);
 222         }
 223
 224         if (init_method) {
 225                 enum bt_notification_iterator_status status = init_method(
 226                         bt_private_component_from_component(upstream_component),
 227                         bt_private_port_from_port(upstream_port),
 228                         bt_private_notification_iterator_from_notification_iterator(iterator));
 229                 if (status < 0) {
 230                         goto error;
 231                 }
 232         }
 233
 234         ret_iterator = bt_notification_iterator_validate(iterator);
 235         if (ret_iterator != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 236                 goto error;
 237         }
 238
 239         goto end;
 240
 241 error:
 242         BT_PUT(iterator);
 243
 244 end:
 245         bt_put(upstream_component);
 246         return iterator;
 247 }