lib: graph: add "self" and some "private" APIs

[babeltrace.git] / plugins / utils / dummy / dummy.c

/*
 * Copyright 2017 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.
 */

#include <babeltrace/babeltrace.h>
#include <babeltrace/babeltrace-internal.h>
#include <plugins-common.h>
#include <babeltrace/assert-internal.h>
#include "dummy.h"

void destroy_private_dummy_data(struct dummy *dummy)
{
	bt_object_put_ref(dummy->notif_iter);
	g_free(dummy);

}

BT_HIDDEN
void dummy_finalize(struct bt_self_component_sink *comp)
{
	struct dummy *dummy;

	BT_ASSERT(comp);
	dummy = bt_self_component_get_data(
			bt_self_component_sink_borrow_self_component(comp));
	BT_ASSERT(dummy);
	destroy_private_dummy_data(dummy);
}

BT_HIDDEN
enum bt_self_component_status dummy_init(
		struct bt_self_component_sink *component,
		struct bt_value *params, UNUSED_VAR void *init_method_data)
{
	enum bt_self_component_status ret;
	struct dummy *dummy = g_new0(struct dummy, 1);

	if (!dummy) {
		ret = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_self_component_sink_add_input_port(component,
		"in", NULL, NULL);
	if (ret != BT_SELF_COMPONENT_STATUS_OK) {
		goto error;
	}

	bt_self_component_set_data(
		bt_self_component_sink_borrow_self_component(component), dummy);
	goto end;

error:
	destroy_private_dummy_data(dummy);

end:
	return ret;
}

BT_HIDDEN
enum bt_self_component_status dummy_port_connected(
		struct bt_self_component_sink *comp,
		struct bt_self_component_port_input *self_port,
		struct bt_port_output *other_port)
{
	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	struct dummy *dummy;
	struct bt_self_component_port_input_notification_iterator *iterator;

	dummy = bt_self_component_get_data(
		bt_self_component_sink_borrow_self_component(comp));
	BT_ASSERT(dummy);
	iterator = bt_self_component_port_input_notification_iterator_create(
		self_port);
	if (!iterator) {
		status = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	BT_OBJECT_MOVE_REF(dummy->notif_iter, iterator);

end:
	return status;
}

BT_HIDDEN
enum bt_self_component_status dummy_consume(
		struct bt_self_component_sink *component)
{
	enum bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
	bt_notification_array notifs;
	uint64_t count;
	struct dummy *dummy;
	enum bt_notification_iterator_status it_ret;
	uint64_t i;

	dummy = bt_self_component_get_data(
		bt_self_component_sink_borrow_self_component(component));
	BT_ASSERT(dummy);

	if (unlikely(!dummy->notif_iter)) {
		ret = BT_SELF_COMPONENT_STATUS_END;
		goto end;
	}

	/* Consume one notification  */
	it_ret = bt_self_component_port_input_notification_iterator_next(
		dummy->notif_iter, &notifs, &count);
	switch (it_ret) {
	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
		ret = BT_SELF_COMPONENT_STATUS_OK;

		for (i = 0; i < count; i++) {
			bt_object_put_ref(notifs[i]);
		}

		break;
	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
		ret = BT_SELF_COMPONENT_STATUS_AGAIN;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_END:
		ret = BT_SELF_COMPONENT_STATUS_END;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
		ret = BT_SELF_COMPONENT_STATUS_ERROR;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
		ret = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	default:
		break;
	}

end:
	return ret;
}