End connection on destruction

End connection on destruction so that each port is disconnected once the
connection is destroyed. Otherwise each port keeps its connection
pointer as is which point to freed memory.

bt_connection_end() already makes sure to finalize each created
notification iterator, so all is left in the destructor is to free the
array of iterators and the connection itself.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace/graph/connection-internal.h b/include/babeltrace/graph/connection-internal.h
index fb4f668f36c040c8bfb62cf4da545239aa8f65df..6044f0a5934dd4c0a2fdf81d6d884b5a5d595fa6 100644 (file)
--- a/include/babeltrace/graph/connection-internal.h
+++ b/include/babeltrace/graph/connection-internal.h
@@ -31,6 +31,7 @@
 #include <babeltrace/graph/notification-iterator.h>
 #include <babeltrace/graph/private-connection.h>
 #include <babeltrace/object-internal.h>
+#include <stdbool.h>
 
 struct bt_graph;
 
@@ -77,7 +78,7 @@ struct bt_connection *bt_connection_create(struct bt_graph *graph,
                struct bt_port *downstream_port);
 
 BT_HIDDEN
-void bt_connection_disconnect_ports(struct bt_connection *conn);
+void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
 
 BT_HIDDEN
 void bt_connection_remove_iterator(struct bt_connection *conn,

diff --git a/lib/graph/component.c b/lib/graph/component.c
index 9fad68ac968074a71c0aeb6c017c954599e85e25..8664e3b423fb4a19ef2f70dc73adf2731ee422e6 100644 (file)
--- a/lib/graph/component.c
+++ b/lib/graph/component.c
@@ -554,7 +554,7 @@ void bt_component_remove_port_by_index(struct bt_component *component,
 
        /* Disconnect both ports of this port's connection, if any */
        if (port->connection) {
-               bt_connection_disconnect_ports(port->connection);
+               bt_connection_end(port->connection, true);
        }
 
        /* Remove from parent's array of ports (weak refs) */

diff --git a/lib/graph/connection.c b/lib/graph/connection.c
index 72bbb852c0afc76f7a0b8214eb984d6cd84af971..ef4fefede918ff625a4349a7e165797b51b7804e 100644 (file)
--- a/lib/graph/connection.c
+++ b/lib/graph/connection.c
@@ -47,7 +47,6 @@ void bt_connection_destroy(struct bt_object *obj)
 {
        struct bt_connection *connection = container_of(obj,
                        struct bt_connection, base);
-       size_t i;
 
        BT_LOGD("Destroying connection: addr=%p", connection);
 
@@ -60,32 +59,18 @@ void bt_connection_destroy(struct bt_object *obj)
         * Because connections are destroyed before components within a
         * graph, this ensures that notification iterators are always
         * finalized before their upstream component.
+        *
+        * Ending the connection does exactly this. We pass `false` to
+        * bt_connection_end() here to avoid removing this connection
+        * from the graph: if we're here, we're already in the graph's
+        * destructor.
         */
-       if (connection->iterators) {
-               for (i = 0; i < connection->iterators->len; i++) {
-                       struct bt_notification_iterator *iterator =
-                               g_ptr_array_index(connection->iterators, i);
-
-                       BT_LOGD("Finalizing notification iterator created by this connection: "
-                               "iter-addr=%p", iterator);
-                       bt_notification_iterator_finalize(iterator);
-
-                       /*
-                        * Make sure this iterator does not try to
-                        * remove itself from this connection's
-                        * iterators on destruction because this
-                        * connection won't exist anymore.
-                        */
-                       bt_notification_iterator_set_connection(iterator,
-                               NULL);
-               }
-
-               g_ptr_array_free(connection->iterators, TRUE);
-       }
+       bt_connection_end(connection, false);
+       g_ptr_array_free(connection->iterators, TRUE);
 
        /*
-        * No bt_put on ports as a connection only holds _weak_ references
-        * to them.
+        * No bt_put on ports as a connection only holds _weak_
+        * references to them.
         */
        g_free(connection);
 }
@@ -196,22 +181,32 @@ end:
 }
 
 BT_HIDDEN
-void bt_connection_disconnect_ports(struct bt_connection *conn)
+void bt_connection_end(struct bt_connection *conn,
+               bool try_remove_from_graph)
 {
        struct bt_component *downstream_comp = NULL;
        struct bt_component *upstream_comp = NULL;
        struct bt_port *downstream_port = conn->downstream_port;
        struct bt_port *upstream_port = conn->upstream_port;
-       struct bt_graph *graph = (void *) bt_object_borrow_parent(conn);
+       struct bt_graph *graph = bt_connection_borrow_graph(conn);
        size_t i;
 
+       BT_LOGD("Ending connection: conn-addr=%p, try-remove-from-graph=%d",
+               conn, try_remove_from_graph);
+
        if (downstream_port) {
+               BT_LOGD("Disconnecting connection's downstream port: "
+                       "port-addr=%p, port-name=\"%s\"",
+                       downstream_port, bt_port_get_name(downstream_port));
                downstream_comp = bt_port_get_component(downstream_port);
                bt_port_set_connection(downstream_port, NULL);
                conn->downstream_port = NULL;
        }
 
        if (upstream_port) {
+               BT_LOGD("Disconnecting connection's upstream port: "
+                       "port-addr=%p, port-name=\"%s\"",
+                       upstream_port, bt_port_get_name(upstream_port));
                upstream_comp = bt_port_get_component(upstream_port);
                bt_port_set_connection(upstream_port, NULL);
                conn->upstream_port = NULL;
@@ -257,7 +252,10 @@ void bt_connection_disconnect_ports(struct bt_connection *conn)
        }
 
        g_ptr_array_set_size(conn->iterators, 0);
-       bt_connection_try_remove_from_graph(conn);
+
+       if (try_remove_from_graph) {
+               bt_connection_try_remove_from_graph(conn);
+       }
 }
 
 struct bt_port *bt_connection_get_upstream_port(

diff --git a/lib/graph/port.c b/lib/graph/port.c
index 4f974aa1fae91cd1eb1b6b95ef230d7c6e3dc165..944e1cd4d859b4e08c711e1d5347a4c029fb5e31 100644 (file)
--- a/lib/graph/port.c
+++ b/lib/graph/port.c
@@ -203,7 +203,7 @@ int bt_port_disconnect(struct bt_port *port)
        }
 
        if (port->connection) {
-               bt_connection_disconnect_ports(port->connection);
+               bt_connection_end(port->connection, true);
                BT_LOGV("Disconnected port: "
                        "port-addr=%p, port-name=\"%s\"",
                        port, bt_port_get_name(port));