[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);
}

void counter_finalize(struct bt_private_component *component)
{
	struct counter *counter;

	BT_ASSERT(component);
	counter = bt_private_component_get_user_data(component);
	BT_ASSERT(counter);
	try_print_last(counter);
	bt_object_put_ref(counter->notif_iter);
	g_free(counter);
}

enum bt_component_status counter_init(struct bt_private_component *component,
		struct bt_value *params, UNUSED_VAR void *init_method_data)
{
	enum bt_component_status ret;
	struct counter *counter = g_new0(struct counter, 1);
	struct bt_value *step = NULL;
	struct bt_value *hide_zero = NULL;

	if (!counter) {
		ret = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_private_component_sink_add_input_port(component,
		"in", NULL, NULL);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto end;
	}

	counter->last_printed_total = -1ULL;
	counter->step = 1000;
	step = bt_value_map_borrow_entry_value(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(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;
	}

	ret = bt_private_component_set_user_data(component, counter);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	goto end;

error:
	destroy_private_counter_data(counter);

end:
	return ret;
}

enum bt_component_status counter_port_connected(
		struct bt_private_component *component,
		struct bt_private_port *self_port,
		struct bt_port *other_port)
{
	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
	struct counter *counter;
	struct bt_notification_iterator *iterator;
	struct bt_private_connection *connection;
	enum bt_connection_status conn_status;

	counter = bt_private_component_get_user_data(component);
	BT_ASSERT(counter);
	connection = bt_private_port_get_connection(self_port);
	BT_ASSERT(connection);
	conn_status = bt_private_connection_create_notification_iterator(
		connection, &iterator);
	if (conn_status != BT_CONNECTION_STATUS_OK) {
		status = BT_COMPONENT_STATUS_ERROR;
		goto end;
	}

	BT_OBJECT_MOVE_REF(counter->notif_iter, iterator);

end:
	bt_object_put_ref(connection);
	return status;
}

enum bt_component_status counter_consume(struct bt_private_component *component)
{
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
	struct counter *counter;
	enum bt_notification_iterator_status it_ret;
	uint64_t notif_count;
	bt_notification_array notifs;

	counter = bt_private_component_get_user_data(component);
	BT_ASSERT(counter);

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

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

	switch (it_ret) {
	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
		ret = BT_COMPONENT_STATUS_AGAIN;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_END:
		try_print_last(counter);
		ret = BT_COMPONENT_STATUS_END;
		goto end;
	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
	{
		uint64_t i;

		for (i = 0; i < notif_count; i++) {
			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);
		}
	}
	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
	110	void counter_finalize(struct bt_private_component *component)
	111	{
	112	struct counter *counter;
	113
f6ccaed9	114	BT_ASSERT(component);
358340ec	115	counter = bt_private_component_get_user_data(component);
f6ccaed9	116	BT_ASSERT(counter);
358340ec	117	try_print_last(counter);
65300d60	118	bt_object_put_ref(counter->notif_iter);
358340ec PP	119	g_free(counter);
	120	}
	121
	122	enum bt_component_status counter_init(struct bt_private_component *component,
	123	struct bt_value params, UNUSED_VAR void init_method_data)
	124	{
	125	enum bt_component_status ret;
	126	struct counter *counter = g_new0(struct counter, 1);
	127	struct bt_value *step = NULL;
	128	struct bt_value *hide_zero = NULL;
	129
	130	if (!counter) {
	131	ret = BT_COMPONENT_STATUS_NOMEM;
	132	goto end;
	133	}
	134
28e6ca8b	135	ret = bt_private_component_sink_add_input_port(component,
358340ec PP	136	"in", NULL, NULL);
	137	if (ret != BT_COMPONENT_STATUS_OK) {
	138	goto end;
	139	}
	140
	141	counter->last_printed_total = -1ULL;
	142	counter->step = 1000;
07208d85	143	step = bt_value_map_borrow_entry_value(params, "step");
f6ccaed9	144	if (step && bt_value_is_integer(step)) {
358340ec	145	int64_t val;
358340ec	146
601b0d3c	147	val = bt_value_integer_get(step);
358340ec PP	148	if (val >= 0) {
	149	counter->step = (uint64_t) val;
	150	}
	151	}
	152
07208d85	153	hide_zero = bt_value_map_borrow_entry_value(params, "hide-zero");
f6ccaed9	154	if (hide_zero && bt_value_is_bool(hide_zero)) {
358340ec	155	bt_bool val;
358340ec	156
601b0d3c	157	val = bt_value_bool_get(hide_zero);
358340ec PP	158	counter->hide_zero = (bool) val;
	159	}
	160
	161	ret = bt_private_component_set_user_data(component, counter);
	162	if (ret != BT_COMPONENT_STATUS_OK) {
	163	goto error;
	164	}
	165
	166	goto end;
	167
	168	error:
	169	destroy_private_counter_data(counter);
	170
	171	end:
358340ec PP	172	return ret;
	173	}
	174
bf55043c	175	enum bt_component_status counter_port_connected(
358340ec PP	176	struct bt_private_component *component,
	177	struct bt_private_port *self_port,
	178	struct bt_port *other_port)
	179	{
bf55043c	180	enum bt_component_status status = BT_COMPONENT_STATUS_OK;
358340ec PP	181	struct counter *counter;
	182	struct bt_notification_iterator *iterator;
	183	struct bt_private_connection *connection;
	184	enum bt_connection_status conn_status;
	185
	186	counter = bt_private_component_get_user_data(component);
f6ccaed9	187	BT_ASSERT(counter);
28e6ca8b	188	connection = bt_private_port_get_connection(self_port);
f6ccaed9	189	BT_ASSERT(connection);
358340ec	190	conn_status = bt_private_connection_create_notification_iterator(
f42867e2	191	connection, &iterator);
358340ec	192	if (conn_status != BT_CONNECTION_STATUS_OK) {
bf55043c	193	status = BT_COMPONENT_STATUS_ERROR;
358340ec PP	194	goto end;
	195	}
	196
65300d60	197	BT_OBJECT_MOVE_REF(counter->notif_iter, iterator);
358340ec PP	198
358340ec PP	199	end:
65300d60	200	bt_object_put_ref(connection);
bf55043c	201	return status;
358340ec PP	202	}
	203
	204	enum bt_component_status counter_consume(struct bt_private_component *component)
	205	{
	206	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
358340ec PP	207	struct counter *counter;
358340ec PP	208	enum bt_notification_iterator_status it_ret;
d4393e08 PP	209	uint64_t notif_count;
d4393e08 PP	210	bt_notification_array notifs;
358340ec PP	211
358340ec PP	212	counter = bt_private_component_get_user_data(component);
f6ccaed9	213	BT_ASSERT(counter);
358340ec	214
358340ec PP	215	if (unlikely(!counter->notif_iter)) {
	216	try_print_last(counter);
	217	ret = BT_COMPONENT_STATUS_END;
	218	goto end;
	219	}
	220
d4393e08	221	/* Consume notifications */
07245ac2	222	it_ret = bt_private_connection_notification_iterator_next(
d4393e08	223	counter->notif_iter, &notifs, &notif_count);
358340ec PP	224	if (it_ret < 0) {
	225	ret = BT_COMPONENT_STATUS_ERROR;
	226	goto end;
	227	}
	228
	229	switch (it_ret) {
	230	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
	231	ret = BT_COMPONENT_STATUS_AGAIN;
	232	goto end;
	233	case BT_NOTIFICATION_ITERATOR_STATUS_END:
	234	try_print_last(counter);
	235	ret = BT_COMPONENT_STATUS_END;
	236	goto end;
	237	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
	238	{
d4393e08 PP	239	uint64_t i;
	240
	241	for (i = 0; i < notif_count; i++) {
	242	struct bt_notification *notif = notifs[i];
	243
	244	BT_ASSERT(notif);
	245	switch (bt_notification_get_type(notif)) {
	246	case BT_NOTIFICATION_TYPE_EVENT:
	247	counter->count.event++;
	248	break;
	249	case BT_NOTIFICATION_TYPE_INACTIVITY:
	250	counter->count.inactivity++;
	251	break;
	252	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
	253	counter->count.stream_begin++;
	254	break;
	255	case BT_NOTIFICATION_TYPE_STREAM_END:
	256	counter->count.stream_end++;
	257	break;
	258	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	259	counter->count.packet_begin++;
	260	break;
	261	case BT_NOTIFICATION_TYPE_PACKET_END:
	262	counter->count.packet_end++;
	263	break;
d4393e08 PP	264	default:
d4393e08 PP	265	counter->count.other++;
358340ec	266	}
d4393e08	267
65300d60	268	bt_object_put_ref(notif);
358340ec	269	}
358340ec PP	270	}
	271	default:
	272	break;
	273	}
	274
d4393e08	275	try_print_count(counter, notif_count);
358340ec PP	276
358340ec PP	277	end:
358340ec PP	278	return ret;
358340ec PP	279	}