[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 <babeltrace/assert-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_borrow_from_private(
		struct bt_private_connection *private_connection)
{
	return (void *) 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);
	}

	BT_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_private_connection *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_private_connection_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_private_connection_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,
		struct bt_notification_iterator **user_iterator)
{
	enum bt_component_class_type upstream_comp_class_type;
	struct bt_notification_iterator_private_connection *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;

	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_borrow_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;
	}

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