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

/*
 * filter.c
 *
 * Babeltrace Filter Component
 *
 * Copyright 2016 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-FILTER"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/compiler-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/graph/component-filter-internal.h>
#include <babeltrace/graph/component-internal.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/graph/notification-iterator-internal.h>

BT_HIDDEN
void bt_component_filter_destroy(struct bt_component *component)
{
}

BT_HIDDEN
struct bt_component *bt_component_filter_create(
		struct bt_component_class *class, struct bt_value *params)
{
	struct bt_component_filter *filter = NULL;

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

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

int64_t bt_component_filter_get_input_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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;
	}

	ret = (int64_t) bt_component_get_input_port_count(component);

end:
	return ret;
}

struct bt_port *bt_component_filter_get_input_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_input_port_by_name() logs details/errors */
	port = bt_component_get_input_port_by_name(component, name);

end:
	return port;
}

struct bt_port *bt_component_filter_get_input_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_input_port_by_index() logs details/errors */
	port = bt_component_get_input_port_by_index(component, index);

end:
	return port;
}

int64_t bt_component_filter_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_filter_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_filter_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_filter_get_input_private_port_by_index(
		struct bt_private_component *private_component, uint64_t index)
{
	/* bt_component_filter_get_input_port_by_index() logs details/errors */
	return bt_private_port_from_port(
		bt_component_filter_get_input_port_by_index(
			bt_component_from_private(private_component), index));
}

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

enum bt_component_status bt_private_component_filter_add_input_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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_input_port() logs details/errors */
	port = bt_component_add_input_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;
}

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

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

enum bt_component_status bt_private_component_filter_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_FILTER) {
		BT_LOGW("Invalid parameter: component's class is not a filter 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/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
	1	/*
	2	* filter.c
	3	*
	4	* Babeltrace Filter Component
	5	*
	6	* Copyright 2016 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
	29	#define BT_LOG_TAG "COMP-FILTER"
	30	#include <babeltrace/lib-logging-internal.h>
	31
	32	#include <babeltrace/compiler-internal.h>
	33	#include <babeltrace/values.h>
	34	#include <babeltrace/graph/component-filter-internal.h>
	35	#include <babeltrace/graph/component-internal.h>
	36	#include <babeltrace/graph/component-class-internal.h>
	37	#include <babeltrace/graph/notification.h>
	38	#include <babeltrace/graph/notification-iterator-internal.h>
	39
	40	BT_HIDDEN
	41	void bt_component_filter_destroy(struct bt_component *component)
	42	{
	43	}
	44
	45	BT_HIDDEN
	46	struct bt_component *bt_component_filter_create(
	47	struct bt_component_class class, struct bt_value params)
	48	{
	49	struct bt_component_filter *filter = NULL;
	50
	51	filter = g_new0(struct bt_component_filter, 1);
	52	if (!filter) {
	53	BT_LOGE_STR("Failed to allocate one filter component.");
	54	goto end;
	55	}
	56
	57	end:
	58	return filter ? &filter->parent : NULL;
	59	}
	60
	61	int64_t bt_component_filter_get_input_port_count(
	62	struct bt_component *component)
	63	{
	64	int64_t ret;
	65
	66	if (!component) {
	67	BT_LOGW_STR("Invalid parameter: component is NULL.");
	68	ret = (int64_t) -1;
	69	goto end;
	70	}
	71
	72	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	73	BT_LOGW("Invalid parameter: component's class is not a filter 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	ret = (int64_t) bt_component_get_input_port_count(component);
	82
	83	end:
	84	return ret;
	85	}
	86
	87	struct bt_port *bt_component_filter_get_input_port_by_name(
	88	struct bt_component component, const char name)
	89	{
	90	struct bt_port *port = NULL;
	91
	92	if (!component) {
	93	BT_LOGW_STR("Invalid parameter: component is NULL.");
	94	goto end;
	95	}
	96
	97	if (!name) {
	98	BT_LOGW_STR("Invalid parameter: name is NULL.");
	99	goto end;
	100	}
	101
	102	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	103	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	104	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	105	component, bt_component_get_name(component),
	106	bt_component_class_type_string(component->class->type));
	107	goto end;
	108	}
	109
	110	/* bt_component_get_input_port_by_name() logs details/errors */
	111	port = bt_component_get_input_port_by_name(component, name);
	112
	113	end:
	114	return port;
	115	}
	116
	117	struct bt_port *bt_component_filter_get_input_port_by_index(
	118	struct bt_component *component, uint64_t index)
	119	{
	120	struct bt_port *port = NULL;
	121
	122	if (!component) {
	123	BT_LOGW_STR("Invalid parameter: component is NULL.");
	124	goto end;
	125	}
	126
	127	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	128	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	129	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	130	component, bt_component_get_name(component),
	131	bt_component_class_type_string(component->class->type));
	132	goto end;
	133	}
	134
	135	/* bt_component_get_input_port_by_index() logs details/errors */
	136	port = bt_component_get_input_port_by_index(component, index);
	137
	138	end:
	139	return port;
	140	}
	141
	142	int64_t bt_component_filter_get_output_port_count(
	143	struct bt_component *component)
	144	{
	145	int64_t ret;
	146
	147	if (!component) {
	148	BT_LOGW_STR("Invalid parameter: component is NULL.");
	149	ret = (int64_t) -1;
	150	goto end;
	151	}
	152
	153	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	154	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	155	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	156	component, bt_component_get_name(component),
	157	bt_component_class_type_string(component->class->type));
	158	ret = (int64_t) -1;
	159	goto end;
	160	}
	161
	162	/* bt_component_get_output_port_count() logs details/errors */
	163	ret = bt_component_get_output_port_count(component);
	164
	165	end:
	166	return ret;
	167	}
	168
	169	struct bt_port *bt_component_filter_get_output_port_by_name(
	170	struct bt_component component, const char name)
	171	{
	172	struct bt_port *port = NULL;
	173
	174	if (!component) {
	175	BT_LOGW_STR("Invalid parameter: component is NULL.");
	176	goto end;
	177	}
	178
	179	if (!name) {
	180	BT_LOGW_STR("Invalid parameter: name is NULL.");
	181	goto end;
	182	}
	183
	184	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	185	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	186	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	187	component, bt_component_get_name(component),
	188	bt_component_class_type_string(component->class->type));
	189	goto end;
	190	}
	191
	192	/* bt_component_get_output_port_by_name() logs details/errors */
	193	port = bt_component_get_output_port_by_name(component, name);
	194
	195	end:
	196	return port;
	197	}
	198
	199	struct bt_port *bt_component_filter_get_output_port_by_index(
	200	struct bt_component *component, uint64_t index)
	201	{
	202	struct bt_port *port = NULL;
	203
	204	if (!component) {
	205	BT_LOGW_STR("Invalid parameter: component is NULL.");
	206	goto end;
	207	}
	208
	209	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	210	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	211	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	212	component, bt_component_get_name(component),
	213	bt_component_class_type_string(component->class->type));
	214	goto end;
	215	}
	216
	217	/* bt_component_get_output_port_by_index() logs details/errors */
	218	port = bt_component_get_output_port_by_index(component, index);
	219
	220	end:
	221	return port;
	222	}
	223
	224	struct bt_private_port *
	225	bt_private_component_filter_get_input_private_port_by_index(
	226	struct bt_private_component *private_component, uint64_t index)
	227	{
	228	/* bt_component_filter_get_input_port_by_index() logs details/errors */
	229	return bt_private_port_from_port(
	230	bt_component_filter_get_input_port_by_index(
	231	bt_component_from_private(private_component), index));
	232	}
	233
	234	struct bt_private_port *
	235	bt_private_component_filter_get_input_private_port_by_name(
	236	struct bt_private_component *private_component,
	237	const char *name)
	238	{
	239	/* bt_component_filter_get_input_port_by_name() logs details/errors */
	240	return bt_private_port_from_port(
	241	bt_component_filter_get_input_port_by_name(
	242	bt_component_from_private(private_component), name));
	243	}
	244
	245	enum bt_component_status bt_private_component_filter_add_input_private_port(
	246	struct bt_private_component *private_component,
	247	const char name, void user_data,
	248	struct bt_private_port **user_priv_port)
	249	{
	250	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	251	struct bt_port *port = NULL;
	252	struct bt_component *component =
	253	bt_component_from_private(private_component);
	254
	255	if (!component) {
	256	BT_LOGW_STR("Invalid parameter: component is NULL.");
	257	status = BT_COMPONENT_STATUS_INVALID;
	258	goto end;
	259	}
	260
	261	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	262	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	263	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	264	component, bt_component_get_name(component),
	265	bt_component_class_type_string(component->class->type));
	266	status = BT_COMPONENT_STATUS_INVALID;
	267	goto end;
	268	}
	269
	270	/* bt_component_add_input_port() logs details/errors */
	271	port = bt_component_add_input_port(component, name, user_data);
	272	if (!port) {
	273	status = BT_COMPONENT_STATUS_NOMEM;
	274	goto end;
	275	}
	276
	277	if (user_priv_port) {
	278	/* Move reference to user */
	279	*user_priv_port = bt_private_port_from_port(port);
	280	port = NULL;
	281	}
	282
	283	end:
	284	bt_put(port);
	285	return status;
	286	}
	287
	288	struct bt_private_port *
	289	bt_private_component_filter_get_output_private_port_by_index(
	290	struct bt_private_component *private_component, uint64_t index)
	291	{
	292	/* bt_component_filter_get_output_port_by_index() logs details/errors */
	293	return bt_private_port_from_port(
	294	bt_component_filter_get_output_port_by_index(
	295	bt_component_from_private(private_component), index));
	296	}
	297
	298	struct bt_private_port *
	299	bt_private_component_filter_get_output_private_port_by_name(
	300	struct bt_private_component *private_component,
	301	const char *name)
	302	{
	303	/* bt_component_filter_get_output_port_by_name() logs details/errors */
	304	return bt_private_port_from_port(
	305	bt_component_filter_get_output_port_by_name(
	306	bt_component_from_private(private_component), name));
	307	}
	308
	309	enum bt_component_status bt_private_component_filter_add_output_private_port(
	310	struct bt_private_component *private_component,
	311	const char name, void user_data,
	312	struct bt_private_port **user_priv_port)
	313	{
	314	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	315	struct bt_port *port = NULL;
	316	struct bt_component *component =
	317	bt_component_from_private(private_component);
	318
	319	if (!component) {
	320	BT_LOGW_STR("Invalid parameter: component is NULL.");
	321	status = BT_COMPONENT_STATUS_INVALID;
	322	goto end;
	323	}
	324
	325	if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
	326	BT_LOGW("Invalid parameter: component's class is not a filter component class: "
	327	"comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
	328	component, bt_component_get_name(component),
	329	bt_component_class_type_string(component->class->type));
	330	status = BT_COMPONENT_STATUS_INVALID;
	331	goto end;
	332	}
	333
	334	/* bt_component_add_output_port() logs details/errors */
	335	port = bt_component_add_output_port(component, name, user_data);
	336	if (!port) {
	337	status = BT_COMPONENT_STATUS_NOMEM;
	338	goto end;
	339	}
	340
	341	if (user_priv_port) {
	342	/* Move reference to user */
	343	*user_priv_port = bt_private_port_from_port(port);
	344	port = NULL;
	345	}
	346
	347	end:
	348	bt_put(port);
	349	return status;
	350	}