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 "logging/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
)
118 bt_self_component_port_input_message_iterator_put_ref(
125 void counter_finalize(bt_self_component_sink
*comp
)
127 struct counter
*counter
;
130 counter
= bt_self_component_get_data(
131 bt_self_component_sink_as_self_component(comp
));
133 try_print_last(counter
);
134 bt_self_component_port_input_message_iterator_put_ref(counter
->msg_iter
);
139 bt_component_class_init_method_status
counter_init(
140 bt_self_component_sink
*component
,
141 const bt_value
*params
,
142 __attribute__((unused
)) void *init_method_data
)
144 bt_component_class_init_method_status status
=
145 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
;
146 bt_self_component_add_port_status add_port_status
;
147 struct counter
*counter
= g_new0(struct counter
, 1);
148 const bt_value
*step
= NULL
;
149 const bt_value
*hide_zero
= NULL
;
152 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
157 bt_self_component_sink_as_self_component(component
);
158 counter
->log_level
= bt_component_get_logging_level(
159 bt_self_component_as_component(counter
->self_comp
));
160 add_port_status
= bt_self_component_sink_add_input_port(component
,
162 switch (add_port_status
) {
163 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR
:
164 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
166 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR
:
167 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
173 counter
->last_printed_total
= -1ULL;
174 counter
->step
= 10000;
175 step
= bt_value_map_borrow_entry_value_const(params
, "step");
177 if (!bt_value_is_unsigned_integer(step
)) {
178 BT_COMP_LOGE("`step` parameter: expecting an unsigned integer value: "
179 "type=%s", bt_common_value_type_string(
180 bt_value_get_type(step
)));
184 counter
->step
= bt_value_integer_unsigned_get(step
);
187 hide_zero
= bt_value_map_borrow_entry_value_const(params
, "hide-zero");
189 if (!bt_value_is_bool(hide_zero
)) {
190 BT_COMP_LOGE("`hide-zero` parameter: expecting a boolean value: "
191 "type=%s", bt_common_value_type_string(
192 bt_value_get_type(hide_zero
)));
196 counter
->hide_zero
= (bool) bt_value_bool_get(hide_zero
);
199 bt_self_component_set_data(
200 bt_self_component_sink_as_self_component(component
),
205 destroy_private_counter_data(counter
);
207 if (status
== BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
) {
208 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
216 bt_component_class_sink_graph_is_configured_method_status
217 counter_graph_is_configured(
218 bt_self_component_sink
*comp
)
220 bt_component_class_sink_graph_is_configured_method_status status
=
221 BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK
;
222 struct counter
*counter
;
223 bt_self_component_port_input_message_iterator
*iterator
;
225 counter
= bt_self_component_get_data(
226 bt_self_component_sink_as_self_component(comp
));
228 iterator
= bt_self_component_port_input_message_iterator_create_from_sink_component(
229 comp
, bt_self_component_sink_borrow_input_port_by_name(comp
,
232 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR
;
236 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
237 counter
->msg_iter
, iterator
);
244 bt_component_class_sink_consume_method_status
counter_consume(
245 bt_self_component_sink
*comp
)
247 bt_component_class_sink_consume_method_status status
=
248 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
249 struct counter
*counter
;
250 bt_message_iterator_next_status next_status
;
252 bt_message_array_const msgs
;
254 counter
= bt_self_component_get_data(
255 bt_self_component_sink_as_self_component(comp
));
258 if (G_UNLIKELY(!counter
->msg_iter
)) {
259 try_print_last(counter
);
260 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
264 /* Consume messages */
265 next_status
= bt_self_component_port_input_message_iterator_next(
266 counter
->msg_iter
, &msgs
, &msg_count
);
267 if (next_status
< 0) {
268 status
= (int) next_status
;
272 switch (next_status
) {
273 case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
:
277 for (i
= 0; i
< msg_count
; i
++) {
278 const bt_message
*msg
= msgs
[i
];
281 switch (bt_message_get_type(msg
)) {
282 case BT_MESSAGE_TYPE_EVENT
:
283 counter
->count
.event
++;
285 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
286 counter
->count
.packet_begin
++;
288 case BT_MESSAGE_TYPE_PACKET_END
:
289 counter
->count
.packet_end
++;
291 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
292 counter
->count
.msg_iter_inactivity
++;
294 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
295 counter
->count
.stream_begin
++;
297 case BT_MESSAGE_TYPE_STREAM_END
:
298 counter
->count
.stream_end
++;
300 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
301 counter
->count
.disc_events
++;
303 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
304 counter
->count
.disc_packets
++;
307 counter
->count
.other
++;
310 bt_message_put_ref(msg
);
313 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
316 case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN
:
317 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN
;
319 case BT_MESSAGE_ITERATOR_NEXT_STATUS_END
:
320 try_print_last(counter
);
321 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
323 case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR
:
324 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR
;
330 try_print_count(counter
, msg_count
);