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

/*
 * source.c
 *
 * Babeltrace Source 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.
 */

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

#include <babeltrace/ref.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/graph/component-source-internal.h>
#include <babeltrace/graph/component-internal.h>
#include <babeltrace/graph/port-internal.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/notification-iterator-internal.h>

BT_HIDDEN
void bt_component_source_destroy(struct bt_component *component)
{
}

BT_HIDDEN
struct bt_component *bt_component_source_create(
		struct bt_component_class *class, struct bt_value *params)
{
	struct bt_component_source *source = NULL;

	source = g_new0(struct bt_component_source, 1);
	if (!source) {
		BT_LOGE_STR("Failed to allocate one source component.");
		goto end;
	}

end:
	return source ? &source->parent : NULL;
}

int64_t bt_component_source_get_output_port_count(
		struct bt_component *component)
{
	int64_t ret;

	if (!component) {
		BT_LOGW_STR("Invalid parameter: component is NULL.");
		ret = (int64_t) -1;
		goto end;
	}

	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		BT_LOGW("Invalid parameter: component's class is not a source component class: "
			"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
			component, bt_component_get_name(component),
			bt_component_class_type_string(component->class->type));
		ret = (int64_t) -1;
		goto end;
	}

	/* bt_component_get_output_port_count() logs details/errors */
	ret = bt_component_get_output_port_count(component);

end:
	return ret;
}

struct bt_port *bt_component_source_get_output_port_by_name(
		struct bt_component *component, const char *name)
{
	struct bt_port *port = NULL;

	if (!component) {
		BT_LOGW_STR("Invalid parameter: component is NULL.");
		goto end;
	}

	if (!name) {
		BT_LOGW_STR("Invalid parameter: name is NULL.");
		goto end;
	}

	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		BT_LOGW("Invalid parameter: component's class is not a source component class: "
			"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
			component, bt_component_get_name(component),
			bt_component_class_type_string(component->class->type));
		goto end;
	}

	/* bt_component_get_output_port_by_name() logs details/errors */
	port = bt_component_get_output_port_by_name(component, name);

end:
	return port;
}

struct bt_port *bt_component_source_get_output_port_by_index(
		struct bt_component *component, uint64_t index)
{
	struct bt_port *port = NULL;

	if (!component) {
		BT_LOGW_STR("Invalid parameter: component is NULL.");
		goto end;
	}

	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		BT_LOGW("Invalid parameter: component's class is not a source component class: "
			"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
			component, bt_component_get_name(component),
			bt_component_class_type_string(component->class->type));
		goto end;
	}

	/* bt_component_get_output_port_by_index() logs details/errors */
	port = bt_component_get_output_port_by_index(component, index);

end:
	return port;
}

struct bt_private_port *
bt_private_component_source_get_output_private_port_by_name(
		struct bt_private_component *private_component,
		const char *name)
{
	/* bt_component_source_get_output_port_by_name() logs details/errors */
	return bt_private_port_from_port(
		bt_component_source_get_output_port_by_name(
			bt_component_from_private(private_component), name));
}

struct bt_private_port *
bt_private_component_source_get_output_private_port_by_index(
		struct bt_private_component *private_component, uint64_t index)
{
	/* bt_component_source_get_output_port_by_index() logs details/errors */
	return bt_private_port_from_port(
		bt_component_source_get_output_port_by_index(
			bt_component_from_private(private_component), index));
}

enum bt_component_status bt_private_component_source_add_output_private_port(
		struct bt_private_component *private_component,
		const char *name, void *user_data,
		struct bt_private_port **user_priv_port)
{
	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	struct bt_port *port = NULL;
	struct bt_component *component =
		bt_component_from_private(private_component);

	if (!component) {
		BT_LOGW_STR("Invalid parameter: component is NULL.");
		status = BT_COMPONENT_STATUS_INVALID;
		goto end;
	}

	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		BT_LOGW("Invalid parameter: component's class is not a source component class: "
			"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
			component, bt_component_get_name(component),
			bt_component_class_type_string(component->class->type));
		status = BT_COMPONENT_STATUS_INVALID;
		goto end;
	}

	/* bt_component_add_output_port() logs details and errors */
	port = bt_component_add_output_port(component, name, user_data);
	if (!port) {
		status = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	if (user_priv_port) {
		/* Move reference to user */
		*user_priv_port = bt_private_port_from_port(port);
		port = NULL;
	}

end:
	bt_put(port);
	return status;
}
Commit	Line	Data
0777b693 JG	1	/*
	2	* source.c
	3	*
0d884c50	4	* Babeltrace Source Component
0777b693 JG	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
6baaaa1b PP	29	#define BT_LOG_TAG "COMP-SOURCE"
	30	#include <babeltrace/lib-logging-internal.h>
	31
b8a06801	32	#include <babeltrace/ref.h>
3d9990ac	33	#include <babeltrace/compiler-internal.h>
b2e0c907 PP	34	#include <babeltrace/graph/component-source-internal.h>
	35	#include <babeltrace/graph/component-internal.h>
	36	#include <babeltrace/graph/port-internal.h>
	37	#include <babeltrace/graph/notification-iterator.h>
	38	#include <babeltrace/graph/notification-iterator-internal.h>
0777b693	39
72b913fb	40	BT_HIDDEN
366e034f JG	41	void bt_component_source_destroy(struct bt_component *component)
366e034f JG	42	{
366e034f JG	43	}
366e034f JG	44
8738a040	45	BT_HIDDEN
fb2dcc52	46	struct bt_component *bt_component_source_create(
7c7c0433	47	struct bt_component_class class, struct bt_value params)
0777b693	48	{
0d884c50	49	struct bt_component_source *source = NULL;
38b48196	50
0d884c50	51	source = g_new0(struct bt_component_source, 1);
0777b693	52	if (!source) {
6baaaa1b	53	BT_LOGE_STR("Failed to allocate one source component.");
0777b693 JG	54	goto end;
	55	}
	56
0777b693 JG	57	end:
	58	return source ? &source->parent : NULL;
	59	}
47e5a032	60
544d0515	61	int64_t bt_component_source_get_output_port_count(
6baaaa1b	62	struct bt_component *component)
366e034f	63	{
544d0515	64	int64_t ret;
366e034f	65
6baaaa1b PP	66	if (!component) {
	67	BT_LOGW_STR("Invalid parameter: component is NULL.");
	68	ret = (int64_t) -1;
366e034f JG	69	goto end;
	70	}
	71
6baaaa1b PP	72	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	73	BT_LOGW("Invalid parameter: component's class is not a source component class: "
	74	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	75	component, bt_component_get_name(component),
	76	bt_component_class_type_string(component->class->type));
	77	ret = (int64_t) -1;
	78	goto end;
	79	}
	80
	81	/* bt_component_get_output_port_count() logs details/errors */
544d0515	82	ret = bt_component_get_output_port_count(component);
6baaaa1b	83
366e034f	84	end:
544d0515	85	return ret;
366e034f JG	86	}
366e034f JG	87
9ac68eb1	88	struct bt_port *bt_component_source_get_output_port_by_name(
366e034f JG	89	struct bt_component component, const char name)
366e034f JG	90	{
72b913fb	91	struct bt_port *port = NULL;
366e034f	92
6baaaa1b PP	93	if (!component) {
	94	BT_LOGW_STR("Invalid parameter: component is NULL.");
	95	goto end;
	96	}
	97
	98	if (!name) {
	99	BT_LOGW_STR("Invalid parameter: name is NULL.");
	100	goto end;
	101	}
	102
	103	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	104	BT_LOGW("Invalid parameter: component's class is not a source component class: "
	105	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	106	component, bt_component_get_name(component),
	107	bt_component_class_type_string(component->class->type));
366e034f JG	108	goto end;
	109	}
	110
6baaaa1b	111	/* bt_component_get_output_port_by_name() logs details/errors */
9ac68eb1	112	port = bt_component_get_output_port_by_name(component, name);
6baaaa1b	113
366e034f	114	end:
72b913fb	115	return port;
366e034f JG	116	}
366e034f JG	117
9ac68eb1 PP	118	struct bt_port *bt_component_source_get_output_port_by_index(
9ac68eb1 PP	119	struct bt_component *component, uint64_t index)
366e034f JG	120	{
366e034f JG	121	struct bt_port *port = NULL;
366e034f	122
6baaaa1b PP	123	if (!component) {
	124	BT_LOGW_STR("Invalid parameter: component is NULL.");
	125	goto end;
	126	}
	127
	128	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	129	BT_LOGW("Invalid parameter: component's class is not a source component class: "
	130	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	131	component, bt_component_get_name(component),
	132	bt_component_class_type_string(component->class->type));
366e034f JG	133	goto end;
	134	}
	135
6baaaa1b	136	/* bt_component_get_output_port_by_index() logs details/errors */
9ac68eb1	137	port = bt_component_get_output_port_by_index(component, index);
6baaaa1b	138
366e034f JG	139	end:
	140	return port;
	141	}
	142
9ac68eb1 PP	143	struct bt_private_port *
9ac68eb1 PP	144	bt_private_component_source_get_output_private_port_by_name(
890882ef PP	145	struct bt_private_component *private_component,
	146	const char *name)
	147	{
6baaaa1b	148	/* bt_component_source_get_output_port_by_name() logs details/errors */
9ac68eb1 PP	149	return bt_private_port_from_port(
	150	bt_component_source_get_output_port_by_name(
	151	bt_component_from_private(private_component), name));
890882ef PP	152	}
	153
	154	struct bt_private_port *
9ac68eb1 PP	155	bt_private_component_source_get_output_private_port_by_index(
9ac68eb1 PP	156	struct bt_private_component *private_component, uint64_t index)
890882ef	157	{
6baaaa1b	158	/* bt_component_source_get_output_port_by_index() logs details/errors */
890882ef	159	return bt_private_port_from_port(
9ac68eb1	160	bt_component_source_get_output_port_by_index(
890882ef PP	161	bt_component_from_private(private_component), index));
	162	}
	163
147337a3	164	enum bt_component_status bt_private_component_source_add_output_private_port(
890882ef	165	struct bt_private_component *private_component,
147337a3 PP	166	const char name, void user_data,
147337a3 PP	167	struct bt_private_port **user_priv_port)
366e034f	168	{
147337a3	169	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
72b913fb	170	struct bt_port *port = NULL;
890882ef PP	171	struct bt_component *component =
890882ef PP	172	bt_component_from_private(private_component);
366e034f	173
6baaaa1b PP	174	if (!component) {
6baaaa1b PP	175	BT_LOGW_STR("Invalid parameter: component is NULL.");
147337a3	176	status = BT_COMPONENT_STATUS_INVALID;
366e034f JG	177	goto end;
	178	}
	179
6baaaa1b PP	180	if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	181	BT_LOGW("Invalid parameter: component's class is not a source component class: "
	182	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	183	component, bt_component_get_name(component),
	184	bt_component_class_type_string(component->class->type));
147337a3	185	status = BT_COMPONENT_STATUS_INVALID;
6baaaa1b PP	186	goto end;
	187	}
	188
	189	/* bt_component_add_output_port() logs details and errors */
3e9b0023	190	port = bt_component_add_output_port(component, name, user_data);
147337a3 PP	191	if (!port) {
	192	status = BT_COMPONENT_STATUS_NOMEM;
	193	goto end;
	194	}
	195
	196	if (user_priv_port) {
	197	/* Move reference to user */
	198	*user_priv_port = bt_private_port_from_port(port);
	199	port = NULL;
	200	}
6baaaa1b	201
366e034f	202	end:
147337a3 PP	203	bt_put(port);
147337a3 PP	204	return status;
366e034f	205	}