[babeltrace.git] / plugins / utils / counter / counter.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 <babeltrace/common-internal.h>
#include <plugins-common.h>
#include <babeltrace/assert-internal.h>
#include <inttypes.h>
#include <stdint.h>

#include "counter.h"

#define PRINTF_COUNT(_what_sing, _what_plur, _var, args...)		\
	do {								\
		if (counter->count._var != 0 || !counter->hide_zero) {	\
			printf("%15" PRIu64 " %s\n",			\
				counter->count._var,			\
				counter->count._var == 1 ? _what_sing : _what_plur); \
		}							\
	} while (0)

static
uint64_t get_total_count(struct counter *counter)
{
	return counter->count.event +
		counter->count.stream_begin +
		counter->count.stream_end +
		counter->count.packet_begin +
		counter->count.packet_end +
		counter->count.inactivity +
		counter->count.other;
}

static
void print_count(struct counter *counter)
{
	uint64_t total = get_total_count(counter);

	PRINTF_COUNT("event", "events", event);
	PRINTF_COUNT("stream beginning", "stream beginnings", stream_begin);
	PRINTF_COUNT("stream end", "stream ends", stream_end);
	PRINTF_COUNT("packet beginning", "packet beginnings", packet_begin);
	PRINTF_COUNT("packet end", "packet ends", packet_end);
	PRINTF_COUNT("inactivity", "inactivities", inactivity);

	if (counter->count.other > 0) {
		PRINTF_COUNT("  other (unknown) notification",
			"  other (unknown) notifications", other);
	}

	printf("%s%15" PRIu64 " notification%s (TOTAL)%s\n",
		bt_common_color_bold(), total, total == 1 ? "" : "s",
		bt_common_color_reset());
	counter->last_printed_total = total;
}

static
void try_print_count(struct counter *counter, uint64_t notif_count)
{
	if (counter->step == 0) {
		/* No update */
		return;
	}

	counter->at += notif_count;

	if (counter->at >= counter->step) {
		counter->at = 0;
		print_count(counter);
		putchar('\n');
	}
}

static
void try_print_last(struct counter *counter)
{
	const uint64_t total = get_total_count(counter);

	if (total != counter->last_printed_total) {
		print_count(counter);
	}
}

void destroy_private_counter_data(struct counter *counter)
{
	bt_object_put_ref(counter->notif_iter);
	g_free(counter);
}

BT_HIDDEN
void counter_finalize(struct bt_self_component_sink *comp)
{
	struct counter *counter;

	BT_ASSERT(comp);
	counter = bt_self_component_get_data(
			bt_self_component_sink_as_self_component(comp));
	BT_ASSERT(counter);
	try_print_last(counter);
	bt_object_put_ref(counter->notif_iter);
	g_free(counter);
}

BT_HIDDEN
enum bt_self_component_status counter_init(
		struct bt_self_component_sink *component,
		const struct bt_value *params,
		UNUSED_VAR void *init_method_data)
{
	enum bt_self_component_status ret;
	struct counter *counter = g_new0(struct counter, 1);
	const struct bt_value *step = NULL;
	const struct bt_value *hide_zero = NULL;

	if (!counter) {
		ret = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto error;
	}

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

	counter->last_printed_total = -1ULL;
	counter->step = 1000;
	step = bt_value_map_borrow_entry_value_const(params, "step");
	if (step && bt_value_is_integer(step)) {
		int64_t val;

		val = bt_value_integer_get(step);
		if (val >= 0) {
			counter->step = (uint64_t) val;
		}
	}

	hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
	if (hide_zero && bt_value_is_bool(hide_zero)) {
		bt_bool val;

		val = bt_value_bool_get(hide_zero);
		counter->hide_zero = (bool) val;
	}

	bt_self_component_set_data(
		bt_self_component_sink_as_self_component(component),
		counter);
	goto end;

error:
	destroy_private_counter_data(counter);

end:
	return ret;
}

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

	counter = bt_self_component_get_data(
		bt_self_component_sink_as_self_component(comp));
	BT_ASSERT(counter);
	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(counter->notif_iter, iterator);

end:
	return status;
}

BT_HIDDEN
enum bt_self_component_status counter_consume(
		struct bt_self_component_sink *comp)
{
	enum bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
	struct counter *counter;
	enum bt_notification_iterator_status it_ret;
	uint64_t notif_count;
	bt_notification_array_const notifs;

	counter = bt_self_component_get_data(
			bt_self_component_sink_as_self_component(comp));
	BT_ASSERT(counter);

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

	/* Consume notifications */
	it_ret = bt_self_component_port_input_notification_iterator_next(
		counter->notif_iter, &notifs, &notif_count);
	if (it_ret < 0) {
		ret = BT_SELF_COMPONENT_STATUS_ERROR;
		goto end;
	}

	switch (it_ret) {
	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
	{
		uint64_t i;

		for (i = 0; i < notif_count; i++) {
			const struct bt_notification *notif = notifs[i];

			BT_ASSERT(notif);
			switch (bt_notification_get_type(notif)) {
			case BT_NOTIFICATION_TYPE_EVENT:
				counter->count.event++;
				break;
			case BT_NOTIFICATION_TYPE_INACTIVITY:
				counter->count.inactivity++;
				break;
			case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
				counter->count.stream_begin++;
				break;
			case BT_NOTIFICATION_TYPE_STREAM_END:
				counter->count.stream_end++;
				break;
			case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
				counter->count.packet_begin++;
				break;
			case BT_NOTIFICATION_TYPE_PACKET_END:
				counter->count.packet_end++;
				break;
			default:
				counter->count.other++;
			}

			bt_object_put_ref(notif);
		}

		ret = BT_SELF_COMPONENT_STATUS_OK;
		break;
	}
	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
		ret = BT_SELF_COMPONENT_STATUS_AGAIN;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_END:
		try_print_last(counter);
		ret = BT_SELF_COMPONENT_STATUS_END;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
		ret = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	default:
		break;
	}

	try_print_count(counter, notif_count);

end:
	return ret;
}
Commit	Line	Data
358340ec PP	1	/*
	2	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
	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
9d408fca	23	#include <babeltrace/babeltrace.h>
358340ec PP	24	#include <babeltrace/babeltrace-internal.h>
358340ec PP	25	#include <babeltrace/common-internal.h>
358340ec	26	#include <plugins-common.h>
f6ccaed9	27	#include <babeltrace/assert-internal.h>
358340ec PP	28	#include <inttypes.h>
	29	#include <stdint.h>
	30
	31	#include "counter.h"
	32
	33	#define PRINTF_COUNT(_what_sing, _what_plur, _var, args...) \
	34	do { \
	35	if (counter->count._var != 0 \|\| !counter->hide_zero) { \
	36	printf("%15" PRIu64 " %s\n", \
	37	counter->count._var, \
	38	counter->count._var == 1 ? _what_sing : _what_plur); \
	39	} \
	40	} while (0)
	41
	42	static
	43	uint64_t get_total_count(struct counter *counter)
	44	{
	45	return counter->count.event +
	46	counter->count.stream_begin +
	47	counter->count.stream_end +
	48	counter->count.packet_begin +
	49	counter->count.packet_end +
	50	counter->count.inactivity +
358340ec PP	51	counter->count.other;
	52	}
	53
	54	static
d4393e08	55	void print_count(struct counter *counter)
358340ec	56	{
d4393e08 PP	57	uint64_t total = get_total_count(counter);
d4393e08 PP	58
358340ec PP	59	PRINTF_COUNT("event", "events", event);
	60	PRINTF_COUNT("stream beginning", "stream beginnings", stream_begin);
	61	PRINTF_COUNT("stream end", "stream ends", stream_end);
	62	PRINTF_COUNT("packet beginning", "packet beginnings", packet_begin);
	63	PRINTF_COUNT("packet end", "packet ends", packet_end);
	64	PRINTF_COUNT("inactivity", "inactivities", inactivity);
358340ec PP	65
	66	if (counter->count.other > 0) {
	67	PRINTF_COUNT(" other (unknown) notification",
	68	" other (unknown) notifications", other);
	69	}
	70
	71	printf("%s%15" PRIu64 " notification%s (TOTAL)%s\n",
	72	bt_common_color_bold(), total, total == 1 ? "" : "s",
	73	bt_common_color_reset());
	74	counter->last_printed_total = total;
	75	}
	76
	77	static
d4393e08	78	void try_print_count(struct counter *counter, uint64_t notif_count)
358340ec	79	{
358340ec PP	80	if (counter->step == 0) {
	81	/* No update */
	82	return;
	83	}
	84
d4393e08	85	counter->at += notif_count;
358340ec	86
d4393e08 PP	87	if (counter->at >= counter->step) {
	88	counter->at = 0;
	89	print_count(counter);
358340ec PP	90	putchar('\n');
	91	}
	92	}
	93
	94	static
	95	void try_print_last(struct counter *counter)
	96	{
	97	const uint64_t total = get_total_count(counter);
	98
	99	if (total != counter->last_printed_total) {
d4393e08	100	print_count(counter);
358340ec PP	101	}
	102	}
	103
	104	void destroy_private_counter_data(struct counter *counter)
	105	{
65300d60	106	bt_object_put_ref(counter->notif_iter);
358340ec PP	107	g_free(counter);
	108	}
	109
d94d92ac PP	110	BT_HIDDEN
d94d92ac PP	111	void counter_finalize(struct bt_self_component_sink *comp)
358340ec PP	112	{
	113	struct counter *counter;
	114
d94d92ac PP	115	BT_ASSERT(comp);
d94d92ac PP	116	counter = bt_self_component_get_data(
707b7d35	117	bt_self_component_sink_as_self_component(comp));
f6ccaed9	118	BT_ASSERT(counter);
358340ec	119	try_print_last(counter);
65300d60	120	bt_object_put_ref(counter->notif_iter);
358340ec PP	121	g_free(counter);
	122	}
	123
d94d92ac PP	124	BT_HIDDEN
	125	enum bt_self_component_status counter_init(
	126	struct bt_self_component_sink *component,
05e21286 PP	127	const struct bt_value *params,
05e21286 PP	128	UNUSED_VAR void *init_method_data)
358340ec	129	{
d94d92ac	130	enum bt_self_component_status ret;
358340ec	131	struct counter *counter = g_new0(struct counter, 1);
05e21286 PP	132	const struct bt_value *step = NULL;
05e21286 PP	133	const struct bt_value *hide_zero = NULL;
358340ec PP	134
358340ec PP	135	if (!counter) {
d94d92ac PP	136	ret = BT_SELF_COMPONENT_STATUS_NOMEM;
d94d92ac PP	137	goto error;
358340ec PP	138	}
358340ec PP	139
d94d92ac	140	ret = bt_self_component_sink_add_input_port(component,
358340ec	141	"in", NULL, NULL);
d94d92ac PP	142	if (ret != BT_SELF_COMPONENT_STATUS_OK) {
d94d92ac PP	143	goto error;
358340ec PP	144	}
	145
	146	counter->last_printed_total = -1ULL;
	147	counter->step = 1000;
05e21286	148	step = bt_value_map_borrow_entry_value_const(params, "step");
f6ccaed9	149	if (step && bt_value_is_integer(step)) {
358340ec	150	int64_t val;
358340ec	151
601b0d3c	152	val = bt_value_integer_get(step);
358340ec PP	153	if (val >= 0) {
	154	counter->step = (uint64_t) val;
	155	}
	156	}
	157
05e21286	158	hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
f6ccaed9	159	if (hide_zero && bt_value_is_bool(hide_zero)) {
358340ec	160	bt_bool val;
358340ec	161
601b0d3c	162	val = bt_value_bool_get(hide_zero);
358340ec PP	163	counter->hide_zero = (bool) val;
	164	}
	165
d94d92ac	166	bt_self_component_set_data(
707b7d35	167	bt_self_component_sink_as_self_component(component),
d94d92ac	168	counter);
358340ec PP	169	goto end;
	170
	171	error:
	172	destroy_private_counter_data(counter);
	173
	174	end:
358340ec PP	175	return ret;
	176	}
	177
d94d92ac PP	178	BT_HIDDEN
	179	enum bt_self_component_status counter_port_connected(
	180	struct bt_self_component_sink *comp,
	181	struct bt_self_component_port_input *self_port,
0d72b8c3	182	const struct bt_port_output *other_port)
358340ec	183	{
d94d92ac	184	enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
358340ec	185	struct counter *counter;
d94d92ac	186	struct bt_self_component_port_input_notification_iterator *iterator;
358340ec	187
d94d92ac	188	counter = bt_self_component_get_data(
707b7d35	189	bt_self_component_sink_as_self_component(comp));
f6ccaed9	190	BT_ASSERT(counter);
d94d92ac PP	191	iterator = bt_self_component_port_input_notification_iterator_create(
	192	self_port);
	193	if (!iterator) {
	194	status = BT_SELF_COMPONENT_STATUS_NOMEM;
358340ec PP	195	goto end;
	196	}
	197
65300d60	198	BT_OBJECT_MOVE_REF(counter->notif_iter, iterator);
358340ec PP	199
358340ec PP	200	end:
bf55043c	201	return status;
358340ec PP	202	}
358340ec PP	203
d94d92ac PP	204	BT_HIDDEN
	205	enum bt_self_component_status counter_consume(
	206	struct bt_self_component_sink *comp)
358340ec	207	{
d94d92ac	208	enum bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
358340ec PP	209	struct counter *counter;
358340ec PP	210	enum bt_notification_iterator_status it_ret;
d4393e08	211	uint64_t notif_count;
0d72b8c3	212	bt_notification_array_const notifs;
358340ec	213
d94d92ac	214	counter = bt_self_component_get_data(
707b7d35	215	bt_self_component_sink_as_self_component(comp));
f6ccaed9	216	BT_ASSERT(counter);
358340ec	217
358340ec PP	218	if (unlikely(!counter->notif_iter)) {
358340ec PP	219	try_print_last(counter);
d94d92ac	220	ret = BT_SELF_COMPONENT_STATUS_END;
358340ec PP	221	goto end;
	222	}
	223
d4393e08	224	/* Consume notifications */
d94d92ac	225	it_ret = bt_self_component_port_input_notification_iterator_next(
d4393e08	226	counter->notif_iter, &notifs, &notif_count);
358340ec	227	if (it_ret < 0) {
d94d92ac	228	ret = BT_SELF_COMPONENT_STATUS_ERROR;
358340ec PP	229	goto end;
	230	}
	231
	232	switch (it_ret) {
358340ec PP	233	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
358340ec PP	234	{
d4393e08 PP	235	uint64_t i;
	236
	237	for (i = 0; i < notif_count; i++) {
0d72b8c3	238	const struct bt_notification *notif = notifs[i];
d4393e08 PP	239
	240	BT_ASSERT(notif);
	241	switch (bt_notification_get_type(notif)) {
	242	case BT_NOTIFICATION_TYPE_EVENT:
	243	counter->count.event++;
	244	break;
	245	case BT_NOTIFICATION_TYPE_INACTIVITY:
	246	counter->count.inactivity++;
	247	break;
	248	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
	249	counter->count.stream_begin++;
	250	break;
	251	case BT_NOTIFICATION_TYPE_STREAM_END:
	252	counter->count.stream_end++;
	253	break;
	254	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	255	counter->count.packet_begin++;
	256	break;
	257	case BT_NOTIFICATION_TYPE_PACKET_END:
	258	counter->count.packet_end++;
	259	break;
d4393e08 PP	260	default:
d4393e08 PP	261	counter->count.other++;
358340ec	262	}
d4393e08	263
65300d60	264	bt_object_put_ref(notif);
358340ec	265	}
d94d92ac PP	266
	267	ret = BT_SELF_COMPONENT_STATUS_OK;
	268	break;
358340ec	269	}
d94d92ac PP	270	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
	271	ret = BT_SELF_COMPONENT_STATUS_AGAIN;
	272	goto end;
	273	case BT_NOTIFICATION_ITERATOR_STATUS_END:
	274	try_print_last(counter);
	275	ret = BT_SELF_COMPONENT_STATUS_END;
	276	goto end;
	277	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
	278	ret = BT_SELF_COMPONENT_STATUS_NOMEM;
	279	goto end;
358340ec PP	280	default:
	281	break;
	282	}
	283
d4393e08	284	try_print_count(counter, notif_count);
358340ec PP	285
358340ec PP	286	end:
358340ec PP	287	return ret;
358340ec PP	288	}