2 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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
23 #define BT_COMP_LOG_SELF_COMP (counter->self_comp)
24 #define BT_LOG_OUTPUT_LEVEL (counter->log_level)
25 #define BT_LOG_TAG "PLUGIN/FLT.UTILS.COUNTER"
26 #include "plugins/comp-logging.h"
28 #include <babeltrace2/babeltrace.h>
29 #include "common/macros.h"
30 #include "common/common.h"
31 #include "common/assert.h"
37 #define PRINTF_COUNT(_what, _var, args...) \
39 if (counter->count._var != 0 || !counter->hide_zero) { \
40 printf("%15" PRIu64 " %s message%s\n", \
41 counter->count._var, \
43 counter->count._var == 1 ? "" : "s"); \
48 const char * const in_port_name
= "in";
51 uint64_t get_total_count(struct counter
*counter
)
53 return counter
->count
.event
+
54 counter
->count
.stream_begin
+
55 counter
->count
.stream_end
+
56 counter
->count
.packet_begin
+
57 counter
->count
.packet_end
+
58 counter
->count
.disc_events
+
59 counter
->count
.disc_packets
+
60 counter
->count
.msg_iter_inactivity
+
65 void print_count(struct counter
*counter
)
67 uint64_t total
= get_total_count(counter
);
69 PRINTF_COUNT("Event", event
);
70 PRINTF_COUNT("Stream beginning", stream_begin
);
71 PRINTF_COUNT("Stream end", stream_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
);
78 if (counter
->count
.other
> 0) {
79 PRINTF_COUNT("Other (unknown)", other
);
82 printf("%s%15" PRIu64
" message%s (TOTAL)%s\n",
83 bt_common_color_bold(), total
, total
== 1 ? "" : "s",
84 bt_common_color_reset());
85 counter
->last_printed_total
= total
;
89 void try_print_count(struct counter
*counter
, uint64_t msg_count
)
91 if (counter
->step
== 0) {
96 counter
->at
+= msg_count
;
98 if (counter
->at
>= counter
->step
) {
100 print_count(counter
);
106 void try_print_last(struct counter
*counter
)
108 const uint64_t total
= get_total_count(counter
);
110 if (total
!= counter
->last_printed_total
) {
111 print_count(counter
);
115 void destroy_private_counter_data(struct counter
*counter
)
117 bt_self_component_port_input_message_iterator_put_ref(counter
->msg_iter
);
122 void counter_finalize(bt_self_component_sink
*comp
)
124 struct counter
*counter
;
127 counter
= bt_self_component_get_data(
128 bt_self_component_sink_as_self_component(comp
));
130 try_print_last(counter
);
131 bt_self_component_port_input_message_iterator_put_ref(counter
->msg_iter
);
136 bt_component_class_init_method_status
counter_init(
137 bt_self_component_sink
*component
,
138 const bt_value
*params
,
139 __attribute__((unused
)) void *init_method_data
)
141 bt_component_class_init_method_status status
=
142 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
;
143 bt_self_component_add_port_status add_port_status
;
144 struct counter
*counter
= g_new0(struct counter
, 1);
145 const bt_value
*step
= NULL
;
146 const bt_value
*hide_zero
= NULL
;
149 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
154 bt_self_component_sink_as_self_component(component
);
155 counter
->log_level
= bt_component_get_logging_level(
156 bt_self_component_as_component(counter
->self_comp
));
157 add_port_status
= bt_self_component_sink_add_input_port(component
,
159 switch (add_port_status
) {
160 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR
:
161 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
163 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR
:
164 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
170 counter
->last_printed_total
= -1ULL;
171 counter
->step
= 10000;
172 step
= bt_value_map_borrow_entry_value_const(params
, "step");
174 if (!bt_value_is_unsigned_integer(step
)) {
175 BT_COMP_LOGE("`step` parameter: expecting an unsigned integer value: "
176 "type=%s", bt_common_value_type_string(
177 bt_value_get_type(step
)));
181 counter
->step
= bt_value_integer_unsigned_get(step
);
184 hide_zero
= bt_value_map_borrow_entry_value_const(params
, "hide-zero");
186 if (!bt_value_is_bool(hide_zero
)) {
187 BT_COMP_LOGE("`hide-zero` parameter: expecting a boolean value: "
188 "type=%s", bt_common_value_type_string(
189 bt_value_get_type(hide_zero
)));
193 counter
->hide_zero
= (bool) bt_value_bool_get(hide_zero
);
196 bt_self_component_set_data(
197 bt_self_component_sink_as_self_component(component
),
202 destroy_private_counter_data(counter
);
204 if (status
== BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
) {
205 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
213 bt_component_class_sink_graph_is_configured_method_status
214 counter_graph_is_configured(
215 bt_self_component_sink
*comp
)
217 bt_component_class_sink_graph_is_configured_method_status status
=
218 BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK
;
219 struct counter
*counter
;
220 bt_self_component_port_input_message_iterator
*iterator
;
222 counter
= bt_self_component_get_data(
223 bt_self_component_sink_as_self_component(comp
));
225 iterator
= bt_self_component_port_input_message_iterator_create_from_sink_component(
226 comp
, bt_self_component_sink_borrow_input_port_by_name(comp
,
229 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR
;
233 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
234 counter
->msg_iter
, iterator
);
241 bt_component_class_sink_consume_method_status
counter_consume(
242 bt_self_component_sink
*comp
)
244 bt_component_class_sink_consume_method_status status
=
245 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
246 struct counter
*counter
;
247 bt_message_iterator_next_status next_status
;
249 bt_message_array_const msgs
;
251 counter
= bt_self_component_get_data(
252 bt_self_component_sink_as_self_component(comp
));
255 if (G_UNLIKELY(!counter
->msg_iter
)) {
256 try_print_last(counter
);
257 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
261 /* Consume messages */
262 next_status
= bt_self_component_port_input_message_iterator_next(
263 counter
->msg_iter
, &msgs
, &msg_count
);
264 if (next_status
< 0) {
265 status
= (int) next_status
;
269 switch (next_status
) {
270 case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
:
274 for (i
= 0; i
< msg_count
; i
++) {
275 const bt_message
*msg
= msgs
[i
];
278 switch (bt_message_get_type(msg
)) {
279 case BT_MESSAGE_TYPE_EVENT
:
280 counter
->count
.event
++;
282 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
283 counter
->count
.packet_begin
++;
285 case BT_MESSAGE_TYPE_PACKET_END
:
286 counter
->count
.packet_end
++;
288 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
289 counter
->count
.msg_iter_inactivity
++;
291 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
292 counter
->count
.stream_begin
++;
294 case BT_MESSAGE_TYPE_STREAM_END
:
295 counter
->count
.stream_end
++;
297 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
298 counter
->count
.disc_events
++;
300 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
301 counter
->count
.disc_packets
++;
304 counter
->count
.other
++;
307 bt_message_put_ref(msg
);
310 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
313 case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN
:
314 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN
;
316 case BT_MESSAGE_ITERATOR_NEXT_STATUS_END
:
317 try_print_last(counter
);
318 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
320 case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR
:
321 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR
;
327 try_print_count(counter
, msg_count
);