[babeltrace.git] / lib / graph / connection.c

/*
 * connection.c
 *
 * Babeltrace Connection
 *
 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#define BT_LOG_TAG "CONNECTION"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/graph/notification-iterator-internal.h>
#include <babeltrace/graph/component-internal.h>
#include <babeltrace/graph/component-source-internal.h>
#include <babeltrace/graph/component-filter-internal.h>
#include <babeltrace/graph/connection-internal.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/graph/graph-internal.h>
#include <babeltrace/graph/port-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/compiler-internal.h>
#include <stdlib.h>
#include <glib.h>

static
void bt_connection_destroy(struct bt_object *obj)
{
	struct bt_connection *connection = container_of(obj,
			struct bt_connection, base);

	BT_LOGD("Destroying connection: addr=%p", connection);

	/*
	 * Make sure that each notification iterator which was created
	 * for this connection is finalized before we destroy it. Once a
	 * notification iterator is finalized, all its method return
	 * NULL or the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED status.
	 *
	 * 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.
	 */
	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.
	 */
	g_free(connection);
}

static
void bt_connection_try_remove_from_graph(struct bt_connection *connection)
{
	void *graph = bt_object_borrow_parent(&connection->base);

	if (connection->base.ref_count.count > 0 ||
			connection->downstream_port ||
			connection->upstream_port ||
			connection->iterators->len > 0) {
		return;
	}

	/*
	 * At this point we know that:
	 *
	 * 1. The connection is ended (ports were disconnected).
	 * 2. All the notification iterators that this connection
	 *    created, if any, are finalized.
	 * 3. The connection's reference count is 0, so only the
	 *    parent (graph) owns this connection after this call.
	 *
	 * In other words, no other object than the graph knows this
	 * connection.
	 *
	 * It is safe to remove the connection from the graph, therefore
	 * destroying it.
	 */
	BT_LOGD("Removing self from graph's connections: "
		"graph-addr=%p, conn-addr=%p", graph, connection);
	bt_graph_remove_connection(graph, connection);
}

static
void bt_connection_parent_is_owner(struct bt_object *obj)
{
	struct bt_connection *connection = container_of(obj,
			struct bt_connection, base);

	bt_connection_try_remove_from_graph(connection);
}

struct bt_connection *bt_connection_from_private_connection(
		struct bt_private_connection *private_connection)
{
	return bt_get(bt_connection_from_private(private_connection));
}

BT_HIDDEN
struct bt_connection *bt_connection_create(
		struct bt_graph *graph,
		struct bt_port *upstream_port,
		struct bt_port *downstream_port)
{
	struct bt_connection *connection = NULL;

	if (bt_port_get_type(upstream_port) != BT_PORT_TYPE_OUTPUT) {
		BT_LOGW_STR("Invalid parameter: upstream port is not an output port.");
		goto end;
	}
	if (bt_port_get_type(downstream_port) != BT_PORT_TYPE_INPUT) {
		BT_LOGW_STR("Invalid parameter: downstream port is not an input port.");
		goto end;
	}

	BT_LOGD("Creating connection: "
		"graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", "
		"downstream-port-addr=%p, downstream-port-name=\"%s\"",
		graph, upstream_port, bt_port_get_name(upstream_port),
		downstream_port, bt_port_get_name(downstream_port));
	connection = g_new0(struct bt_connection, 1);
	if (!connection) {
		BT_LOGE_STR("Failed to allocate one connection.");
		goto end;
	}

	bt_object_init(connection, bt_connection_destroy);
	bt_object_set_parent_is_owner_listener(connection,
		bt_connection_parent_is_owner);
	connection->iterators = g_ptr_array_new();
	if (!connection->iterators) {
		BT_LOGE_STR("Failed to allocate a GPtrArray.");
		BT_PUT(connection);
		goto end;
	}

	/* Weak references are taken, see comment in header. */
	connection->upstream_port = upstream_port;
	connection->downstream_port = downstream_port;
	BT_LOGD_STR("Setting upstream port's connection.");
	bt_port_set_connection(upstream_port, connection);
	BT_LOGD_STR("Setting downstream port's connection.");
	bt_port_set_connection(downstream_port, connection);
	bt_object_set_parent(connection, &graph->base);
	BT_LOGD("Created connection: "
		"graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", "
		"downstream-port-addr=%p, downstream-port-name=\"%s\", "
		"conn-addr=%p",
		graph, upstream_port, bt_port_get_name(upstream_port),
		downstream_port, bt_port_get_name(downstream_port),
		connection);

end:
	return connection;
}

BT_HIDDEN
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 = 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;
	}

	if (downstream_comp) {
		/* bt_component_port_disconnected() logs details */
		bt_component_port_disconnected(downstream_comp,
			downstream_port);
	}

	if (upstream_comp) {
		/* bt_component_port_disconnected() logs details */
		bt_component_port_disconnected(upstream_comp, upstream_port);
	}

	assert(graph);
	/* bt_graph_notify_ports_disconnected() logs details */
	bt_graph_notify_ports_disconnected(graph, upstream_comp,
		downstream_comp, upstream_port, downstream_port);
	bt_put(downstream_comp);
	bt_put(upstream_comp);

	/*
	 * Because this connection is ended, finalize (cancel) each
	 * notification iterator created from it.
	 */
	for (i = 0; i < conn->iterators->len; i++) {
		struct bt_notification_iterator *iterator =
			g_ptr_array_index(conn->iterators, i);

		BT_LOGD("Finalizing notification iterator created by this ended connection: "
			"conn-addr=%p, iter-addr=%p", conn, 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_set_size(conn->iterators, 0);

	if (try_remove_from_graph) {
		bt_connection_try_remove_from_graph(conn);
	}
}

struct bt_port *bt_connection_get_upstream_port(
		struct bt_connection *connection)
{
	return connection ? bt_get(connection->upstream_port) : NULL;
}

struct bt_port *bt_connection_get_downstream_port(
		struct bt_connection *connection)
{
	return connection ? bt_get(connection->downstream_port) : NULL;
}

enum bt_connection_status
bt_private_connection_create_notification_iterator(
		struct bt_private_connection *private_connection,
		const enum bt_notification_type *notification_types,
		struct bt_notification_iterator **user_iterator)
{
	enum bt_component_class_type upstream_comp_class_type;
	struct bt_notification_iterator *iterator = NULL;
	struct bt_port *upstream_port = NULL;
	struct bt_component *upstream_component = NULL;
	struct bt_component_class *upstream_comp_class = NULL;
	struct bt_connection *connection = NULL;
	bt_component_class_notification_iterator_init_method init_method = NULL;
	enum bt_connection_status status;
	static const enum bt_notification_type all_notif_types[] = {
		BT_NOTIFICATION_TYPE_ALL,
		BT_NOTIFICATION_TYPE_SENTINEL,
	};

	if (!private_connection) {
		BT_LOGW_STR("Invalid parameter: private connection is NULL.");
		status = BT_CONNECTION_STATUS_INVALID;
		goto end;
	}

	if (!user_iterator) {
		BT_LOGW_STR("Invalid parameter: notification iterator pointer is NULL.");
		status = BT_CONNECTION_STATUS_INVALID;
		goto end;
	}

	connection = bt_connection_from_private(private_connection);

	if (bt_graph_is_canceled(bt_connection_borrow_graph(connection))) {
		BT_LOGW("Cannot create notification iterator from connection: "
			"connection's graph is canceled: "
			"conn-addr=%p, upstream-port-addr=%p, "
			"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
			"upstream-comp-name=\"%s\", graph-addr=%p",
			connection, connection->upstream_port,
			bt_port_get_name(connection->upstream_port),
			upstream_component,
			bt_component_get_name(upstream_component),
			bt_connection_borrow_graph(connection));
		status = BT_CONNECTION_STATUS_GRAPH_IS_CANCELED;
		goto end;
	}

	if (bt_connection_is_ended(connection)) {
		BT_LOGW("Invalid parameter: connection is ended: "
			"conn-addr=%p", connection);
		status = BT_CONNECTION_STATUS_IS_ENDED;
		goto end;
	}

	if (!notification_types) {
		BT_LOGD_STR("No notification types: subscribing to all notifications.");
		notification_types = all_notif_types;
	}

	upstream_port = connection->upstream_port;
	assert(upstream_port);
	upstream_component = bt_port_get_component(upstream_port);
	assert(upstream_component);
	upstream_comp_class = upstream_component->class;
	BT_LOGD("Creating notification iterator from connection: "
		"conn-addr=%p, upstream-port-addr=%p, "
		"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
		"upstream-comp-name=\"%s\"",
		connection, connection->upstream_port,
		bt_port_get_name(connection->upstream_port),
		upstream_component, bt_component_get_name(upstream_component));
	upstream_comp_class_type =
		bt_component_get_class_type(upstream_component);
	assert(upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_SOURCE ||
			upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_FILTER);
	status = bt_notification_iterator_create(upstream_component,
		upstream_port, notification_types, connection, &iterator);
	if (status != BT_CONNECTION_STATUS_OK) {
		BT_LOGW("Cannot create notification iterator from connection.");
		goto end;
	}

	switch (upstream_comp_class_type) {
	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	{
		struct bt_component_class_source *source_class =
			container_of(upstream_comp_class,
				struct bt_component_class_source, parent);
		init_method = source_class->methods.iterator.init;
		break;
	}
	case BT_COMPONENT_CLASS_TYPE_FILTER:
	{
		struct bt_component_class_filter *filter_class =
			container_of(upstream_comp_class,
				struct bt_component_class_filter, parent);
		init_method = filter_class->methods.iterator.init;
		break;
	}
	default:
		/* Unreachable. */
		BT_LOGF("Unknown component class type: type=%d",
			upstream_comp_class_type);
		abort();
	}

	if (init_method) {
		enum bt_notification_iterator_status iter_status;

		BT_LOGD("Calling user's initialization method: iter-addr=%p",
			iterator);
		iter_status = init_method(
			bt_private_notification_iterator_from_notification_iterator(iterator),
			bt_private_port_from_port(upstream_port));
		BT_LOGD("User method returned: status=%s",
			bt_notification_iterator_status_string(iter_status));
		if (iter_status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
			BT_LOGW_STR("Initialization method failed.");
			status = bt_connection_status_from_notification_iterator_status(
				iter_status);
			goto end;
		}
	}

	iterator->state = BT_NOTIFICATION_ITERATOR_STATE_ACTIVE;
	g_ptr_array_add(connection->iterators, iterator);
	BT_LOGD("Created notification iterator from connection: "
		"conn-addr=%p, upstream-port-addr=%p, "
		"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
		"upstream-comp-name=\"%s\", iter-addr=%p",
		connection, connection->upstream_port,
		bt_port_get_name(connection->upstream_port),
		upstream_component, bt_component_get_name(upstream_component),
		iterator);

	/* Move reference to user */
	*user_iterator = iterator;
	iterator = NULL;

end:
	bt_put(upstream_component);
	bt_put(iterator);
	return status;
}

BT_HIDDEN
void bt_connection_remove_iterator(struct bt_connection *conn,
		struct bt_notification_iterator *iterator)
{
	g_ptr_array_remove(conn->iterators, iterator);
	BT_LOGV("Removed notification iterator from connection: "
		"conn-addr=%p, iter-addr=%p", conn, iterator);
	bt_connection_try_remove_from_graph(conn);
}

bt_bool bt_connection_is_ended(struct bt_connection *connection)
{
	return !connection->downstream_port && !connection->upstream_port;
}
Commit	Line	Data
784cdc68	1	/*
7d55361f	2	* connection.c
784cdc68 JG	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
a36bfb16 PP	29	#define BT_LOG_TAG "CONNECTION"
	30	#include <babeltrace/lib-logging-internal.h>
	31
b2e0c907 PP	32	#include <babeltrace/graph/notification-iterator-internal.h>
	33	#include <babeltrace/graph/component-internal.h>
	34	#include <babeltrace/graph/component-source-internal.h>
	35	#include <babeltrace/graph/component-filter-internal.h>
	36	#include <babeltrace/graph/connection-internal.h>
	37	#include <babeltrace/graph/private-connection.h>
	38	#include <babeltrace/graph/graph-internal.h>
	39	#include <babeltrace/graph/port-internal.h>
784cdc68	40	#include <babeltrace/object-internal.h>
3d9990ac	41	#include <babeltrace/compiler-internal.h>
0fbb9a9f	42	#include <stdlib.h>
784cdc68 JG	43	#include <glib.h>
	44
	45	static
	46	void bt_connection_destroy(struct bt_object *obj)
	47	{
	48	struct bt_connection *connection = container_of(obj,
	49	struct bt_connection, base);
bd14d768	50
a36bfb16 PP	51	BT_LOGD("Destroying connection: addr=%p", connection);
a36bfb16 PP	52
bd14d768 PP	53	/*
	54	* Make sure that each notification iterator which was created
	55	* for this connection is finalized before we destroy it. Once a
	56	* notification iterator is finalized, all its method return
	57	* NULL or the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED status.
	58	*
	59	* Because connections are destroyed before components within a
	60	* graph, this ensures that notification iterators are always
	61	* finalized before their upstream component.
c42ea0af PP	62	*
	63	* Ending the connection does exactly this. We pass `false` to
	64	* bt_connection_end() here to avoid removing this connection
	65	* from the graph: if we're here, we're already in the graph's
	66	* destructor.
bd14d768	67	*/
c42ea0af PP	68	bt_connection_end(connection, false);
c42ea0af PP	69	g_ptr_array_free(connection->iterators, TRUE);
784cdc68 JG	70
784cdc68 JG	71	/*
c42ea0af PP	72	* No bt_put on ports as a connection only holds _weak_
c42ea0af PP	73	* references to them.
784cdc68 JG	74	*/
	75	g_free(connection);
	76	}
	77
f167d3c0 PP	78	static
	79	void bt_connection_try_remove_from_graph(struct bt_connection *connection)
	80	{
	81	void *graph = bt_object_borrow_parent(&connection->base);
	82
	83	if (connection->base.ref_count.count > 0 \|\|
	84	connection->downstream_port \|\|
	85	connection->upstream_port \|\|
	86	connection->iterators->len > 0) {
	87	return;
	88	}
	89
	90	/*
	91	* At this point we know that:
	92	*
a36bfb16	93	* 1. The connection is ended (ports were disconnected).
f167d3c0 PP	94	* 2. All the notification iterators that this connection
	95	* created, if any, are finalized.
	96	* 3. The connection's reference count is 0, so only the
	97	* parent (graph) owns this connection after this call.
	98	*
	99	* In other words, no other object than the graph knows this
	100	* connection.
	101	*
	102	* It is safe to remove the connection from the graph, therefore
	103	* destroying it.
	104	*/
a36bfb16 PP	105	BT_LOGD("Removing self from graph's connections: "
a36bfb16 PP	106	"graph-addr=%p, conn-addr=%p", graph, connection);
f167d3c0 PP	107	bt_graph_remove_connection(graph, connection);
	108	}
	109
	110	static
	111	void bt_connection_parent_is_owner(struct bt_object *obj)
	112	{
	113	struct bt_connection *connection = container_of(obj,
	114	struct bt_connection, base);
	115
	116	bt_connection_try_remove_from_graph(connection);
	117	}
	118
890882ef PP	119	struct bt_connection *bt_connection_from_private_connection(
	120	struct bt_private_connection *private_connection)
	121	{
	122	return bt_get(bt_connection_from_private(private_connection));
	123	}
	124
784cdc68 JG	125	BT_HIDDEN
	126	struct bt_connection *bt_connection_create(
	127	struct bt_graph *graph,
72b913fb PP	128	struct bt_port *upstream_port,
72b913fb PP	129	struct bt_port *downstream_port)
784cdc68 JG	130	{
	131	struct bt_connection *connection = NULL;
	132
72b913fb	133	if (bt_port_get_type(upstream_port) != BT_PORT_TYPE_OUTPUT) {
a36bfb16	134	BT_LOGW_STR("Invalid parameter: upstream port is not an output port.");
784cdc68 JG	135	goto end;
784cdc68 JG	136	}
72b913fb	137	if (bt_port_get_type(downstream_port) != BT_PORT_TYPE_INPUT) {
a36bfb16	138	BT_LOGW_STR("Invalid parameter: downstream port is not an input port.");
784cdc68 JG	139	goto end;
	140	}
	141
a36bfb16 PP	142	BT_LOGD("Creating connection: "
	143	"graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", "
	144	"downstream-port-addr=%p, downstream-port-name=\"%s\"",
	145	graph, upstream_port, bt_port_get_name(upstream_port),
	146	downstream_port, bt_port_get_name(downstream_port));
784cdc68 JG	147	connection = g_new0(struct bt_connection, 1);
784cdc68 JG	148	if (!connection) {
a36bfb16	149	BT_LOGE_STR("Failed to allocate one connection.");
784cdc68 JG	150	goto end;
	151	}
	152
	153	bt_object_init(connection, bt_connection_destroy);
f167d3c0 PP	154	bt_object_set_parent_is_owner_listener(connection,
f167d3c0 PP	155	bt_connection_parent_is_owner);
bd14d768 PP	156	connection->iterators = g_ptr_array_new();
bd14d768 PP	157	if (!connection->iterators) {
a36bfb16	158	BT_LOGE_STR("Failed to allocate a GPtrArray.");
bd14d768 PP	159	BT_PUT(connection);
	160	goto end;
	161	}
	162
784cdc68	163	/* Weak references are taken, see comment in header. */
72b913fb PP	164	connection->upstream_port = upstream_port;
72b913fb PP	165	connection->downstream_port = downstream_port;
a36bfb16	166	BT_LOGD_STR("Setting upstream port's connection.");
72b913fb	167	bt_port_set_connection(upstream_port, connection);
a36bfb16	168	BT_LOGD_STR("Setting downstream port's connection.");
72b913fb	169	bt_port_set_connection(downstream_port, connection);
784cdc68	170	bt_object_set_parent(connection, &graph->base);
a36bfb16 PP	171	BT_LOGD("Created connection: "
	172	"graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", "
	173	"downstream-port-addr=%p, downstream-port-name=\"%s\", "
	174	"conn-addr=%p",
	175	graph, upstream_port, bt_port_get_name(upstream_port),
	176	downstream_port, bt_port_get_name(downstream_port),
	177	connection);
	178
784cdc68 JG	179	end:
	180	return connection;
	181	}
	182
72b913fb	183	BT_HIDDEN
c42ea0af PP	184	void bt_connection_end(struct bt_connection *conn,
c42ea0af PP	185	bool try_remove_from_graph)
72b913fb PP	186	{
	187	struct bt_component *downstream_comp = NULL;
	188	struct bt_component *upstream_comp = NULL;
	189	struct bt_port *downstream_port = conn->downstream_port;
	190	struct bt_port *upstream_port = conn->upstream_port;
c42ea0af	191	struct bt_graph *graph = bt_connection_borrow_graph(conn);
f167d3c0	192	size_t i;
72b913fb	193
c42ea0af PP	194	BT_LOGD("Ending connection: conn-addr=%p, try-remove-from-graph=%d",
	195	conn, try_remove_from_graph);
	196
72b913fb	197	if (downstream_port) {
c42ea0af PP	198	BT_LOGD("Disconnecting connection's downstream port: "
	199	"port-addr=%p, port-name=\"%s\"",
	200	downstream_port, bt_port_get_name(downstream_port));
72b913fb PP	201	downstream_comp = bt_port_get_component(downstream_port);
	202	bt_port_set_connection(downstream_port, NULL);
	203	conn->downstream_port = NULL;
	204	}
	205
	206	if (upstream_port) {
c42ea0af PP	207	BT_LOGD("Disconnecting connection's upstream port: "
	208	"port-addr=%p, port-name=\"%s\"",
	209	upstream_port, bt_port_get_name(upstream_port));
72b913fb PP	210	upstream_comp = bt_port_get_component(upstream_port);
	211	bt_port_set_connection(upstream_port, NULL);
	212	conn->upstream_port = NULL;
	213	}
	214
2038affb	215	if (downstream_comp) {
a36bfb16	216	/* bt_component_port_disconnected() logs details */
72b913fb PP	217	bt_component_port_disconnected(downstream_comp,
	218	downstream_port);
	219	}
	220
2038affb	221	if (upstream_comp) {
a36bfb16	222	/* bt_component_port_disconnected() logs details */
72b913fb PP	223	bt_component_port_disconnected(upstream_comp, upstream_port);
	224	}
	225
f345f8bb	226	assert(graph);
a36bfb16	227	/* bt_graph_notify_ports_disconnected() logs details */
f345f8bb PP	228	bt_graph_notify_ports_disconnected(graph, upstream_comp,
f345f8bb PP	229	downstream_comp, upstream_port, downstream_port);
72b913fb PP	230	bt_put(downstream_comp);
72b913fb PP	231	bt_put(upstream_comp);
f167d3c0 PP	232
f167d3c0 PP	233	/*
a36bfb16	234	* Because this connection is ended, finalize (cancel) each
f167d3c0 PP	235	* notification iterator created from it.
	236	*/
	237	for (i = 0; i < conn->iterators->len; i++) {
	238	struct bt_notification_iterator *iterator =
	239	g_ptr_array_index(conn->iterators, i);
	240
a36bfb16 PP	241	BT_LOGD("Finalizing notification iterator created by this ended connection: "
a36bfb16 PP	242	"conn-addr=%p, iter-addr=%p", conn, iterator);
f167d3c0 PP	243	bt_notification_iterator_finalize(iterator);
	244
	245	/*
	246	* Make sure this iterator does not try to remove itself
	247	* from this connection's iterators on destruction
	248	* because this connection won't exist anymore.
	249	*/
	250	bt_notification_iterator_set_connection(iterator,
	251	NULL);
	252	}
	253
	254	g_ptr_array_set_size(conn->iterators, 0);
c42ea0af PP	255
	256	if (try_remove_from_graph) {
	257	bt_connection_try_remove_from_graph(conn);
	258	}
72b913fb PP	259	}
	260
	261	struct bt_port *bt_connection_get_upstream_port(
784cdc68 JG	262	struct bt_connection *connection)
784cdc68 JG	263	{
72b913fb	264	return connection ? bt_get(connection->upstream_port) : NULL;
784cdc68 JG	265	}
784cdc68 JG	266
72b913fb	267	struct bt_port *bt_connection_get_downstream_port(
784cdc68 JG	268	struct bt_connection *connection)
784cdc68 JG	269	{
72b913fb	270	return connection ? bt_get(connection->downstream_port) : NULL;
784cdc68 JG	271	}
784cdc68 JG	272
73d5c1ad	273	enum bt_connection_status
890882ef	274	bt_private_connection_create_notification_iterator(
fa054faf	275	struct bt_private_connection *private_connection,
73d5c1ad PP	276	const enum bt_notification_type *notification_types,
73d5c1ad PP	277	struct bt_notification_iterator **user_iterator)
784cdc68	278	{
890882ef PP	279	enum bt_component_class_type upstream_comp_class_type;
	280	struct bt_notification_iterator *iterator = NULL;
	281	struct bt_port *upstream_port = NULL;
784cdc68	282	struct bt_component *upstream_component = NULL;
890882ef PP	283	struct bt_component_class *upstream_comp_class = NULL;
	284	struct bt_connection *connection = NULL;
	285	bt_component_class_notification_iterator_init_method init_method = NULL;
73d5c1ad	286	enum bt_connection_status status;
fa054faf PP	287	static const enum bt_notification_type all_notif_types[] = {
	288	BT_NOTIFICATION_TYPE_ALL,
	289	BT_NOTIFICATION_TYPE_SENTINEL,
	290	};
784cdc68	291
890882ef	292	if (!private_connection) {
a36bfb16	293	BT_LOGW_STR("Invalid parameter: private connection is NULL.");
73d5c1ad PP	294	status = BT_CONNECTION_STATUS_INVALID;
	295	goto end;
	296	}
	297
	298	if (!user_iterator) {
	299	BT_LOGW_STR("Invalid parameter: notification iterator pointer is NULL.");
	300	status = BT_CONNECTION_STATUS_INVALID;
	301	goto end;
784cdc68 JG	302	}
784cdc68 JG	303
c28d097c PP	304	connection = bt_connection_from_private(private_connection);
	305
	306	if (bt_graph_is_canceled(bt_connection_borrow_graph(connection))) {
	307	BT_LOGW("Cannot create notification iterator from connection: "
	308	"connection's graph is canceled: "
	309	"conn-addr=%p, upstream-port-addr=%p, "
	310	"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
	311	"upstream-comp-name=\"%s\", graph-addr=%p",
	312	connection, connection->upstream_port,
	313	bt_port_get_name(connection->upstream_port),
	314	upstream_component,
	315	bt_component_get_name(upstream_component),
	316	bt_connection_borrow_graph(connection));
	317	status = BT_CONNECTION_STATUS_GRAPH_IS_CANCELED;
	318	goto end;
fa054faf PP	319	}
fa054faf PP	320
73d5c1ad	321	if (bt_connection_is_ended(connection)) {
a36bfb16 PP	322	BT_LOGW("Invalid parameter: connection is ended: "
a36bfb16 PP	323	"conn-addr=%p", connection);
73d5c1ad PP	324	status = BT_CONNECTION_STATUS_IS_ENDED;
73d5c1ad PP	325	goto end;
72b913fb PP	326	}
72b913fb PP	327
c28d097c PP	328	if (!notification_types) {
	329	BT_LOGD_STR("No notification types: subscribing to all notifications.");
	330	notification_types = all_notif_types;
	331	}
	332
890882ef PP	333	upstream_port = connection->upstream_port;
	334	assert(upstream_port);
	335	upstream_component = bt_port_get_component(upstream_port);
784cdc68	336	assert(upstream_component);
890882ef	337	upstream_comp_class = upstream_component->class;
a36bfb16 PP	338	BT_LOGD("Creating notification iterator from connection: "
	339	"conn-addr=%p, upstream-port-addr=%p, "
	340	"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
	341	"upstream-comp-name=\"%s\"",
	342	connection, connection->upstream_port,
	343	bt_port_get_name(connection->upstream_port),
	344	upstream_component, bt_component_get_name(upstream_component));
890882ef PP	345	upstream_comp_class_type =
890882ef PP	346	bt_component_get_class_type(upstream_component);
73d5c1ad PP	347	assert(upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_SOURCE \|\|
	348	upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_FILTER);
	349	status = bt_notification_iterator_create(upstream_component,
	350	upstream_port, notification_types, connection, &iterator);
	351	if (status != BT_CONNECTION_STATUS_OK) {
a36bfb16	352	BT_LOGW("Cannot create notification iterator from connection.");
73d5c1ad	353	goto end;
890882ef PP	354	}
	355
	356	switch (upstream_comp_class_type) {
784cdc68	357	case BT_COMPONENT_CLASS_TYPE_SOURCE:
890882ef PP	358	{
	359	struct bt_component_class_source *source_class =
	360	container_of(upstream_comp_class,
	361	struct bt_component_class_source, parent);
	362	init_method = source_class->methods.iterator.init;
784cdc68	363	break;
890882ef	364	}
784cdc68	365	case BT_COMPONENT_CLASS_TYPE_FILTER:
890882ef PP	366	{
	367	struct bt_component_class_filter *filter_class =
	368	container_of(upstream_comp_class,
	369	struct bt_component_class_filter, parent);
	370	init_method = filter_class->methods.iterator.init;
784cdc68	371	break;
890882ef	372	}
784cdc68	373	default:
890882ef	374	/* Unreachable. */
73d5c1ad PP	375	BT_LOGF("Unknown component class type: type=%d",
73d5c1ad PP	376	upstream_comp_class_type);
0fbb9a9f	377	abort();
890882ef PP	378	}
	379
	380	if (init_method) {
73d5c1ad	381	enum bt_notification_iterator_status iter_status;
a36bfb16 PP	382
	383	BT_LOGD("Calling user's initialization method: iter-addr=%p",
	384	iterator);
73d5c1ad	385	iter_status = init_method(
91457551 PP	386	bt_private_notification_iterator_from_notification_iterator(iterator),
91457551 PP	387	bt_private_port_from_port(upstream_port));
a36bfb16	388	BT_LOGD("User method returned: status=%s",
73d5c1ad PP	389	bt_notification_iterator_status_string(iter_status));
73d5c1ad PP	390	if (iter_status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
a36bfb16	391	BT_LOGW_STR("Initialization method failed.");
73d5c1ad PP	392	status = bt_connection_status_from_notification_iterator_status(
	393	iter_status);
	394	goto end;
890882ef PP	395	}
	396	}
	397
088d4023	398	iterator->state = BT_NOTIFICATION_ITERATOR_STATE_ACTIVE;
bd14d768	399	g_ptr_array_add(connection->iterators, iterator);
a36bfb16 PP	400	BT_LOGD("Created notification iterator from connection: "
	401	"conn-addr=%p, upstream-port-addr=%p, "
	402	"upstream-port-name=\"%s\", upstream-comp-addr=%p, "
	403	"upstream-comp-name=\"%s\", iter-addr=%p",
	404	connection, connection->upstream_port,
	405	bt_port_get_name(connection->upstream_port),
	406	upstream_component, bt_component_get_name(upstream_component),
	407	iterator);
1a6a376a PP	408
	409	/* Move reference to user */
	410	*user_iterator = iterator;
	411	iterator = NULL;
890882ef	412
784cdc68 JG	413	end:
784cdc68 JG	414	bt_put(upstream_component);
73d5c1ad PP	415	bt_put(iterator);
73d5c1ad PP	416	return status;
784cdc68	417	}
bd14d768 PP	418
	419	BT_HIDDEN
	420	void bt_connection_remove_iterator(struct bt_connection *conn,
	421	struct bt_notification_iterator *iterator)
	422	{
	423	g_ptr_array_remove(conn->iterators, iterator);
a36bfb16 PP	424	BT_LOGV("Removed notification iterator from connection: "
a36bfb16 PP	425	"conn-addr=%p, iter-addr=%p", conn, iterator);
f167d3c0	426	bt_connection_try_remove_from_graph(conn);
bd14d768	427	}
090a4c0a PP	428
	429	bt_bool bt_connection_is_ended(struct bt_connection *connection)
	430	{
	431	return !connection->downstream_port && !connection->upstream_port;
	432	}