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

/*
 * component.c
 *
 * Babeltrace Plugin Component
 *
 * Copyright 2015 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.
 */

#include <babeltrace/graph/private-component.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/component-internal.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/graph/component-source-internal.h>
#include <babeltrace/graph/component-filter-internal.h>
#include <babeltrace/graph/component-sink-internal.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/graph/connection-internal.h>
#include <babeltrace/graph/graph-internal.h>
#include <babeltrace/graph/notification-iterator-internal.h>
#include <babeltrace/graph/private-notification-iterator.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/types.h>
#include <stdint.h>

static
struct bt_component * (* const component_create_funcs[])(
		struct bt_component_class *, struct bt_value *) = {
	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create,
	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create,
	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create,
};

static
void (*component_destroy_funcs[])(struct bt_component *) = {
	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_destroy,
	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_destroy,
	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_destroy,
};

static
enum bt_component_status (* const component_validation_funcs[])(
		struct bt_component *) = {
	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_validate,
	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_validate,
	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_validate,
};

static
void bt_component_destroy(struct bt_object *obj)
{
	struct bt_component *component = NULL;
	struct bt_component_class *component_class = NULL;
	int i;

	if (!obj) {
		return;
	}

	/*
	 * The component's reference count is 0 if we're here. Increment
	 * it to avoid a double-destroy (possibly infinitely recursive).
	 * This could happen for example if the component's finalization
	 * function does bt_get() (or anything that causes bt_get() to
	 * be called) on itself (ref. count goes from 0 to 1), and then
	 * bt_put(): the reference count would go from 1 to 0 again and
	 * this function would be called again.
	 */
	obj->ref_count.count++;
	component = container_of(obj, struct bt_component, base);

	/* Call destroy listeners in reverse registration order */
	for (i = component->destroy_listeners->len - 1; i >= 0; i--) {
		struct bt_component_destroy_listener *listener =
			&g_array_index(component->destroy_listeners,
				struct bt_component_destroy_listener, i);

		listener->func(component, listener->data);
	}

	component_class = component->class;

	/*
	 * User data is destroyed first, followed by the concrete component
	 * instance.
	 */
	if (component->class->methods.finalize) {
		component->class->methods.finalize(
			bt_private_component_from_component(component));
	}

	if (component->destroy) {
		component->destroy(component);
	}

	if (component->input_ports) {
		g_ptr_array_free(component->input_ports, TRUE);
	}

	if (component->output_ports) {
		g_ptr_array_free(component->output_ports, TRUE);
	}

	if (component->destroy_listeners) {
		g_array_free(component->destroy_listeners, TRUE);
	}

	g_string_free(component->name, TRUE);
	bt_put(component_class);
	g_free(component);
}

struct bt_component *bt_component_from_private_component(
		struct bt_private_component *private_component)
{
	return bt_get(bt_component_from_private(private_component));
}

enum bt_component_class_type bt_component_get_class_type(
		struct bt_component *component)
{
	return component ? component->class->type : BT_COMPONENT_CLASS_TYPE_UNKNOWN;
}

static
struct bt_port *bt_component_add_port(
		struct bt_component *component, GPtrArray *ports,
		enum bt_port_type port_type, const char *name, void *user_data)
{
	size_t i;
	struct bt_port *new_port = NULL;
	struct bt_graph *graph = NULL;

	if (!name || strlen(name) == 0) {
		goto end;
	}

	/* Look for a port having the same name. */
	for (i = 0; i < ports->len; i++) {
		const char *port_name;
		struct bt_port *port = g_ptr_array_index(
				ports, i);

		port_name = bt_port_get_name(port);
		if (!port_name) {
			continue;
		}

		if (!strcmp(name, port_name)) {
			/* Port name clash, abort. */
			goto end;
		}
	}

	new_port = bt_port_create(component, port_type, name, user_data);
	if (!new_port) {
		goto end;
	}

	/*
	 * No name clash, add the port.
	 * The component is now the port's parent; it should _not_
	 * hold a reference to the port since the port's lifetime
	 * is now protected by the component's own lifetime.
	 */
	g_ptr_array_add(ports, new_port);

	/*
	 * Notify the graph's creator that a new port was added.
	 */
	graph = bt_component_get_graph(component);
	if (graph) {
		bt_graph_notify_port_added(graph, new_port);
		BT_PUT(graph);
	}

end:
	return new_port;
}

BT_HIDDEN
int64_t bt_component_get_input_port_count(struct bt_component *comp)
{
	assert(comp);
	return (int64_t) comp->input_ports->len;
}

BT_HIDDEN
int64_t bt_component_get_output_port_count(struct bt_component *comp)
{
	assert(comp);
	return (int64_t) comp->output_ports->len;
}

struct bt_component *bt_component_create_with_init_method_data(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params, void *init_method_data)
{
	int ret;
	struct bt_component *component = NULL;
	enum bt_component_class_type type;

	bt_get(params);

	if (!component_class) {
		goto end;
	}

	type = bt_component_class_get_type(component_class);
	if (type <= BT_COMPONENT_CLASS_TYPE_UNKNOWN ||
			type > BT_COMPONENT_CLASS_TYPE_FILTER) {
		goto end;
	}

	/*
	 * Parameters must be a map value, but we create a convenient
	 * empty one if it's NULL.
	 */
	if (params) {
		if (!bt_value_is_map(params)) {
			goto end;
		}
	} else {
		params = bt_value_map_create();
		if (!params) {
			goto end;
		}
	}

	component = component_create_funcs[type](component_class, params);
	if (!component) {
		goto end;
	}

	bt_object_init(component, bt_component_destroy);
	component->class = bt_get(component_class);
	component->destroy = component_destroy_funcs[type];
	component->name = g_string_new(name);
	if (!component->name) {
		BT_PUT(component);
		goto end;
	}

	component->input_ports = g_ptr_array_new_with_free_func(
		bt_object_release);
	if (!component->input_ports) {
		BT_PUT(component);
		goto end;
	}

	component->output_ports = g_ptr_array_new_with_free_func(
		bt_object_release);
	if (!component->output_ports) {
		BT_PUT(component);
		goto end;
	}

	component->destroy_listeners = g_array_new(FALSE, TRUE,
		sizeof(struct bt_component_destroy_listener));
	if (!component->destroy_listeners) {
		BT_PUT(component);
		goto end;
	}

	component->initializing = BT_TRUE;

	if (component_class->methods.init) {
		ret = component_class->methods.init(
			bt_private_component_from_component(component), params,
			init_method_data);
		component->initializing = BT_FALSE;
		if (ret != BT_COMPONENT_STATUS_OK) {
			BT_PUT(component);
			goto end;
		}
	}

	component->initializing = BT_FALSE;
	ret = component_validation_funcs[type](component);
	if (ret != BT_COMPONENT_STATUS_OK) {
		BT_PUT(component);
		goto end;
	}

	bt_component_class_freeze(component->class);
end:
	bt_put(params);
	return component;
}

struct bt_component *bt_component_create(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params)
{
	return bt_component_create_with_init_method_data(component_class, name,
		params, NULL);
}

const char *bt_component_get_name(struct bt_component *component)
{
	const char *ret = NULL;

	if (!component) {
		goto end;
	}

	ret = component->name->len == 0 ? NULL : component->name->str;
end:
	return ret;
}

struct bt_component_class *bt_component_get_class(
		struct bt_component *component)
{
	return component ? bt_get(component->class) : NULL;
}

void *bt_private_component_get_user_data(
		struct bt_private_component *private_component)
{
	struct bt_component *component =
		bt_component_from_private(private_component);

	return component ? component->user_data : NULL;
}

enum bt_component_status bt_private_component_set_user_data(
		struct bt_private_component *private_component,
		void *data)
{
	struct bt_component *component =
		bt_component_from_private(private_component);
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;

	if (!component || !component->initializing) {
		ret = BT_COMPONENT_STATUS_INVALID;
		goto end;
	}

	component->user_data = data;
end:
	return ret;
}

BT_HIDDEN
void bt_component_set_graph(struct bt_component *component,
		struct bt_graph *graph)
{
	struct bt_object *parent = bt_object_get_parent(&component->base);

	assert(!parent || parent == &graph->base);
	if (!parent) {
		bt_object_set_parent(component, &graph->base);
	}
	bt_put(parent);
}

struct bt_graph *bt_component_get_graph(
		struct bt_component *component)
{
	return (struct bt_graph *) bt_object_get_parent(&component->base);
}

static
struct bt_port *bt_component_get_port_by_name(GPtrArray *ports,
		const char *name)
{
	size_t i;
	struct bt_port *ret_port = NULL;

	assert(name);

	for (i = 0; i < ports->len; i++) {
		struct bt_port *port = g_ptr_array_index(ports, i);
		const char *port_name = bt_port_get_name(port);

		if (!port_name) {
			continue;
		}

		if (!strcmp(name, port_name)) {
			ret_port = bt_get(port);
			break;
		}
	}

	return ret_port;
}

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
		const char *name)
{
	assert(comp);

	return bt_component_get_port_by_name(comp->input_ports, name);
}

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
		const char *name)
{
	assert(comp);

	return bt_component_get_port_by_name(comp->output_ports, name);
}

static
struct bt_port *bt_component_get_port_by_index(GPtrArray *ports, uint64_t index)
{
	struct bt_port *port = NULL;

	if (index >= ports->len) {
		goto end;
	}

	port = bt_get(g_ptr_array_index(ports, index));
end:
	return port;
}

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
		uint64_t index)
{
	assert(comp);

	return bt_component_get_port_by_index(comp->input_ports, index);
}

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
		uint64_t index)
{
	assert(comp);

	return bt_component_get_port_by_index(comp->output_ports, index);
}

BT_HIDDEN
struct bt_port *bt_component_add_input_port(
		struct bt_component *component, const char *name,
		void *user_data)
{
	return bt_component_add_port(component, component->input_ports,
		BT_PORT_TYPE_INPUT, name, user_data);
}

BT_HIDDEN
struct bt_port *bt_component_add_output_port(
		struct bt_component *component, const char *name,
		void *user_data)
{
	return bt_component_add_port(component, component->output_ports,
		BT_PORT_TYPE_OUTPUT, name, user_data);
}

static
void bt_component_remove_port_by_index(struct bt_component *component,
		GPtrArray *ports, size_t index)
{
	struct bt_port *port;
	struct bt_graph *graph;

	assert(ports);
	assert(index < ports->len);
	port = g_ptr_array_index(ports, index);

	/* Disconnect both ports of this port's connection, if any */
	if (port->connection) {
		bt_connection_disconnect_ports(port->connection);
	}

	/* Remove from parent's array of ports (weak refs) */
	g_ptr_array_remove_index(ports, index);

	/* Detach port from its component parent */
	BT_PUT(port->base.parent);

	/*
	 * Notify the graph's creator that a port is removed.
	 */
	graph = bt_component_get_graph(component);
	if (graph) {
		bt_graph_notify_port_removed(graph, component, port);
		BT_PUT(graph);
	}
}

BT_HIDDEN
enum bt_component_status bt_component_remove_port(
		struct bt_component *component, struct bt_port *port)
{
	size_t i;
	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	GPtrArray *ports = NULL;

	if (!component || !port) {
		status = BT_COMPONENT_STATUS_INVALID;
		goto end;
	}

	if (bt_port_get_type(port) == BT_PORT_TYPE_INPUT) {
		ports = component->input_ports;
	} else if (bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT) {
		ports = component->output_ports;
	}

	assert(ports);

	for (i = 0; i < ports->len; i++) {
		struct bt_port *cur_port = g_ptr_array_index(ports, i);

		if (cur_port == port) {
			bt_component_remove_port_by_index(component,
				ports, i);
			goto end;
		}
	}

	status = BT_COMPONENT_STATUS_NOT_FOUND;
end:
	return status;
}

BT_HIDDEN
enum bt_component_status bt_component_accept_port_connection(
		struct bt_component *comp, struct bt_port *self_port,
		struct bt_port *other_port)
{
	enum bt_component_status status = BT_COMPONENT_STATUS_OK;

	assert(comp);
	assert(self_port);
	assert(other_port);

	if (comp->class->methods.accept_port_connection) {
		status = comp->class->methods.accept_port_connection(
			bt_private_component_from_component(comp),
			bt_private_port_from_port(self_port),
			other_port);
	}

	return status;
}

BT_HIDDEN
void bt_component_port_connected(struct bt_component *comp,
		struct bt_port *self_port, struct bt_port *other_port)
{
	assert(comp);
	assert(self_port);
	assert(other_port);

	if (comp->class->methods.port_connected) {
		comp->class->methods.port_connected(
			bt_private_component_from_component(comp),
			bt_private_port_from_port(self_port), other_port);
	}
}

BT_HIDDEN
void bt_component_port_disconnected(struct bt_component *comp,
		struct bt_port *port)
{
	assert(comp);
	assert(port);

	if (comp->class->methods.port_disconnected) {
		comp->class->methods.port_disconnected(
			bt_private_component_from_component(comp),
			bt_private_port_from_port(port));
	}
}

BT_HIDDEN
void bt_component_add_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data)
{
	struct bt_component_destroy_listener listener;

	assert(component);
	assert(func);
	listener.func = func;
	listener.data = data;
	g_array_append_val(component->destroy_listeners, listener);
}

BT_HIDDEN
void bt_component_remove_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data)
{
	size_t i;

	assert(component);
	assert(func);

	for (i = 0; i < component->destroy_listeners->len; i++) {
		struct bt_component_destroy_listener *listener =
			&g_array_index(component->destroy_listeners,
				struct bt_component_destroy_listener, i);

		if (listener->func == func && listener->data == data) {
			g_array_remove_index(component->destroy_listeners, i);
			i--;
		}
	}
}
Commit	Line	Data
de713ce0 JG	1	/*
	2	* component.c
	3	*
	4	* Babeltrace Plugin Component
	5	*
	6	* Copyright 2015 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
b2e0c907 PP	29	#include <babeltrace/graph/private-component.h>
	30	#include <babeltrace/graph/component.h>
	31	#include <babeltrace/graph/component-internal.h>
	32	#include <babeltrace/graph/component-class-internal.h>
	33	#include <babeltrace/graph/component-source-internal.h>
	34	#include <babeltrace/graph/component-filter-internal.h>
	35	#include <babeltrace/graph/component-sink-internal.h>
	36	#include <babeltrace/graph/private-connection.h>
	37	#include <babeltrace/graph/connection-internal.h>
	38	#include <babeltrace/graph/graph-internal.h>
	39	#include <babeltrace/graph/notification-iterator-internal.h>
	40	#include <babeltrace/graph/private-notification-iterator.h>
de713ce0	41	#include <babeltrace/babeltrace-internal.h>
3d9990ac	42	#include <babeltrace/compiler-internal.h>
b8a06801	43	#include <babeltrace/ref.h>
c55a9f58	44	#include <babeltrace/types.h>
9ac68eb1	45	#include <stdint.h>
de713ce0	46
7c7c0433 JG	47	static
	48	struct bt_component * (* const component_create_funcs[])(
	49	struct bt_component_class , struct bt_value ) = {
d3e4dcd8 PP	50	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create,
	51	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create,
	52	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create,
7c7c0433 JG	53	};
7c7c0433 JG	54
72b913fb PP	55	static
	56	void (component_destroy_funcs[])(struct bt_component ) = {
	57	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_destroy,
	58	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_destroy,
	59	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_destroy,
	60	};
	61
7c7c0433 JG	62	static
	63	enum bt_component_status (* const component_validation_funcs[])(
	64	struct bt_component *) = {
d3e4dcd8 PP	65	[BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_validate,
	66	[BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_validate,
	67	[BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_validate,
7c7c0433 JG	68	};
7c7c0433 JG	69
b8a06801 JG	70	static
	71	void bt_component_destroy(struct bt_object *obj)
	72	{
	73	struct bt_component *component = NULL;
	74	struct bt_component_class *component_class = NULL;
3230ee6b	75	int i;
b8a06801 JG	76
	77	if (!obj) {
	78	return;
	79	}
	80
bd14d768 PP	81	/*
	82	* The component's reference count is 0 if we're here. Increment
	83	* it to avoid a double-destroy (possibly infinitely recursive).
	84	* This could happen for example if the component's finalization
	85	* function does bt_get() (or anything that causes bt_get() to
	86	* be called) on itself (ref. count goes from 0 to 1), and then
	87	* bt_put(): the reference count would go from 1 to 0 again and
	88	* this function would be called again.
	89	*/
	90	obj->ref_count.count++;
b8a06801	91	component = container_of(obj, struct bt_component, base);
3230ee6b PP	92
	93	/* Call destroy listeners in reverse registration order */
	94	for (i = component->destroy_listeners->len - 1; i >= 0; i--) {
	95	struct bt_component_destroy_listener *listener =
	96	&g_array_index(component->destroy_listeners,
	97	struct bt_component_destroy_listener, i);
	98
	99	listener->func(component, listener->data);
	100	}
	101
7c7c0433 JG	102	component_class = component->class;
	103
	104	/*
b8a06801 JG	105	* User data is destroyed first, followed by the concrete component
	106	* instance.
	107	*/
64cadc66 PP	108	if (component->class->methods.finalize) {
64cadc66 PP	109	component->class->methods.finalize(
890882ef	110	bt_private_component_from_component(component));
7c7c0433	111	}
b8a06801	112
ab09f844 JG	113	if (component->destroy) {
	114	component->destroy(component);
	115	}
	116
72b913fb PP	117	if (component->input_ports) {
	118	g_ptr_array_free(component->input_ports, TRUE);
	119	}
b8a06801	120
72b913fb PP	121	if (component->output_ports) {
72b913fb PP	122	g_ptr_array_free(component->output_ports, TRUE);
b8a06801 JG	123	}
b8a06801 JG	124
3230ee6b PP	125	if (component->destroy_listeners) {
	126	g_array_free(component->destroy_listeners, TRUE);
	127	}
	128
72b913fb PP	129	g_string_free(component->name, TRUE);
	130	bt_put(component_class);
	131	g_free(component);
b8a06801	132	}
de713ce0	133
890882ef PP	134	struct bt_component *bt_component_from_private_component(
890882ef PP	135	struct bt_private_component *private_component)
38b48196	136	{
890882ef	137	return bt_get(bt_component_from_private(private_component));
38b48196 JG	138	}
38b48196 JG	139
890882ef PP	140	enum bt_component_class_type bt_component_get_class_type(
890882ef PP	141	struct bt_component *component)
5645cd95	142	{
890882ef	143	return component ? component->class->type : BT_COMPONENT_CLASS_TYPE_UNKNOWN;
5645cd95 JG	144	}
5645cd95 JG	145
72b913fb PP	146	static
	147	struct bt_port *bt_component_add_port(
	148	struct bt_component component, GPtrArray ports,
3e9b0023	149	enum bt_port_type port_type, const char name, void user_data)
72b913fb PP	150	{
	151	size_t i;
	152	struct bt_port *new_port = NULL;
1bf957a0	153	struct bt_graph *graph = NULL;
72b913fb PP	154
	155	if (!name \|\| strlen(name) == 0) {
	156	goto end;
	157	}
	158
	159	/* Look for a port having the same name. */
	160	for (i = 0; i < ports->len; i++) {
	161	const char *port_name;
	162	struct bt_port *port = g_ptr_array_index(
	163	ports, i);
	164
	165	port_name = bt_port_get_name(port);
	166	if (!port_name) {
	167	continue;
	168	}
	169
	170	if (!strcmp(name, port_name)) {
	171	/* Port name clash, abort. */
	172	goto end;
	173	}
	174	}
	175
3e9b0023	176	new_port = bt_port_create(component, port_type, name, user_data);
72b913fb PP	177	if (!new_port) {
	178	goto end;
	179	}
	180
	181	/*
	182	* No name clash, add the port.
	183	* The component is now the port's parent; it should _not_
	184	* hold a reference to the port since the port's lifetime
	185	* is now protected by the component's own lifetime.
	186	*/
	187	g_ptr_array_add(ports, new_port);
1bf957a0 PP	188
	189	/*
	190	* Notify the graph's creator that a new port was added.
	191	*/
	192	graph = bt_component_get_graph(component);
	193	if (graph) {
	194	bt_graph_notify_port_added(graph, new_port);
	195	BT_PUT(graph);
	196	}
	197
72b913fb PP	198	end:
	199	return new_port;
	200	}
	201
	202	BT_HIDDEN
544d0515	203	int64_t bt_component_get_input_port_count(struct bt_component *comp)
72b913fb PP	204	{
72b913fb PP	205	assert(comp);
9ac68eb1	206	return (int64_t) comp->input_ports->len;
72b913fb PP	207	}
	208
	209	BT_HIDDEN
544d0515	210	int64_t bt_component_get_output_port_count(struct bt_component *comp)
72b913fb PP	211	{
72b913fb PP	212	assert(comp);
9ac68eb1	213	return (int64_t) comp->output_ports->len;
72b913fb PP	214	}
72b913fb PP	215
6358c163	216	struct bt_component *bt_component_create_with_init_method_data(
7c7c0433	217	struct bt_component_class component_class, const char name,
6358c163	218	struct bt_value params, void init_method_data)
38b48196	219	{
7c7c0433	220	int ret;
38b48196	221	struct bt_component *component = NULL;
d3e4dcd8	222	enum bt_component_class_type type;
38b48196	223
0df078e5 PP	224	bt_get(params);
0df078e5 PP	225
38b48196 JG	226	if (!component_class) {
	227	goto end;
	228	}
	229
7c7c0433	230	type = bt_component_class_get_type(component_class);
d3e4dcd8 PP	231	if (type <= BT_COMPONENT_CLASS_TYPE_UNKNOWN \|\|
d3e4dcd8 PP	232	type > BT_COMPONENT_CLASS_TYPE_FILTER) {
7c7c0433 JG	233	goto end;
	234	}
	235
0df078e5 PP	236	/*
	237	* Parameters must be a map value, but we create a convenient
	238	* empty one if it's NULL.
	239	*/
	240	if (params) {
	241	if (!bt_value_is_map(params)) {
	242	goto end;
	243	}
	244	} else {
	245	params = bt_value_map_create();
	246	if (!params) {
	247	goto end;
	248	}
	249	}
	250
7c7c0433 JG	251	component = component_create_funcs[type](component_class, params);
	252	if (!component) {
	253	goto end;
	254	}
	255
	256	bt_object_init(component, bt_component_destroy);
72b913fb PP	257	component->class = bt_get(component_class);
72b913fb PP	258	component->destroy = component_destroy_funcs[type];
7c7c0433	259	component->name = g_string_new(name);
4b70dd83	260	if (!component->name) {
7c7c0433 JG	261	BT_PUT(component);
	262	goto end;
	263	}
	264
72b913fb PP	265	component->input_ports = g_ptr_array_new_with_free_func(
	266	bt_object_release);
	267	if (!component->input_ports) {
	268	BT_PUT(component);
	269	goto end;
	270	}
	271
	272	component->output_ports = g_ptr_array_new_with_free_func(
	273	bt_object_release);
	274	if (!component->output_ports) {
	275	BT_PUT(component);
	276	goto end;
	277	}
	278
3230ee6b PP	279	component->destroy_listeners = g_array_new(FALSE, TRUE,
	280	sizeof(struct bt_component_destroy_listener));
	281	if (!component->destroy_listeners) {
	282	BT_PUT(component);
	283	goto end;
	284	}
	285
c55a9f58	286	component->initializing = BT_TRUE;
72b913fb	287
d3e4dcd8	288	if (component_class->methods.init) {
890882ef PP	289	ret = component_class->methods.init(
890882ef PP	290	bt_private_component_from_component(component), params,
6358c163	291	init_method_data);
c55a9f58	292	component->initializing = BT_FALSE;
d3e4dcd8 PP	293	if (ret != BT_COMPONENT_STATUS_OK) {
	294	BT_PUT(component);
	295	goto end;
	296	}
528debdf	297	}
d3e4dcd8	298
c55a9f58	299	component->initializing = BT_FALSE;
7c7c0433	300	ret = component_validation_funcs[type](component);
692b38d2	301	if (ret != BT_COMPONENT_STATUS_OK) {
7c7c0433	302	BT_PUT(component);
38b48196 JG	303	goto end;
38b48196 JG	304	}
1e4d8103 PP	305
1e4d8103 PP	306	bt_component_class_freeze(component->class);
38b48196	307	end:
0df078e5	308	bt_put(params);
38b48196 JG	309	return component;
	310	}
	311
6358c163 PP	312	struct bt_component *bt_component_create(
	313	struct bt_component_class component_class, const char name,
	314	struct bt_value *params)
	315	{
	316	return bt_component_create_with_init_method_data(component_class, name,
	317	params, NULL);
	318	}
	319
de713ce0 JG	320	const char bt_component_get_name(struct bt_component component)
	321	{
	322	const char *ret = NULL;
	323
	324	if (!component) {
	325	goto end;
	326	}
	327
f1222e7d	328	ret = component->name->len == 0 ? NULL : component->name->str;
de713ce0 JG	329	end:
	330	return ret;
	331	}
	332
38b48196 JG	333	struct bt_component_class *bt_component_get_class(
38b48196 JG	334	struct bt_component *component)
de713ce0	335	{
38b48196	336	return component ? bt_get(component->class) : NULL;
de713ce0 JG	337	}
de713ce0 JG	338
890882ef PP	339	void *bt_private_component_get_user_data(
890882ef PP	340	struct bt_private_component *private_component)
de713ce0	341	{
890882ef PP	342	struct bt_component *component =
	343	bt_component_from_private(private_component);
	344
38b48196	345	return component ? component->user_data : NULL;
de713ce0 JG	346	}
de713ce0 JG	347
890882ef PP	348	enum bt_component_status bt_private_component_set_user_data(
890882ef PP	349	struct bt_private_component *private_component,
de713ce0 JG	350	void *data)
de713ce0 JG	351	{
890882ef PP	352	struct bt_component *component =
890882ef PP	353	bt_component_from_private(private_component);
de713ce0 JG	354	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
de713ce0 JG	355
fec2a9f2	356	if (!component \|\| !component->initializing) {
30d619df	357	ret = BT_COMPONENT_STATUS_INVALID;
de713ce0 JG	358	goto end;
	359	}
	360
	361	component->user_data = data;
	362	end:
	363	return ret;
	364	}
366e034f JG	365
366e034f JG	366	BT_HIDDEN
f60c8b34	367	void bt_component_set_graph(struct bt_component *component,
366e034f JG	368	struct bt_graph *graph)
366e034f JG	369	{
f60c8b34 JG	370	struct bt_object *parent = bt_object_get_parent(&component->base);
	371
	372	assert(!parent \|\| parent == &graph->base);
	373	if (!parent) {
	374	bt_object_set_parent(component, &graph->base);
	375	}
	376	bt_put(parent);
366e034f JG	377	}
	378
	379	struct bt_graph *bt_component_get_graph(
	380	struct bt_component *component)
	381	{
	382	return (struct bt_graph *) bt_object_get_parent(&component->base);
	383	}
	384
72b913fb	385	static
9ac68eb1 PP	386	struct bt_port bt_component_get_port_by_name(GPtrArray ports,
9ac68eb1 PP	387	const char *name)
366e034f JG	388	{
	389	size_t i;
	390	struct bt_port *ret_port = NULL;
	391
72b913fb PP	392	assert(name);
72b913fb PP	393
366e034f JG	394	for (i = 0; i < ports->len; i++) {
	395	struct bt_port *port = g_ptr_array_index(ports, i);
	396	const char *port_name = bt_port_get_name(port);
	397
	398	if (!port_name) {
	399	continue;
	400	}
	401
	402	if (!strcmp(name, port_name)) {
	403	ret_port = bt_get(port);
	404	break;
	405	}
	406	}
	407
	408	return ret_port;
	409	}
	410
	411	BT_HIDDEN
9ac68eb1	412	struct bt_port bt_component_get_input_port_by_name(struct bt_component comp,
72b913fb PP	413	const char *name)
	414	{
	415	assert(comp);
	416
9ac68eb1	417	return bt_component_get_port_by_name(comp->input_ports, name);
72b913fb PP	418	}
	419
	420	BT_HIDDEN
9ac68eb1	421	struct bt_port bt_component_get_output_port_by_name(struct bt_component comp,
72b913fb PP	422	const char *name)
	423	{
	424	assert(comp);
	425
9ac68eb1	426	return bt_component_get_port_by_name(comp->output_ports, name);
72b913fb PP	427	}
	428
	429	static
9ac68eb1	430	struct bt_port bt_component_get_port_by_index(GPtrArray ports, uint64_t index)
366e034f JG	431	{
	432	struct bt_port *port = NULL;
	433
9ac68eb1	434	if (index >= ports->len) {
366e034f JG	435	goto end;
	436	}
	437
	438	port = bt_get(g_ptr_array_index(ports, index));
	439	end:
	440	return port;
	441	}
	442
	443	BT_HIDDEN
9ac68eb1 PP	444	struct bt_port bt_component_get_input_port_by_index(struct bt_component comp,
9ac68eb1 PP	445	uint64_t index)
366e034f	446	{
72b913fb	447	assert(comp);
366e034f	448
9ac68eb1	449	return bt_component_get_port_by_index(comp->input_ports, index);
72b913fb	450	}
366e034f	451
72b913fb	452	BT_HIDDEN
9ac68eb1 PP	453	struct bt_port bt_component_get_output_port_by_index(struct bt_component comp,
9ac68eb1 PP	454	uint64_t index)
72b913fb PP	455	{
72b913fb PP	456	assert(comp);
366e034f	457
9ac68eb1	458	return bt_component_get_port_by_index(comp->output_ports, index);
72b913fb	459	}
366e034f	460
72b913fb PP	461	BT_HIDDEN
72b913fb PP	462	struct bt_port *bt_component_add_input_port(
3e9b0023 PP	463	struct bt_component component, const char name,
3e9b0023 PP	464	void *user_data)
72b913fb PP	465	{
72b913fb PP	466	return bt_component_add_port(component, component->input_ports,
3e9b0023	467	BT_PORT_TYPE_INPUT, name, user_data);
72b913fb	468	}
366e034f	469
72b913fb PP	470	BT_HIDDEN
72b913fb PP	471	struct bt_port *bt_component_add_output_port(
3e9b0023 PP	472	struct bt_component component, const char name,
3e9b0023 PP	473	void *user_data)
72b913fb PP	474	{
72b913fb PP	475	return bt_component_add_port(component, component->output_ports,
3e9b0023	476	BT_PORT_TYPE_OUTPUT, name, user_data);
72b913fb PP	477	}
	478
	479	static
9ac68eb1	480	void bt_component_remove_port_by_index(struct bt_component *component,
72b913fb PP	481	GPtrArray *ports, size_t index)
	482	{
	483	struct bt_port *port;
1bf957a0	484	struct bt_graph *graph;
72b913fb PP	485
	486	assert(ports);
	487	assert(index < ports->len);
	488	port = g_ptr_array_index(ports, index);
	489
	490	/* Disconnect both ports of this port's connection, if any */
	491	if (port->connection) {
2038affb	492	bt_connection_disconnect_ports(port->connection);
f60c8b34 JG	493	}
f60c8b34 JG	494
72b913fb PP	495	/* Remove from parent's array of ports (weak refs) */
	496	g_ptr_array_remove_index(ports, index);
	497
	498	/* Detach port from its component parent */
	499	BT_PUT(port->base.parent);
	500
1bf957a0 PP	501	/*
	502	* Notify the graph's creator that a port is removed.
	503	*/
	504	graph = bt_component_get_graph(component);
	505	if (graph) {
	506	bt_graph_notify_port_removed(graph, component, port);
	507	BT_PUT(graph);
	508	}
366e034f JG	509	}
	510
	511	BT_HIDDEN
	512	enum bt_component_status bt_component_remove_port(
72b913fb	513	struct bt_component component, struct bt_port port)
366e034f JG	514	{
	515	size_t i;
	516	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
72b913fb	517	GPtrArray *ports = NULL;
366e034f	518
72b913fb	519	if (!component \|\| !port) {
366e034f JG	520	status = BT_COMPONENT_STATUS_INVALID;
	521	goto end;
	522	}
	523
72b913fb PP	524	if (bt_port_get_type(port) == BT_PORT_TYPE_INPUT) {
	525	ports = component->input_ports;
	526	} else if (bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT) {
	527	ports = component->output_ports;
	528	}
366e034f	529
72b913fb	530	assert(ports);
366e034f	531
72b913fb PP	532	for (i = 0; i < ports->len; i++) {
	533	struct bt_port *cur_port = g_ptr_array_index(ports, i);
	534
	535	if (cur_port == port) {
9ac68eb1	536	bt_component_remove_port_by_index(component,
72b913fb	537	ports, i);
366e034f JG	538	goto end;
	539	}
	540	}
72b913fb	541
366e034f JG	542	status = BT_COMPONENT_STATUS_NOT_FOUND;
	543	end:
	544	return status;
	545	}
f60c8b34 JG	546
f60c8b34 JG	547	BT_HIDDEN
72b913fb	548	enum bt_component_status bt_component_accept_port_connection(
8f4799f7 PP	549	struct bt_component comp, struct bt_port self_port,
8f4799f7 PP	550	struct bt_port *other_port)
f60c8b34 JG	551	{
	552	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	553
72b913fb	554	assert(comp);
8f4799f7 PP	555	assert(self_port);
8f4799f7 PP	556	assert(other_port);
72b913fb PP	557
	558	if (comp->class->methods.accept_port_connection) {
	559	status = comp->class->methods.accept_port_connection(
890882ef	560	bt_private_component_from_component(comp),
8f4799f7 PP	561	bt_private_port_from_port(self_port),
8f4799f7 PP	562	other_port);
f60c8b34 JG	563	}
	564
	565	return status;
	566	}
72b913fb	567
0d8b4d8e PP	568	BT_HIDDEN
	569	void bt_component_port_connected(struct bt_component *comp,
	570	struct bt_port self_port, struct bt_port other_port)
	571	{
	572	assert(comp);
	573	assert(self_port);
	574	assert(other_port);
	575
	576	if (comp->class->methods.port_connected) {
	577	comp->class->methods.port_connected(
	578	bt_private_component_from_component(comp),
	579	bt_private_port_from_port(self_port), other_port);
	580	}
	581	}
	582
72b913fb PP	583	BT_HIDDEN
	584	void bt_component_port_disconnected(struct bt_component *comp,
	585	struct bt_port *port)
	586	{
	587	assert(comp);
	588	assert(port);
	589
	590	if (comp->class->methods.port_disconnected) {
890882ef PP	591	comp->class->methods.port_disconnected(
	592	bt_private_component_from_component(comp),
	593	bt_private_port_from_port(port));
72b913fb PP	594	}
72b913fb PP	595	}
3230ee6b PP	596
	597	BT_HIDDEN
	598	void bt_component_add_destroy_listener(struct bt_component *component,
	599	bt_component_destroy_listener_func func, void *data)
	600	{
	601	struct bt_component_destroy_listener listener;
	602
	603	assert(component);
	604	assert(func);
	605	listener.func = func;
	606	listener.data = data;
	607	g_array_append_val(component->destroy_listeners, listener);
	608	}
	609
	610	BT_HIDDEN
	611	void bt_component_remove_destroy_listener(struct bt_component *component,
	612	bt_component_destroy_listener_func func, void *data)
	613	{
	614	size_t i;
	615
	616	assert(component);
	617	assert(func);
	618
	619	for (i = 0; i < component->destroy_listeners->len; i++) {
	620	struct bt_component_destroy_listener *listener =
	621	&g_array_index(component->destroy_listeners,
	622	struct bt_component_destroy_listener, i);
	623
	624	if (listener->func == func && listener->data == data) {
	625	g_array_remove_index(component->destroy_listeners, i);
	626	i--;
	627	}
	628	}
	629	}