[babeltrace.git] / plugins / utils / counter / counter.h

#ifndef BABELTRACE_PLUGINS_UTILS_COUNTER_H
#define BABELTRACE_PLUGINS_UTILS_COUNTER_H

/*
 * 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 <glib.h>
#include <babeltrace/babeltrace.h>
#include <stdbool.h>
#include <stdint.h>

struct counter {
	bt_self_component_port_input_notification_iterator *notif_iter;
	struct {
		uint64_t event;
		uint64_t stream_begin;
		uint64_t stream_end;
		uint64_t packet_begin;
		uint64_t packet_end;
		uint64_t inactivity;
		uint64_t other;
	} count;
	uint64_t last_printed_total;
	uint64_t at;
	uint64_t step;
	bool hide_zero;
};

BT_HIDDEN
enum bt_self_component_status counter_init(
		bt_self_component_sink *component,
		const bt_value *params, void *init_method_data);

BT_HIDDEN
void counter_finalize(bt_self_component_sink *component);

BT_HIDDEN
enum bt_self_component_status counter_port_connected(
		bt_self_component_sink *component,
		bt_self_component_port_input *self_port,
		const bt_port_output *other_port);

BT_HIDDEN
enum bt_self_component_status counter_consume(bt_self_component_sink *component);

#endif /* BABELTRACE_PLUGINS_UTILS_COUNTER_H */
Commit	Line	Data
358340ec PP	1	#ifndef BABELTRACE_PLUGINS_UTILS_COUNTER_H
	2	#define BABELTRACE_PLUGINS_UTILS_COUNTER_H
	3
	4	/*
	5	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#include <glib.h>
9d408fca	27	#include <babeltrace/babeltrace.h>
358340ec PP	28	#include <stdbool.h>
	29	#include <stdint.h>
	30
	31	struct counter {
b19ff26f	32	bt_self_component_port_input_notification_iterator *notif_iter;
358340ec PP	33	struct {
	34	uint64_t event;
	35	uint64_t stream_begin;
	36	uint64_t stream_end;
	37	uint64_t packet_begin;
	38	uint64_t packet_end;
	39	uint64_t inactivity;
358340ec PP	40	uint64_t other;
	41	} count;
	42	uint64_t last_printed_total;
d4393e08	43	uint64_t at;
358340ec PP	44	uint64_t step;
358340ec PP	45	bool hide_zero;
358340ec PP	46	};
358340ec PP	47
d94d92ac PP	48	BT_HIDDEN
d94d92ac PP	49	enum bt_self_component_status counter_init(
b19ff26f PP	50	bt_self_component_sink *component,
b19ff26f PP	51	const bt_value params, void init_method_data);
d94d92ac PP	52
d94d92ac PP	53	BT_HIDDEN
b19ff26f	54	void counter_finalize(bt_self_component_sink *component);
d94d92ac PP	55
	56	BT_HIDDEN
	57	enum bt_self_component_status counter_port_connected(
b19ff26f PP	58	bt_self_component_sink *component,
	59	bt_self_component_port_input *self_port,
	60	const bt_port_output *other_port);
d94d92ac PP	61
d94d92ac PP	62	BT_HIDDEN
b19ff26f	63	enum bt_self_component_status counter_consume(bt_self_component_sink *component);
358340ec PP	64
358340ec PP	65	#endif /* BABELTRACE_PLUGINS_UTILS_COUNTER_H */