[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, _var, args...)				\
	do {								\
		if (counter->count._var != 0 || !counter->hide_zero) {	\
			printf("%15" PRIu64 " %s message%s\n",		\
				counter->count._var,			\
				(_what),				\
				counter->count._var == 1 ? "" : "s");	\
		}							\
	} while (0)

static
const char * const in_port_name = "in";

static
uint64_t get_total_count(struct counter *counter)
{
	return counter->count.event +
		counter->count.stream_begin +
		counter->count.stream_end +
		counter->count.stream_activity_begin +
		counter->count.stream_activity_end +
		counter->count.packet_begin +
		counter->count.packet_end +
		counter->count.disc_events +
		counter->count.disc_packets +
		counter->count.msg_iter_inactivity +
		counter->count.other;
}

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

	PRINTF_COUNT("Event", event);
	PRINTF_COUNT("Stream beginning", stream_begin);
	PRINTF_COUNT("Stream end", stream_end);
	PRINTF_COUNT("Stream activity beginning", stream_activity_begin);
	PRINTF_COUNT("Stream activity end", stream_activity_end);
	PRINTF_COUNT("Packet beginning", packet_begin);
	PRINTF_COUNT("Packet end", packet_end);
	PRINTF_COUNT("Discarded event", disc_events);
	PRINTF_COUNT("Discarded packet", disc_packets);
	PRINTF_COUNT("Message iterator inactivity", msg_iter_inactivity);

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

	printf("%s%15" PRIu64 " message%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 msg_count)
{
	if (counter->step == 0) {
		/* No update */
		return;
	}

	counter->at += msg_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_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
	g_free(counter);
}

BT_HIDDEN
void counter_finalize(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_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
	g_free(counter);
}

BT_HIDDEN
bt_self_component_status counter_init(
		bt_self_component_sink *component,
		const bt_value *params,
		UNUSED_VAR void *init_method_data)
{
	bt_self_component_status ret;
	struct counter *counter = g_new0(struct counter, 1);
	const bt_value *step = NULL;
	const 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
bt_self_component_status counter_graph_is_configured(
		bt_self_component_sink *comp)
{
	bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	struct counter *counter;
	bt_self_component_port_input_message_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_message_iterator_create(
		bt_self_component_sink_borrow_input_port_by_name(comp,
			in_port_name));
	if (!iterator) {
		status = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
		counter->msg_iter, iterator);

end:
	return status;
}

BT_HIDDEN
bt_self_component_status counter_consume(
		bt_self_component_sink *comp)
{
	bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
	struct counter *counter;
	bt_message_iterator_status it_ret;
	uint64_t msg_count;
	bt_message_array_const msgs;

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

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

	/* Consume messages */
	it_ret = bt_self_component_port_input_message_iterator_next(
		counter->msg_iter, &msgs, &msg_count);
	if (it_ret < 0) {
		ret = BT_SELF_COMPONENT_STATUS_ERROR;
		goto end;
	}

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

		for (i = 0; i < msg_count; i++) {
			const bt_message *msg = msgs[i];

			BT_ASSERT(msg);
			switch (bt_message_get_type(msg)) {
			case BT_MESSAGE_TYPE_EVENT:
				counter->count.event++;
				break;
			case BT_MESSAGE_TYPE_PACKET_BEGINNING:
				counter->count.packet_begin++;
				break;
			case BT_MESSAGE_TYPE_PACKET_END:
				counter->count.packet_end++;
				break;
			case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
				counter->count.msg_iter_inactivity++;
				break;
			case BT_MESSAGE_TYPE_STREAM_BEGINNING:
				counter->count.stream_begin++;
				break;
			case BT_MESSAGE_TYPE_STREAM_END:
				counter->count.stream_end++;
				break;
			case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
				counter->count.stream_activity_begin++;
				break;
			case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
				counter->count.stream_activity_end++;
				break;
			case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
				counter->count.disc_events++;
				break;
			case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
				counter->count.disc_packets++;
				break;
			default:
				counter->count.other++;
			}

			bt_message_put_ref(msg);
		}

		ret = BT_SELF_COMPONENT_STATUS_OK;
		break;
	}
	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
		ret = BT_SELF_COMPONENT_STATUS_AGAIN;
		goto end;
	case BT_MESSAGE_ITERATOR_STATUS_END:
		try_print_last(counter);
		ret = BT_SELF_COMPONENT_STATUS_END;
		goto end;
	case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
		ret = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	default:
		break;
	}

	try_print_count(counter, msg_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
0e847b69	33	#define PRINTF_COUNT(_what, _var, args...) \
358340ec PP	34	do { \
358340ec PP	35	if (counter->count._var != 0 \|\| !counter->hide_zero) { \
0e847b69	36	printf("%15" PRIu64 " %s message%s\n", \
358340ec	37	counter->count._var, \
0e847b69 PP	38	(_what), \
0e847b69 PP	39	counter->count._var == 1 ? "" : "s"); \
358340ec PP	40	} \
	41	} while (0)
	42
5badd463 PP	43	static
	44	const char * const in_port_name = "in";
	45
358340ec PP	46	static
	47	uint64_t get_total_count(struct counter *counter)
	48	{
	49	return counter->count.event +
	50	counter->count.stream_begin +
	51	counter->count.stream_end +
0e847b69 PP	52	counter->count.stream_activity_begin +
0e847b69 PP	53	counter->count.stream_activity_end +
358340ec PP	54	counter->count.packet_begin +
358340ec PP	55	counter->count.packet_end +
0e847b69 PP	56	counter->count.disc_events +
0e847b69 PP	57	counter->count.disc_packets +
b9fd9cbb	58	counter->count.msg_iter_inactivity +
358340ec PP	59	counter->count.other;
	60	}
	61
	62	static
d4393e08	63	void print_count(struct counter *counter)
358340ec	64	{
d4393e08 PP	65	uint64_t total = get_total_count(counter);
d4393e08 PP	66
0e847b69 PP	67	PRINTF_COUNT("Event", event);
	68	PRINTF_COUNT("Stream beginning", stream_begin);
	69	PRINTF_COUNT("Stream end", stream_end);
	70	PRINTF_COUNT("Stream activity beginning", stream_activity_begin);
	71	PRINTF_COUNT("Stream activity end", stream_activity_end);
	72	PRINTF_COUNT("Packet beginning", packet_begin);
	73	PRINTF_COUNT("Packet end", packet_end);
	74	PRINTF_COUNT("Discarded event", disc_events);
	75	PRINTF_COUNT("Discarded packet", disc_packets);
	76	PRINTF_COUNT("Message iterator inactivity", msg_iter_inactivity);
358340ec PP	77
358340ec PP	78	if (counter->count.other > 0) {
0e847b69	79	PRINTF_COUNT("Other (unknown)", other);
358340ec PP	80	}
358340ec PP	81
d6e69534	82	printf("%s%15" PRIu64 " message%s (TOTAL)%s\n",
358340ec PP	83	bt_common_color_bold(), total, total == 1 ? "" : "s",
	84	bt_common_color_reset());
	85	counter->last_printed_total = total;
	86	}
	87
	88	static
d6e69534	89	void try_print_count(struct counter *counter, uint64_t msg_count)
358340ec	90	{
358340ec PP	91	if (counter->step == 0) {
	92	/* No update */
	93	return;
	94	}
	95
d6e69534	96	counter->at += msg_count;
358340ec	97
d4393e08 PP	98	if (counter->at >= counter->step) {
	99	counter->at = 0;
	100	print_count(counter);
358340ec PP	101	putchar('\n');
	102	}
	103	}
	104
	105	static
	106	void try_print_last(struct counter *counter)
	107	{
	108	const uint64_t total = get_total_count(counter);
	109
	110	if (total != counter->last_printed_total) {
d4393e08	111	print_count(counter);
358340ec PP	112	}
	113	}
	114
	115	void destroy_private_counter_data(struct counter *counter)
	116	{
d6e69534	117	bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
358340ec PP	118	g_free(counter);
	119	}
	120
d94d92ac	121	BT_HIDDEN
b19ff26f	122	void counter_finalize(bt_self_component_sink *comp)
358340ec PP	123	{
	124	struct counter *counter;
	125
d94d92ac PP	126	BT_ASSERT(comp);
d94d92ac PP	127	counter = bt_self_component_get_data(
707b7d35	128	bt_self_component_sink_as_self_component(comp));
f6ccaed9	129	BT_ASSERT(counter);
358340ec	130	try_print_last(counter);
d6e69534	131	bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
358340ec PP	132	g_free(counter);
	133	}
	134
d94d92ac	135	BT_HIDDEN
4cdfc5e8	136	bt_self_component_status counter_init(
b19ff26f PP	137	bt_self_component_sink *component,
b19ff26f PP	138	const bt_value *params,
05e21286	139	UNUSED_VAR void *init_method_data)
358340ec	140	{
4cdfc5e8	141	bt_self_component_status ret;
358340ec	142	struct counter *counter = g_new0(struct counter, 1);
b19ff26f PP	143	const bt_value *step = NULL;
b19ff26f PP	144	const bt_value *hide_zero = NULL;
358340ec PP	145
358340ec PP	146	if (!counter) {
d94d92ac PP	147	ret = BT_SELF_COMPONENT_STATUS_NOMEM;
d94d92ac PP	148	goto error;
358340ec PP	149	}
358340ec PP	150
d94d92ac	151	ret = bt_self_component_sink_add_input_port(component,
358340ec	152	"in", NULL, NULL);
d94d92ac PP	153	if (ret != BT_SELF_COMPONENT_STATUS_OK) {
d94d92ac PP	154	goto error;
358340ec PP	155	}
	156
	157	counter->last_printed_total = -1ULL;
	158	counter->step = 1000;
05e21286	159	step = bt_value_map_borrow_entry_value_const(params, "step");
f6ccaed9	160	if (step && bt_value_is_integer(step)) {
358340ec	161	int64_t val;
358340ec	162
601b0d3c	163	val = bt_value_integer_get(step);
358340ec PP	164	if (val >= 0) {
	165	counter->step = (uint64_t) val;
	166	}
	167	}
	168
05e21286	169	hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
f6ccaed9	170	if (hide_zero && bt_value_is_bool(hide_zero)) {
358340ec	171	bt_bool val;
358340ec	172
601b0d3c	173	val = bt_value_bool_get(hide_zero);
358340ec PP	174	counter->hide_zero = (bool) val;
	175	}
	176
d94d92ac	177	bt_self_component_set_data(
707b7d35	178	bt_self_component_sink_as_self_component(component),
d94d92ac	179	counter);
358340ec PP	180	goto end;
	181
	182	error:
	183	destroy_private_counter_data(counter);
	184
	185	end:
358340ec PP	186	return ret;
	187	}
	188
d94d92ac	189	BT_HIDDEN
5badd463 PP	190	bt_self_component_status counter_graph_is_configured(
5badd463 PP	191	bt_self_component_sink *comp)
358340ec	192	{
4cdfc5e8	193	bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
358340ec	194	struct counter *counter;
d6e69534	195	bt_self_component_port_input_message_iterator *iterator;
358340ec	196
d94d92ac	197	counter = bt_self_component_get_data(
707b7d35	198	bt_self_component_sink_as_self_component(comp));
f6ccaed9	199	BT_ASSERT(counter);
d6e69534	200	iterator = bt_self_component_port_input_message_iterator_create(
5badd463 PP	201	bt_self_component_sink_borrow_input_port_by_name(comp,
5badd463 PP	202	in_port_name));
d94d92ac PP	203	if (!iterator) {
d94d92ac PP	204	status = BT_SELF_COMPONENT_STATUS_NOMEM;
358340ec PP	205	goto end;
	206	}
	207
d6e69534 PP	208	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
d6e69534 PP	209	counter->msg_iter, iterator);
358340ec PP	210
358340ec PP	211	end:
bf55043c	212	return status;
358340ec PP	213	}
358340ec PP	214
d94d92ac	215	BT_HIDDEN
4cdfc5e8	216	bt_self_component_status counter_consume(
b19ff26f	217	bt_self_component_sink *comp)
358340ec	218	{
4cdfc5e8	219	bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
358340ec	220	struct counter *counter;
4cdfc5e8	221	bt_message_iterator_status it_ret;
d6e69534 PP	222	uint64_t msg_count;
d6e69534 PP	223	bt_message_array_const msgs;
358340ec	224
d94d92ac	225	counter = bt_self_component_get_data(
707b7d35	226	bt_self_component_sink_as_self_component(comp));
f6ccaed9	227	BT_ASSERT(counter);
358340ec	228
d6e69534	229	if (unlikely(!counter->msg_iter)) {
358340ec	230	try_print_last(counter);
d94d92ac	231	ret = BT_SELF_COMPONENT_STATUS_END;
358340ec PP	232	goto end;
	233	}
	234
d6e69534 PP	235	/* Consume messages */
	236	it_ret = bt_self_component_port_input_message_iterator_next(
	237	counter->msg_iter, &msgs, &msg_count);
358340ec	238	if (it_ret < 0) {
d94d92ac	239	ret = BT_SELF_COMPONENT_STATUS_ERROR;
358340ec PP	240	goto end;
	241	}
	242
	243	switch (it_ret) {
d6e69534	244	case BT_MESSAGE_ITERATOR_STATUS_OK:
358340ec	245	{
d4393e08 PP	246	uint64_t i;
d4393e08 PP	247
d6e69534 PP	248	for (i = 0; i < msg_count; i++) {
d6e69534 PP	249	const bt_message *msg = msgs[i];
d4393e08	250
d6e69534 PP	251	BT_ASSERT(msg);
	252	switch (bt_message_get_type(msg)) {
	253	case BT_MESSAGE_TYPE_EVENT:
d4393e08 PP	254	counter->count.event++;
d4393e08 PP	255	break;
0e847b69 PP	256	case BT_MESSAGE_TYPE_PACKET_BEGINNING:
	257	counter->count.packet_begin++;
	258	break;
	259	case BT_MESSAGE_TYPE_PACKET_END:
	260	counter->count.packet_end++;
	261	break;
b9fd9cbb FD	262	case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
b9fd9cbb FD	263	counter->count.msg_iter_inactivity++;
d4393e08	264	break;
d6e69534	265	case BT_MESSAGE_TYPE_STREAM_BEGINNING:
d4393e08 PP	266	counter->count.stream_begin++;
d4393e08 PP	267	break;
d6e69534	268	case BT_MESSAGE_TYPE_STREAM_END:
d4393e08 PP	269	counter->count.stream_end++;
d4393e08 PP	270	break;
0e847b69 PP	271	case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
0e847b69 PP	272	counter->count.stream_activity_begin++;
d4393e08	273	break;
0e847b69 PP	274	case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
	275	counter->count.stream_activity_end++;
	276	break;
	277	case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
	278	counter->count.disc_events++;
	279	break;
	280	case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
	281	counter->count.disc_packets++;
d4393e08	282	break;
d4393e08 PP	283	default:
d4393e08 PP	284	counter->count.other++;
358340ec	285	}
d4393e08	286
d6e69534	287	bt_message_put_ref(msg);
358340ec	288	}
d94d92ac PP	289
	290	ret = BT_SELF_COMPONENT_STATUS_OK;
	291	break;
358340ec	292	}
d6e69534	293	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
d94d92ac PP	294	ret = BT_SELF_COMPONENT_STATUS_AGAIN;
d94d92ac PP	295	goto end;
d6e69534	296	case BT_MESSAGE_ITERATOR_STATUS_END:
d94d92ac PP	297	try_print_last(counter);
	298	ret = BT_SELF_COMPONENT_STATUS_END;
	299	goto end;
d6e69534	300	case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
d94d92ac PP	301	ret = BT_SELF_COMPONENT_STATUS_NOMEM;
d94d92ac PP	302	goto end;
358340ec PP	303	default:
	304	break;
	305	}
	306
d6e69534	307	try_print_count(counter, msg_count);
358340ec PP	308
358340ec PP	309	end:
358340ec PP	310	return ret;
358340ec PP	311	}