[babeltrace.git] / src / 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 "lib/lib-logging.h"

#include "common/assert.h"
#include "lib/assert-pre.h"
#include "lib/object.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 <glib.h>

#include "component-class-sink-colander.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
706a18f9	1	/*
e2f7325d	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
706a18f9 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"
578e048b	24	#include "lib/lib-logging.h"
706a18f9	25
578e048b MJ	26	#include "common/assert.h"
	27	#include "lib/assert-pre.h"
	28	#include "lib/object.h"
3fadfbc0 MJ	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>
706a18f9	34	#include <glib.h>
706a18f9	35
578e048b MJ	36	#include "component-class-sink-colander.h"
578e048b MJ	37
706a18f9	38	static
0d72b8c3	39	struct bt_component_class_sink *colander_comp_cls;
706a18f9	40
706a18f9	41	static
d94d92ac PP	42	enum bt_self_component_status colander_init(
d94d92ac PP	43	struct bt_self_component_sink *self_comp,
05e21286	44	const struct bt_value params, void init_method_data)
706a18f9	45	{
d94d92ac	46	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
7474e7d3	47	struct bt_component_class_sink_colander_priv_data *colander_data = NULL;
8ed535b5 PP	48	struct bt_component_class_sink_colander_data *user_provided_data =
8ed535b5 PP	49	init_method_data;
706a18f9 PP	50
	51	if (!init_method_data) {
	52	BT_LOGW_STR("Component initialization method data is NULL.");
d94d92ac	53	status = BT_SELF_COMPONENT_STATUS_ERROR;
706a18f9 PP	54	goto end;
	55	}
	56
7474e7d3 PP	57	colander_data = g_new0(
7474e7d3 PP	58	struct bt_component_class_sink_colander_priv_data, 1);
706a18f9 PP	59	if (!colander_data) {
706a18f9 PP	60	BT_LOGE_STR("Failed to allocate colander data.");
d94d92ac	61	status = BT_SELF_COMPONENT_STATUS_NOMEM;
706a18f9 PP	62	goto end;
	63	}
	64
d6e69534	65	colander_data->msgs = user_provided_data->msgs;
d4393e08	66	colander_data->count_addr = user_provided_data->count_addr;
d94d92ac PP	67	status = bt_self_component_sink_add_input_port(self_comp, "in",
	68	NULL, NULL);
	69	if (status != BT_SELF_COMPONENT_STATUS_OK) {
706a18f9 PP	70	BT_LOGE_STR("Cannot add input port.");
	71	goto end;
	72	}
	73
d94d92ac	74	bt_self_component_set_data(
707b7d35	75	bt_self_component_sink_as_self_component(self_comp),
d94d92ac	76	colander_data);
706a18f9 PP	77
	78	end:
	79	return status;
	80	}
	81
	82	static
d94d92ac	83	void colander_finalize(struct bt_self_component_sink *self_comp)
706a18f9	84	{
7474e7d3	85	struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac	86	bt_self_component_get_data(
707b7d35	87	bt_self_component_sink_as_self_component(self_comp));
706a18f9 PP	88
	89	if (!colander_data) {
	90	return;
	91	}
	92
d6e69534	93	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
706a18f9 PP	94	g_free(colander_data);
	95	}
	96
	97	static
36d1acad SM	98	enum bt_self_component_status colander_graph_is_configured(
36d1acad SM	99	bt_self_component_sink *self_comp)
706a18f9	100	{
d94d92ac	101	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
7474e7d3	102	struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac	103	bt_self_component_get_data(
707b7d35	104	bt_self_component_sink_as_self_component(self_comp));
706a18f9	105
36d1acad SM	106	struct bt_self_component_port_input *self_port =
	107	bt_self_component_sink_borrow_input_port_by_name(self_comp, "in");
	108	BT_ASSERT(self_port);
	109
f6ccaed9	110	BT_ASSERT(colander_data);
d6e69534 PP	111	BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
	112	colander_data->msg_iter =
	113	bt_self_component_port_input_message_iterator_create(
d94d92ac	114	self_port);
d6e69534 PP	115	if (!colander_data->msg_iter) {
d6e69534 PP	116	BT_LIB_LOGE("Cannot create message iterator on "
d94d92ac PP	117	"self component input port: %![port-]+p",
	118	self_port);
	119	status = BT_SELF_COMPONENT_STATUS_NOMEM;
706a18f9 PP	120	goto end;
	121	}
	122
	123	end:
bf55043c	124	return status;
706a18f9 PP	125	}
	126
	127	static
d94d92ac PP	128	enum bt_self_component_status colander_consume(
d94d92ac PP	129	struct bt_self_component_sink *self_comp)
706a18f9	130	{
d94d92ac	131	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
d6e69534	132	enum bt_message_iterator_status msg_iter_status;
7474e7d3	133	struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac	134	bt_self_component_get_data(
707b7d35	135	bt_self_component_sink_as_self_component(self_comp));
d6e69534	136	bt_message_array_const msgs;
706a18f9	137
f6ccaed9	138	BT_ASSERT(colander_data);
706a18f9	139
d6e69534	140	if (!colander_data->msg_iter) {
d94d92ac	141	BT_LIB_LOGW("Trying to consume without an "
d6e69534	142	"upstream message iterator: %![comp-]+c",
d94d92ac	143	self_comp);
706a18f9 PP	144	goto end;
	145	}
	146
d6e69534 PP	147	msg_iter_status =
	148	bt_self_component_port_input_message_iterator_next(
	149	colander_data->msg_iter, &msgs,
d94d92ac	150	colander_data->count_addr);
d6e69534	151	switch (msg_iter_status) {
d6e69534	152	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
d94d92ac	153	status = BT_SELF_COMPONENT_STATUS_AGAIN;
706a18f9	154	goto end;
d6e69534	155	case BT_MESSAGE_ITERATOR_STATUS_END:
d94d92ac	156	status = BT_SELF_COMPONENT_STATUS_END;
706a18f9	157	goto end;
d6e69534 PP	158	case BT_MESSAGE_ITERATOR_STATUS_OK:
	159	/* Move messages to user (count already set) */
	160	memcpy(colander_data->msgs, msgs,
	161	sizeof(msgs) *colander_data->count_addr);
706a18f9 PP	162	break;
706a18f9 PP	163	default:
d94d92ac	164	status = BT_SELF_COMPONENT_STATUS_ERROR;
706a18f9 PP	165	goto end;
	166	}
	167
706a18f9	168	end:
706a18f9 PP	169	return status;
	170	}
	171
d94d92ac	172	struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
706a18f9 PP	173	{
	174	if (colander_comp_cls) {
	175	goto end;
	176	}
	177
0d72b8c3 PP	178	colander_comp_cls = bt_component_class_sink_create("colander",
0d72b8c3 PP	179	colander_consume);
706a18f9 PP	180	if (!colander_comp_cls) {
	181	BT_LOGE_STR("Cannot create sink colander component class.");
	182	goto end;
	183	}
	184
0d72b8c3	185	(void) bt_component_class_sink_set_init_method(
d94d92ac	186	colander_comp_cls, colander_init);
0d72b8c3	187	(void) bt_component_class_sink_set_finalize_method(
d94d92ac	188	colander_comp_cls, colander_finalize);
36d1acad SM	189	(void) bt_component_class_sink_set_graph_is_configured_method(
36d1acad SM	190	colander_comp_cls, colander_graph_is_configured);
706a18f9 PP	191
706a18f9 PP	192	end:
398454ed PP	193	bt_object_get_ref(colander_comp_cls);
398454ed PP	194	return (void *) colander_comp_cls;
706a18f9 PP	195	}
	196
	197	__attribute__((destructor)) static
	198	void put_colander(void) {
65300d60	199	BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
706a18f9	200	}