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"
34 #include "plugins/common/param-validation/param-validation.h"
38 #define PRINTF_COUNT(_what, _var, args...) \
40 if (counter->count._var != 0 || !counter->hide_zero) { \
41 printf("%15" PRIu64 " %s message%s\n", \
42 counter->count._var, \
44 counter->count._var == 1 ? "" : "s"); \
49 const char * const in_port_name
= "in";
52 uint64_t get_total_count(struct counter
*counter
)
54 return counter
->count
.event
+
55 counter
->count
.stream_begin
+
56 counter
->count
.stream_end
+
57 counter
->count
.packet_begin
+
58 counter
->count
.packet_end
+
59 counter
->count
.disc_events
+
60 counter
->count
.disc_packets
+
61 counter
->count
.msg_iter_inactivity
+
66 void print_count(struct counter
*counter
)
68 uint64_t total
= get_total_count(counter
);
70 PRINTF_COUNT("Event", event
);
71 PRINTF_COUNT("Stream beginning", stream_begin
);
72 PRINTF_COUNT("Stream end", stream_end
);
73 PRINTF_COUNT("Packet beginning", packet_begin
);
74 PRINTF_COUNT("Packet end", packet_end
);
75 PRINTF_COUNT("Discarded event", disc_events
);
76 PRINTF_COUNT("Discarded packet", disc_packets
);
77 PRINTF_COUNT("Message iterator inactivity", msg_iter_inactivity
);
79 if (counter
->count
.other
> 0) {
80 PRINTF_COUNT("Other (unknown)", other
);
83 printf("%s%15" PRIu64
" message%s (TOTAL)%s\n",
84 bt_common_color_bold(), total
, total
== 1 ? "" : "s",
85 bt_common_color_reset());
86 counter
->last_printed_total
= total
;
90 void try_print_count(struct counter
*counter
, uint64_t msg_count
)
92 if (counter
->step
== 0) {
97 counter
->at
+= msg_count
;
99 if (counter
->at
>= counter
->step
) {
101 print_count(counter
);
107 void try_print_last(struct counter
*counter
)
109 const uint64_t total
= get_total_count(counter
);
111 if (total
!= counter
->last_printed_total
) {
112 print_count(counter
);
117 void destroy_private_counter_data(struct counter
*counter
)
120 bt_self_component_port_input_message_iterator_put_ref(
127 void counter_finalize(bt_self_component_sink
*comp
)
129 struct counter
*counter
;
132 counter
= bt_self_component_get_data(
133 bt_self_component_sink_as_self_component(comp
));
135 try_print_last(counter
);
136 bt_self_component_port_input_message_iterator_put_ref(counter
->msg_iter
);
140 struct bt_param_validation_map_value_entry_descr counter_params
[] = {
141 { "step", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_UNSIGNED_INTEGER
} },
142 { "hide-zero", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
143 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
147 bt_component_class_initialize_method_status
counter_init(
148 bt_self_component_sink
*component
,
149 bt_self_component_sink_configuration
*config
,
150 const bt_value
*params
,
151 __attribute__((unused
)) void *init_method_data
)
153 bt_component_class_initialize_method_status status
;
154 bt_self_component_add_port_status add_port_status
;
155 struct counter
*counter
= g_new0(struct counter
, 1);
156 const bt_value
*step
= NULL
;
157 const bt_value
*hide_zero
= NULL
;
158 enum bt_param_validation_status validation_status
;
159 gchar
*validate_error
= NULL
;
162 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
167 bt_self_component_sink_as_self_component(component
);
168 counter
->log_level
= bt_component_get_logging_level(
169 bt_self_component_as_component(counter
->self_comp
));
170 add_port_status
= bt_self_component_sink_add_input_port(component
,
172 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
173 status
= (int) add_port_status
;
177 validation_status
= bt_param_validation_validate(params
,
178 counter_params
, &validate_error
);
179 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
180 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
182 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
183 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
184 BT_COMP_LOGE_APPEND_CAUSE(counter
->self_comp
,
185 "%s", validate_error
);
189 counter
->last_printed_total
= -1ULL;
190 counter
->step
= 10000;
191 step
= bt_value_map_borrow_entry_value_const(params
, "step");
193 counter
->step
= bt_value_integer_unsigned_get(step
);
196 hide_zero
= bt_value_map_borrow_entry_value_const(params
, "hide-zero");
198 counter
->hide_zero
= (bool) bt_value_bool_get(hide_zero
);
201 bt_self_component_set_data(
202 bt_self_component_sink_as_self_component(component
),
205 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
209 destroy_private_counter_data(counter
);
212 g_free(validate_error
);
217 bt_component_class_sink_graph_is_configured_method_status
218 counter_graph_is_configured(
219 bt_self_component_sink
*comp
)
221 bt_component_class_sink_graph_is_configured_method_status status
;
222 bt_self_component_port_input_message_iterator_create_from_sink_component_status
224 struct counter
*counter
;
225 bt_self_component_port_input_message_iterator
*iterator
;
227 counter
= bt_self_component_get_data(
228 bt_self_component_sink_as_self_component(comp
));
231 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_sink_component(
232 comp
, bt_self_component_sink_borrow_input_port_by_name(comp
,
233 in_port_name
), &iterator
);
234 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK
) {
235 status
= (int) msg_iter_status
;
239 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
240 counter
->msg_iter
, iterator
);
242 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK
;
248 bt_component_class_sink_consume_method_status
counter_consume(
249 bt_self_component_sink
*comp
)
251 bt_component_class_sink_consume_method_status status
=
252 BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
253 struct counter
*counter
;
254 bt_message_iterator_next_status next_status
;
256 bt_message_array_const msgs
;
258 counter
= bt_self_component_get_data(
259 bt_self_component_sink_as_self_component(comp
));
260 BT_ASSERT_DBG(counter
);
262 if (G_UNLIKELY(!counter
->msg_iter
)) {
263 try_print_last(counter
);
264 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
268 /* Consume messages */
269 next_status
= bt_self_component_port_input_message_iterator_next(
270 counter
->msg_iter
, &msgs
, &msg_count
);
271 if (next_status
< 0) {
272 status
= (int) next_status
;
276 switch (next_status
) {
277 case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
:
281 for (i
= 0; i
< msg_count
; i
++) {
282 const bt_message
*msg
= msgs
[i
];
285 switch (bt_message_get_type(msg
)) {
286 case BT_MESSAGE_TYPE_EVENT
:
287 counter
->count
.event
++;
289 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
290 counter
->count
.packet_begin
++;
292 case BT_MESSAGE_TYPE_PACKET_END
:
293 counter
->count
.packet_end
++;
295 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
296 counter
->count
.msg_iter_inactivity
++;
298 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
299 counter
->count
.stream_begin
++;
301 case BT_MESSAGE_TYPE_STREAM_END
:
302 counter
->count
.stream_end
++;
304 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
305 counter
->count
.disc_events
++;
307 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
308 counter
->count
.disc_packets
++;
311 counter
->count
.other
++;
314 bt_message_put_ref(msg
);
317 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK
;
320 case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN
:
321 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN
;
323 case BT_MESSAGE_ITERATOR_NEXT_STATUS_END
:
324 try_print_last(counter
);
325 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END
;
327 case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR
:
328 status
= BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR
;
334 try_print_count(counter
, msg_count
);