lib: strictly type function return status enumerations

[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 "LIB/COLANDER"
#include "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"
#include "lib/func-status.h"

static
struct bt_component_class_sink *colander_comp_cls;

static
enum bt_component_class_init_method_status colander_init(
		struct bt_self_component_sink *self_comp,
		const struct bt_value *params, void *init_method_data)
{
	enum bt_component_class_init_method_status status =
		BT_FUNC_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;

	BT_ASSERT(init_method_data);
	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_FUNC_STATUS_MEMORY_ERROR;
		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_FUNC_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_component_class_sink_graph_is_configured_method_status
colander_graph_is_configured(
	bt_self_component_sink *self_comp)
{
	enum bt_component_class_sink_graph_is_configured_method_status status =
		BT_FUNC_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_FUNC_STATUS_MEMORY_ERROR;
		goto end;
	}

end:
	return status;
}

static
enum bt_component_class_sink_consume_method_status colander_consume(
		struct bt_self_component_sink *self_comp)
{
	enum bt_component_class_sink_consume_method_status status =
		BT_FUNC_STATUS_OK;
	enum bt_message_iterator_next_status next_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);
	BT_ASSERT(colander_data->msg_iter);
	next_status = bt_self_component_port_input_message_iterator_next(
		colander_data->msg_iter, &msgs,
		colander_data->count_addr);
	switch (next_status) {
	case BT_FUNC_STATUS_AGAIN:
		status = BT_FUNC_STATUS_AGAIN;
		goto end;
	case BT_FUNC_STATUS_END:
		status = BT_FUNC_STATUS_END;
		goto end;
	case BT_FUNC_STATUS_OK:
		/* Move messages to user (count already set) */
		memcpy(colander_data->msgs, msgs,
			sizeof(*msgs) * *colander_data->count_addr);
		break;
	default:
		status = BT_FUNC_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 colander_comp_cls;
}

__attribute__((destructor)) static
void put_colander(void) {
	BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
}