[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 <assert.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.discarded_events +
		counter->count.discarded_packets +
		counter->count.other;
}

static
void print_count(struct counter *counter, uint64_t total)
{
	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);
	PRINTF_COUNT("discarded events notification",
		"discarded events notifications", discarded_events_notifs);
	PRINTF_COUNT("  known discarded event", "  known discarded events",
		discarded_events);
	PRINTF_COUNT("discarded packets notification",
		"discarded packets notifications", discarded_packets_notifs);
	PRINTF_COUNT("  known discarded packet", "  known discarded packets",
		discarded_packets);

	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 total;

	if (counter->step == 0) {
		/* No update */
		return;
	}

	total = get_total_count(counter);

	if (total % counter->step == 0) {
		print_count(counter, total);
		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, total);
	}
}

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

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

	assert(component);
	counter = bt_private_component_get_user_data(component);
	assert(counter);
	try_print_last(counter);
	bt_put(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_private_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_get(params, "step");
	if (bt_value_is_integer(step)) {
		int64_t val;
		int vret = bt_value_integer_get(step, &val);

		assert(vret == 0);

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

	hide_zero = bt_value_map_get(params, "hide-zero");
	if (bt_value_is_bool(hide_zero)) {
		bt_bool val;
		int vret = bt_value_bool_get(hide_zero, &val);

		assert(vret == 0);
		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:
	bt_put(step);
	bt_put(hide_zero);
	return ret;
}

void counter_port_connected(
		struct bt_private_component *component,
		struct bt_private_port *self_port,
		struct bt_port *other_port)
{
	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);
	assert(counter);
	connection = bt_private_port_get_private_connection(self_port);
	assert(connection);
	conn_status = bt_private_connection_create_notification_iterator(
		connection, NULL, &iterator);
	if (conn_status != BT_CONNECTION_STATUS_OK) {
		counter->error = true;
		goto end;
	}

	BT_MOVE(counter->notif_iter, iterator);

end:
	bt_put(connection);
}

enum bt_component_status counter_consume(struct bt_private_component *component)
{
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
	struct bt_notification *notif = NULL;
	struct counter *counter;
	enum bt_notification_iterator_status it_ret;
	int64_t count;

	counter = bt_private_component_get_user_data(component);
	assert(counter);

	if (unlikely(counter->error)) {
		ret = BT_COMPONENT_STATUS_ERROR;
		goto end;
	}

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

	/* Consume one notification  */
	it_ret = bt_notification_iterator_next(counter->notif_iter);
	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:
	{
		struct bt_notification *notif =
			bt_notification_iterator_get_notification(counter->notif_iter);

		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;
		case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
			counter->count.discarded_events_notifs++;
			count = bt_notification_discarded_events_get_count(
				notif);
			if (count >= 0) {
				counter->count.discarded_events += count;
			}
			break;
		case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
			counter->count.discarded_packets_notifs++;
			count = bt_notification_discarded_packets_get_count(
				notif);
			if (count >= 0) {
				counter->count.discarded_packets += count;
			}
			break;
		default:
			counter->count.other++;
		}

		bt_put(notif);
	}
	default:
		break;
	}

	try_print_count(counter);

end:
	bt_put(notif);
	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 PP	26	#include <plugins-common.h>
	27	#include <assert.h>
	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 +
	51	counter->count.discarded_events +
	52	counter->count.discarded_packets +
	53	counter->count.other;
	54	}
	55
	56	static
	57	void print_count(struct counter *counter, uint64_t total)
	58	{
	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);
	65	PRINTF_COUNT("discarded events notification",
	66	"discarded events notifications", discarded_events_notifs);
	67	PRINTF_COUNT(" known discarded event", " known discarded events",
	68	discarded_events);
	69	PRINTF_COUNT("discarded packets notification",
	70	"discarded packets notifications", discarded_packets_notifs);
	71	PRINTF_COUNT(" known discarded packet", " known discarded packets",
	72	discarded_packets);
	73
	74	if (counter->count.other > 0) {
	75	PRINTF_COUNT(" other (unknown) notification",
	76	" other (unknown) notifications", other);
	77	}
	78
	79	printf("%s%15" PRIu64 " notification%s (TOTAL)%s\n",
	80	bt_common_color_bold(), total, total == 1 ? "" : "s",
	81	bt_common_color_reset());
	82	counter->last_printed_total = total;
	83	}
	84
	85	static
	86	void try_print_count(struct counter *counter)
	87	{
	88	uint64_t total;
	89
90	if (counter->step == 0) {
91	/* No update */
92	return;
93	}
94
95	total = get_total_count(counter);
96
97	if (total % counter->step == 0) {
98	print_count(counter, total);
99	putchar('\n');
100	}
101	}
102
103	static
104	void try_print_last(struct counter *counter)
105	{
106	const uint64_t total = get_total_count(counter);
107
108	if (total != counter->last_printed_total) {
109	print_count(counter, total);
110	}
111	}
112
113	void destroy_private_counter_data(struct counter *counter)
114	{
115	bt_put(counter->notif_iter);
116	g_free(counter);
117	}
118
119	void counter_finalize(struct bt_private_component *component)
120	{
121	struct counter *counter;
122
123	assert(component);
124	counter = bt_private_component_get_user_data(component);
125	assert(counter);
126	try_print_last(counter);
127	bt_put(counter->notif_iter);
128	g_free(counter);
129	}
130
131	enum bt_component_status counter_init(struct bt_private_component *component,
132	struct bt_value params, UNUSED_VAR void init_method_data)
133	{
134	enum bt_component_status ret;
135	struct counter *counter = g_new0(struct counter, 1);
136	struct bt_value *step = NULL;
137	struct bt_value *hide_zero = NULL;
138
139	if (!counter) {
140	ret = BT_COMPONENT_STATUS_NOMEM;
141	goto end;
142	}
143
144	ret = bt_private_component_sink_add_input_private_port(component,
145	"in", NULL, NULL);
146	if (ret != BT_COMPONENT_STATUS_OK) {
147	goto end;
148	}
149
150	counter->last_printed_total = -1ULL;
151	counter->step = 1000;
152	step = bt_value_map_get(params, "step");
153	if (bt_value_is_integer(step)) {
154	int64_t val;
155	int vret = bt_value_integer_get(step, &val);
156
157	assert(vret == 0);
158
159	if (val >= 0) {
160	counter->step = (uint64_t) val;
161	}
162	}
163
164	hide_zero = bt_value_map_get(params, "hide-zero");
165	if (bt_value_is_bool(hide_zero)) {
166	bt_bool val;
167	int vret = bt_value_bool_get(hide_zero, &val);
168
169	assert(vret == 0);
170	counter->hide_zero = (bool) val;
171	}
172
173	ret = bt_private_component_set_user_data(component, counter);
174	if (ret != BT_COMPONENT_STATUS_OK) {
175	goto error;
176	}
177
178	goto end;
179
180	error:
181	destroy_private_counter_data(counter);
182
183	end:
184	bt_put(step);
185	bt_put(hide_zero);
186	return ret;
187	}
188
189	void counter_port_connected(
190	struct bt_private_component *component,
191	struct bt_private_port *self_port,
192	struct bt_port *other_port)
193	{
194	struct counter *counter;
195	struct bt_notification_iterator *iterator;
196	struct bt_private_connection *connection;
197	enum bt_connection_status conn_status;
198
199	counter = bt_private_component_get_user_data(component);
200	assert(counter);
201	connection = bt_private_port_get_private_connection(self_port);
202	assert(connection);
203	conn_status = bt_private_connection_create_notification_iterator(
204	connection, NULL, &iterator);
205	if (conn_status != BT_CONNECTION_STATUS_OK) {
206	counter->error = true;
207	goto end;
208	}
209
210	BT_MOVE(counter->notif_iter, iterator);
211
212	end:
213	bt_put(connection);
214	}
215
216	enum bt_component_status counter_consume(struct bt_private_component *component)
217	{
218	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
219	struct bt_notification *notif = NULL;
220	struct counter *counter;
221	enum bt_notification_iterator_status it_ret;
222	int64_t count;
223
224	counter = bt_private_component_get_user_data(component);
225	assert(counter);
226
227	if (unlikely(counter->error)) {
228	ret = BT_COMPONENT_STATUS_ERROR;
229	goto end;
230	}
231
232	if (unlikely(!counter->notif_iter)) {
233	try_print_last(counter);
234	ret = BT_COMPONENT_STATUS_END;
235	goto end;
236	}
237
238	/* Consume one notification */
239	it_ret = bt_notification_iterator_next(counter->notif_iter);
240	if (it_ret < 0) {
241	ret = BT_COMPONENT_STATUS_ERROR;
242	goto end;
243	}
244
245	switch (it_ret) {
246	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
247	ret = BT_COMPONENT_STATUS_AGAIN;
248	goto end;
249	case BT_NOTIFICATION_ITERATOR_STATUS_END:
250	try_print_last(counter);
251	ret = BT_COMPONENT_STATUS_END;
252	goto end;
253	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
254	{
255	struct bt_notification *notif =
256	bt_notification_iterator_get_notification(counter->notif_iter);
257
258	assert(notif);
259	switch (bt_notification_get_type(notif)) {
260	case BT_NOTIFICATION_TYPE_EVENT:
261	counter->count.event++;
262	break;
263	case BT_NOTIFICATION_TYPE_INACTIVITY:
264	counter->count.inactivity++;
265	break;
266	case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
267	counter->count.stream_begin++;
268	break;
269	case BT_NOTIFICATION_TYPE_STREAM_END:
270	counter->count.stream_end++;
271	break;
272	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
273	counter->count.packet_begin++;
274	break;
275	case BT_NOTIFICATION_TYPE_PACKET_END:
276	counter->count.packet_end++;
277	break;
278	case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
279	counter->count.discarded_events_notifs++;
280	count = bt_notification_discarded_events_get_count(
281	notif);
282	if (count >= 0) {
283	counter->count.discarded_events += count;
284	}
285	break;
286	case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
287	counter->count.discarded_packets_notifs++;
288	count = bt_notification_discarded_packets_get_count(
289	notif);
290	if (count >= 0) {
291	counter->count.discarded_packets += count;
292	}
293	break;
294	default:
295	counter->count.other++;
296	}
297
298	bt_put(notif);
299	}
300	default:
301	break;
302	}
303
304	try_print_count(counter);
305
306	end:
307	bt_put(notif);
308	return ret;
309	}