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

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

enum bt_component_status bt_component_set_name(struct bt_component *component,
		const char *name)
{
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;

	if (!component || !name || name[0] == '\0') {
		ret = BT_COMPONENT_STATUS_INVALID;
		goto end;
	}

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