[babeltrace.git] / lib / graph / component-class-sink-colander.c

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@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 "COLANDER"
#include <babeltrace2/lib-logging-internal.h>

#include <babeltrace2/assert-internal.h>
#include <babeltrace2/assert-pre-internal.h>
#include <babeltrace2/object-internal.h>
#include <babeltrace2/graph/component-class-sink.h>
#include <babeltrace2/graph/self-component-sink.h>
#include <babeltrace2/graph/self-component-port.h>
#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
#include <babeltrace2/graph/self-component.h>
#include <babeltrace2/graph/component-class-sink-colander-internal.h>
#include <glib.h>

static
struct bt_component_class_sink *colander_comp_cls;

static
enum bt_self_component_status colander_init(
		struct bt_self_component_sink *self_comp,
		const struct bt_value *params, void *init_method_data)
{
	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	struct bt_component_class_sink_colander_priv_data *colander_data = NULL;
	struct bt_component_class_sink_colander_data *user_provided_data =
		init_method_data;

	if (!init_method_data) {
		BT_LOGW_STR("Component initialization method data is NULL.");
		status = BT_SELF_COMPONENT_STATUS_ERROR;
		goto end;
	}

	colander_data = g_new0(
		struct bt_component_class_sink_colander_priv_data, 1);
	if (!colander_data) {
		BT_LOGE_STR("Failed to allocate colander data.");
		status = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	colander_data->msgs = user_provided_data->msgs;
	colander_data->count_addr = user_provided_data->count_addr;
	status = bt_self_component_sink_add_input_port(self_comp, "in",
		NULL, NULL);
	if (status != BT_SELF_COMPONENT_STATUS_OK) {
		BT_LOGE_STR("Cannot add input port.");
		goto end;
	}

	bt_self_component_set_data(
		bt_self_component_sink_as_self_component(self_comp),
		colander_data);

end:
	return status;
}

static
void colander_finalize(struct bt_self_component_sink *self_comp)
{
	struct bt_component_class_sink_colander_priv_data *colander_data =
		bt_self_component_get_data(
			bt_self_component_sink_as_self_component(self_comp));

	if (!colander_data) {
		return;
	}

	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
	g_free(colander_data);
}

static
enum bt_self_component_status colander_graph_is_configured(
	bt_self_component_sink *self_comp)
{
	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	struct bt_component_class_sink_colander_priv_data *colander_data =
		bt_self_component_get_data(
			bt_self_component_sink_as_self_component(self_comp));

	struct bt_self_component_port_input *self_port =
		bt_self_component_sink_borrow_input_port_by_name(self_comp, "in");
	BT_ASSERT(self_port);

	BT_ASSERT(colander_data);
	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
	colander_data->msg_iter =
		bt_self_component_port_input_message_iterator_create(
			self_port);
	if (!colander_data->msg_iter) {
		BT_LIB_LOGE("Cannot create message iterator on "
			"self component input port: %![port-]+p",
			self_port);
		status = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

end:
	return status;
}

static
enum bt_self_component_status colander_consume(
		struct bt_self_component_sink *self_comp)
{
	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	enum bt_message_iterator_status msg_iter_status;
	struct bt_component_class_sink_colander_priv_data *colander_data =
		bt_self_component_get_data(
			bt_self_component_sink_as_self_component(self_comp));
	bt_message_array_const msgs;

	BT_ASSERT(colander_data);

	if (!colander_data->msg_iter) {
		BT_LIB_LOGW("Trying to consume without an "
			"upstream message iterator: %![comp-]+c",
			self_comp);
		goto end;
	}

	msg_iter_status =
		bt_self_component_port_input_message_iterator_next(
			colander_data->msg_iter, &msgs,
			colander_data->count_addr);
	switch (msg_iter_status) {
	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
		status = BT_SELF_COMPONENT_STATUS_AGAIN;
		goto end;
	case BT_MESSAGE_ITERATOR_STATUS_END:
		status = BT_SELF_COMPONENT_STATUS_END;
		goto end;
	case BT_MESSAGE_ITERATOR_STATUS_OK:
		/* Move messages to user (count already set) */
		memcpy(colander_data->msgs, msgs,
			sizeof(*msgs) * *colander_data->count_addr);
		break;
	default:
		status = BT_SELF_COMPONENT_STATUS_ERROR;
		goto end;
	}

end:
	return status;
}

struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
{
	if (colander_comp_cls) {
		goto end;
	}

	colander_comp_cls = bt_component_class_sink_create("colander",
		colander_consume);
	if (!colander_comp_cls) {
		BT_LOGE_STR("Cannot create sink colander component class.");
		goto end;
	}

	(void) bt_component_class_sink_set_init_method(
		colander_comp_cls, colander_init);
	(void) bt_component_class_sink_set_finalize_method(
		colander_comp_cls, colander_finalize);
	(void) bt_component_class_sink_set_graph_is_configured_method(
		colander_comp_cls, colander_graph_is_configured);

end:
	bt_object_get_ref(colander_comp_cls);
	return (void *) colander_comp_cls;
}

__attribute__((destructor)) static
void put_colander(void) {
	BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
}
Commit	Line	Data
361ac4a6	1	/*
f2b0325d	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
361ac4a6 PP	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a copy
	5	* of this software and associated documentation files (the "Software"), to deal
	6	* in the Software without restriction, including without limitation the rights
	7	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	8	* copies of the Software, and to permit persons to whom the Software is
	9	* furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	17	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	18	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	19	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	20	* SOFTWARE.
	21	*/
	22
	23	#define BT_LOG_TAG "COLANDER"
71c5da58	24	#include <babeltrace2/lib-logging-internal.h>
361ac4a6	25
71c5da58 MJ	26	#include <babeltrace2/assert-internal.h>
	27	#include <babeltrace2/assert-pre-internal.h>
	28	#include <babeltrace2/object-internal.h>
	29	#include <babeltrace2/graph/component-class-sink.h>
	30	#include <babeltrace2/graph/self-component-sink.h>
	31	#include <babeltrace2/graph/self-component-port.h>
	32	#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
	33	#include <babeltrace2/graph/self-component.h>
	34	#include <babeltrace2/graph/component-class-sink-colander-internal.h>
361ac4a6	35	#include <glib.h>
361ac4a6 PP	36
361ac4a6 PP	37	static
7b53201c	38	struct bt_component_class_sink *colander_comp_cls;
361ac4a6	39
361ac4a6	40	static
834e9996 PP	41	enum bt_self_component_status colander_init(
834e9996 PP	42	struct bt_self_component_sink *self_comp,
ce141536	43	const struct bt_value params, void init_method_data)
361ac4a6	44	{
834e9996	45	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
15a52f66	46	struct bt_component_class_sink_colander_priv_data *colander_data = NULL;
c3ac0193 PP	47	struct bt_component_class_sink_colander_data *user_provided_data =
c3ac0193 PP	48	init_method_data;
361ac4a6 PP	49
	50	if (!init_method_data) {
	51	BT_LOGW_STR("Component initialization method data is NULL.");
834e9996	52	status = BT_SELF_COMPONENT_STATUS_ERROR;
361ac4a6 PP	53	goto end;
	54	}
	55
15a52f66 PP	56	colander_data = g_new0(
15a52f66 PP	57	struct bt_component_class_sink_colander_priv_data, 1);
361ac4a6 PP	58	if (!colander_data) {
361ac4a6 PP	59	BT_LOGE_STR("Failed to allocate colander data.");
834e9996	60	status = BT_SELF_COMPONENT_STATUS_NOMEM;
361ac4a6 PP	61	goto end;
	62	}
	63
b09a5592	64	colander_data->msgs = user_provided_data->msgs;
3fd7b79d	65	colander_data->count_addr = user_provided_data->count_addr;
834e9996 PP	66	status = bt_self_component_sink_add_input_port(self_comp, "in",
	67	NULL, NULL);
	68	if (status != BT_SELF_COMPONENT_STATUS_OK) {
361ac4a6 PP	69	BT_LOGE_STR("Cannot add input port.");
	70	goto end;
	71	}
	72
834e9996	73	bt_self_component_set_data(
bb61965b	74	bt_self_component_sink_as_self_component(self_comp),
834e9996	75	colander_data);
361ac4a6 PP	76
	77	end:
	78	return status;
	79	}
	80
	81	static
834e9996	82	void colander_finalize(struct bt_self_component_sink *self_comp)
361ac4a6	83	{
15a52f66	84	struct bt_component_class_sink_colander_priv_data *colander_data =
834e9996	85	bt_self_component_get_data(
bb61965b	86	bt_self_component_sink_as_self_component(self_comp));
361ac4a6 PP	87
	88	if (!colander_data) {
	89	return;
	90	}
	91
b09a5592	92	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
361ac4a6 PP	93	g_free(colander_data);
	94	}
	95
	96	static
ddcfe154 SM	97	enum bt_self_component_status colander_graph_is_configured(
ddcfe154 SM	98	bt_self_component_sink *self_comp)
361ac4a6	99	{
834e9996	100	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
15a52f66	101	struct bt_component_class_sink_colander_priv_data *colander_data =
834e9996	102	bt_self_component_get_data(
bb61965b	103	bt_self_component_sink_as_self_component(self_comp));
361ac4a6	104
ddcfe154 SM	105	struct bt_self_component_port_input *self_port =
	106	bt_self_component_sink_borrow_input_port_by_name(self_comp, "in");
	107	BT_ASSERT(self_port);
	108
8b45963b	109	BT_ASSERT(colander_data);
b09a5592 PP	110	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
	111	colander_data->msg_iter =
	112	bt_self_component_port_input_message_iterator_create(
834e9996	113	self_port);
b09a5592 PP	114	if (!colander_data->msg_iter) {
b09a5592 PP	115	BT_LIB_LOGE("Cannot create message iterator on "
834e9996 PP	116	"self component input port: %![port-]+p",
	117	self_port);
	118	status = BT_SELF_COMPONENT_STATUS_NOMEM;
361ac4a6 PP	119	goto end;
	120	}
	121
	122	end:
634f394c	123	return status;
361ac4a6 PP	124	}
	125
	126	static
834e9996 PP	127	enum bt_self_component_status colander_consume(
834e9996 PP	128	struct bt_self_component_sink *self_comp)
361ac4a6	129	{
834e9996	130	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
b09a5592	131	enum bt_message_iterator_status msg_iter_status;
15a52f66	132	struct bt_component_class_sink_colander_priv_data *colander_data =
834e9996	133	bt_self_component_get_data(
bb61965b	134	bt_self_component_sink_as_self_component(self_comp));
b09a5592	135	bt_message_array_const msgs;
361ac4a6	136
8b45963b	137	BT_ASSERT(colander_data);
361ac4a6	138
b09a5592	139	if (!colander_data->msg_iter) {
834e9996	140	BT_LIB_LOGW("Trying to consume without an "
b09a5592	141	"upstream message iterator: %![comp-]+c",
834e9996	142	self_comp);
361ac4a6 PP	143	goto end;
	144	}
	145
b09a5592 PP	146	msg_iter_status =
	147	bt_self_component_port_input_message_iterator_next(
	148	colander_data->msg_iter, &msgs,
834e9996	149	colander_data->count_addr);
b09a5592	150	switch (msg_iter_status) {
b09a5592	151	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
834e9996	152	status = BT_SELF_COMPONENT_STATUS_AGAIN;
361ac4a6	153	goto end;
b09a5592	154	case BT_MESSAGE_ITERATOR_STATUS_END:
834e9996	155	status = BT_SELF_COMPONENT_STATUS_END;
361ac4a6	156	goto end;
b09a5592 PP	157	case BT_MESSAGE_ITERATOR_STATUS_OK:
	158	/* Move messages to user (count already set) */
	159	memcpy(colander_data->msgs, msgs,
	160	sizeof(msgs) *colander_data->count_addr);
361ac4a6 PP	161	break;
361ac4a6 PP	162	default:
834e9996	163	status = BT_SELF_COMPONENT_STATUS_ERROR;
361ac4a6 PP	164	goto end;
	165	}
	166
361ac4a6	167	end:
361ac4a6 PP	168	return status;
	169	}
	170
834e9996	171	struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
361ac4a6 PP	172	{
	173	if (colander_comp_cls) {
	174	goto end;
	175	}
	176
7b53201c PP	177	colander_comp_cls = bt_component_class_sink_create("colander",
7b53201c PP	178	colander_consume);
361ac4a6 PP	179	if (!colander_comp_cls) {
	180	BT_LOGE_STR("Cannot create sink colander component class.");
	181	goto end;
	182	}
	183
7b53201c	184	(void) bt_component_class_sink_set_init_method(
834e9996	185	colander_comp_cls, colander_init);
7b53201c	186	(void) bt_component_class_sink_set_finalize_method(
834e9996	187	colander_comp_cls, colander_finalize);
ddcfe154 SM	188	(void) bt_component_class_sink_set_graph_is_configured_method(
ddcfe154 SM	189	colander_comp_cls, colander_graph_is_configured);
361ac4a6 PP	190
361ac4a6 PP	191	end:
4b70020d PP	192	bt_object_get_ref(colander_comp_cls);
4b70020d PP	193	return (void *) colander_comp_cls;
361ac4a6 PP	194	}
	195
	196	__attribute__((destructor)) static
	197	void put_colander(void) {
8138bfe1	198	BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
361ac4a6	199	}