lib/graph/connection.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "CONNECTION"
  25 #include <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/graph/notification-iterator-internal.h>
  28 #include <babeltrace/graph/component-internal.h>
  29 #include <babeltrace/graph/connection-internal.h>
  30 #include <babeltrace/graph/connection-const.h>
  31 #include <babeltrace/graph/graph-internal.h>
  32 #include <babeltrace/graph/port-internal.h>
  33 #include <babeltrace/object-internal.h>
  34 #include <babeltrace/compiler-internal.h>
  35 #include <babeltrace/object.h>
  36 #include <babeltrace/assert-internal.h>
  37 #include <babeltrace/assert-pre-internal.h>
  38 #include <stdlib.h>
  39 #include <glib.h>
  40
  41 static
  42 void destroy_connection(struct bt_object *obj)
  43 {
  44         struct bt_connection *connection = container_of(obj,
  45                         struct bt_connection, base);
  46
  47         BT_LIB_LOGD("Destroying connection: %!+x", connection);
  48
  49         /*
  50          * Make sure that each notification iterator which was created
  51          * for this connection is finalized before we destroy it. Once a
  52          * notification iterator is finalized, all its method return
  53          * NULL or the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED status.
  54          *
  55          * Because connections are destroyed before components within a
  56          * graph, this ensures that notification iterators are always
  57          * finalized before their upstream component.
  58          *
  59          * Ending the connection does exactly this. We pass `false` to
  60          * bt_connection_end() here to avoid removing this connection
  61          * from the graph: if we're here, we're already in the graph's
  62          * destructor.
  63          */
  64         bt_connection_end(connection, false);
  65         g_ptr_array_free(connection->iterators, TRUE);
  66         connection->iterators = NULL;
  67
  68         /*
  69          * No bt_object_put_ref on ports as a connection only holds _weak_
  70          * references to them.
  71          */
  72         g_free(connection);
  73 }
  74
  75 static
  76 void try_remove_connection_from_graph(struct bt_connection *connection)
  77 {
  78         void *graph = (void *) bt_object_borrow_parent(&connection->base);
  79
  80         if (connection->base.ref_count > 0 ||
  81                         connection->downstream_port ||
  82                         connection->upstream_port ||
  83                         connection->iterators->len > 0) {
  84                 return;
  85         }
  86
  87         /*
  88          * At this point we know that:
  89          *
  90          * 1. The connection is ended (ports were disconnected).
  91          * 2. All the notification iterators that this connection
  92          *    created, if any, are finalized.
  93          * 3. The connection's reference count is 0, so only the
  94          *    parent (graph) owns this connection after this call.
  95          *
  96          * In other words, no other object than the graph knows this
  97          * connection.
  98          *
  99          * It is safe to remove the connection from the graph, therefore
 100          * destroying it.
 101          */
 102         BT_LIB_LOGD("Removing self from graph's connections: "
 103                 "%![graph-]+g, %![conn-]+x", graph, connection);
 104         bt_graph_remove_connection(graph, connection);
 105 }
 106
 107 static
 108 void parent_is_owner(struct bt_object *obj)
 109 {
 110         struct bt_connection *connection = container_of(obj,
 111                         struct bt_connection, base);
 112
 113         try_remove_connection_from_graph(connection);
 114 }
 115
 116 BT_HIDDEN
 117 struct bt_connection *bt_connection_create(struct bt_graph *graph,
 118                 struct bt_port *upstream_port,
 119                 struct bt_port *downstream_port)
 120 {
 121         struct bt_connection *connection = NULL;
 122
 123         BT_LIB_LOGD("Creating connection: "
 124                 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
 125                 graph, upstream_port, downstream_port);
 126         connection = g_new0(struct bt_connection, 1);
 127         if (!connection) {
 128                 BT_LOGE_STR("Failed to allocate one connection.");
 129                 goto end;
 130         }
 131
 132         bt_object_init_shared_with_parent(&connection->base,
 133                 destroy_connection);
 134         bt_object_set_parent_is_owner_listener_func(&connection->base,
 135                 parent_is_owner);
 136         connection->iterators = g_ptr_array_new();
 137         if (!connection->iterators) {
 138                 BT_LOGE_STR("Failed to allocate a GPtrArray.");
 139                 BT_OBJECT_PUT_REF_AND_RESET(connection);
 140                 goto end;
 141         }
 142
 143         /* Weak references are taken, see comment in header. */
 144         connection->upstream_port = upstream_port;
 145         connection->downstream_port = downstream_port;
 146         BT_LIB_LOGD("Setting upstream port's connection: %!+p", upstream_port);
 147         bt_port_set_connection(upstream_port, connection);
 148         BT_LIB_LOGD("Setting downstream port's connection: %!+p",
 149                 downstream_port);
 150         bt_port_set_connection(downstream_port, connection);
 151         bt_object_set_parent(&connection->base, &graph->base);
 152         BT_LIB_LOGD("Created connection: %!+x", connection);
 153
 154 end:
 155         return connection;
 156 }
 157
 158 BT_HIDDEN
 159 void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph)
 160 {
 161         struct bt_component *downstream_comp = NULL;
 162         struct bt_component *upstream_comp = NULL;
 163         struct bt_port *downstream_port = conn->downstream_port;
 164         struct bt_port *upstream_port = conn->upstream_port;
 165         struct bt_graph *graph = bt_connection_borrow_graph(conn);
 166         size_t i;
 167
 168         BT_LIB_LOGD("Ending connection: %!+x, try-remove-from-graph=%d",
 169                 conn, try_remove_from_graph);
 170
 171         /*
 172          * Any of the following notification callback functions could
 173          * remove one of the connection's ports from its component. To
 174          * make sure that at least logging in called functions works
 175          * with existing objects, get a local reference on both ports.
 176          */
 177         bt_object_get_ref(downstream_port);
 178         bt_object_get_ref(upstream_port);
 179
 180         if (downstream_port) {
 181                 BT_LIB_LOGD("Disconnecting connection's downstream port: %!+p",
 182                         downstream_port);
 183                 downstream_comp = bt_port_borrow_component_inline(
 184                         downstream_port);
 185                 bt_port_set_connection(downstream_port, NULL);
 186                 conn->downstream_port = NULL;
 187         }
 188
 189         if (upstream_port) {
 190                 BT_LIB_LOGD("Disconnecting connection's upstream port: %!+p",
 191                         upstream_port);
 192                 upstream_comp = bt_port_borrow_component_inline(
 193                         upstream_port);
 194                 bt_port_set_connection(upstream_port, NULL);
 195                 conn->upstream_port = NULL;
 196         }
 197
 198         if (downstream_comp && conn->notified_downstream_port_connected &&
 199                         !conn->notified_downstream_port_disconnected) {
 200                 /* bt_component_port_disconnected() logs details */
 201                 bt_component_port_disconnected(downstream_comp,
 202                         downstream_port);
 203                 conn->notified_downstream_port_disconnected = true;
 204         }
 205
 206         if (upstream_comp && conn->notified_upstream_port_connected &&
 207                         !conn->notified_upstream_port_disconnected) {
 208                 /* bt_component_port_disconnected() logs details */
 209                 bt_component_port_disconnected(upstream_comp, upstream_port);
 210                 conn->notified_upstream_port_disconnected = true;
 211         }
 212
 213         BT_ASSERT(graph);
 214
 215         if (conn->notified_graph_ports_connected &&
 216                         !conn->notified_graph_ports_disconnected) {
 217                 /* bt_graph_notify_ports_disconnected() logs details */
 218                 bt_graph_notify_ports_disconnected(graph, upstream_comp,
 219                         downstream_comp, upstream_port, downstream_port);
 220                 conn->notified_graph_ports_disconnected = true;
 221         }
 222
 223         /*
 224          * It is safe to put the local port references now that we don't
 225          * need them anymore. This could indeed destroy them.
 226          */
 227         bt_object_put_ref(downstream_port);
 228         bt_object_put_ref(upstream_port);
 229
 230         /*
 231          * Because this connection is ended, finalize (cancel) each
 232          * notification iterator created from it.
 233          */
 234         for (i = 0; i < conn->iterators->len; i++) {
 235                 struct bt_self_component_port_input_notification_iterator *iterator =
 236                         g_ptr_array_index(conn->iterators, i);
 237
 238                 BT_LIB_LOGD("Finalizing notification iterator created by "
 239                         "this ended connection: %![iter-]+i", iterator);
 240                 bt_self_component_port_input_notification_iterator_finalize(
 241                         iterator);
 242
 243                 /*
 244                  * Make sure this iterator does not try to remove itself
 245                  * from this connection's iterators on destruction
 246                  * because this connection won't exist anymore.
 247                  */
 248                 bt_self_component_port_input_notification_iterator_set_connection(
 249                         iterator, NULL);
 250         }
 251
 252         g_ptr_array_set_size(conn->iterators, 0);
 253
 254         if (try_remove_from_graph) {
 255                 try_remove_connection_from_graph(conn);
 256         }
 257 }
 258
 259 const struct bt_port_output *bt_connection_borrow_upstream_port_const(
 260                 const struct bt_connection *connection)
 261 {
 262         BT_ASSERT_PRE_NON_NULL(connection, "Connection");
 263         return (void *) connection->upstream_port;
 264 }
 265
 266 const struct bt_port_input *bt_connection_borrow_downstream_port_const(
 267                 const struct bt_connection *connection)
 268 {
 269         BT_ASSERT_PRE_NON_NULL(connection, "Connection");
 270         return (void *) connection->downstream_port;
 271 }
 272
 273 BT_HIDDEN
 274 void bt_connection_remove_iterator(struct bt_connection *conn,
 275                 struct bt_self_component_port_input_notification_iterator *iterator)
 276 {
 277         g_ptr_array_remove(conn->iterators, iterator);
 278         BT_LIB_LOGV("Removed notification iterator from connection: "
 279                 "%![conn-]+x, %![iter-]+i", conn, iterator);
 280         try_remove_connection_from_graph(conn);
 281 }
 282
 283 bt_bool bt_connection_is_ended(const struct bt_connection *connection)
 284 {
 285         return !connection->downstream_port && !connection->upstream_port;
 286 }