Commit | Line | Data |
---|---|---|
14b7ef9e 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 | ||
627c70e6 | 23 | #define BT_COMP_LOG_SELF_COMP (counter->self_comp) |
c58e2582 | 24 | #define BT_LOG_OUTPUT_LEVEL (counter->log_level) |
b03487ab | 25 | #define BT_LOG_TAG "PLUGIN/FLT.UTILS.COUNTER" |
3fa1b6a3 | 26 | #include "logging/comp-logging.h" |
68d9d039 | 27 | |
71c5da58 | 28 | #include <babeltrace2/babeltrace.h> |
85e7137b | 29 | #include "common/macros.h" |
57952005 | 30 | #include "common/common.h" |
57952005 | 31 | #include "common/assert.h" |
14b7ef9e | 32 | #include <inttypes.h> |
969c1d8a | 33 | #include <stdbool.h> |
14b7ef9e | 34 | #include <stdint.h> |
9e632b22 | 35 | #include "plugins/common/param-validation/param-validation.h" |
14b7ef9e PP |
36 | |
37 | #include "counter.h" | |
38 | ||
168baad4 | 39 | #define PRINTF_COUNT(_what, _var, args...) \ |
14b7ef9e PP |
40 | do { \ |
41 | if (counter->count._var != 0 || !counter->hide_zero) { \ | |
168baad4 | 42 | printf("%15" PRIu64 " %s message%s\n", \ |
14b7ef9e | 43 | counter->count._var, \ |
168baad4 PP |
44 | (_what), \ |
45 | counter->count._var == 1 ? "" : "s"); \ | |
14b7ef9e PP |
46 | } \ |
47 | } while (0) | |
48 | ||
1043fdea PP |
49 | static |
50 | const char * const in_port_name = "in"; | |
51 | ||
14b7ef9e PP |
52 | static |
53 | uint64_t get_total_count(struct counter *counter) | |
54 | { | |
55 | return counter->count.event + | |
56 | counter->count.stream_begin + | |
57 | counter->count.stream_end + | |
58 | counter->count.packet_begin + | |
59 | counter->count.packet_end + | |
168baad4 PP |
60 | counter->count.disc_events + |
61 | counter->count.disc_packets + | |
40bf6fd0 | 62 | counter->count.msg_iter_inactivity + |
14b7ef9e PP |
63 | counter->count.other; |
64 | } | |
65 | ||
66 | static | |
3fd7b79d | 67 | void print_count(struct counter *counter) |
14b7ef9e | 68 | { |
3fd7b79d PP |
69 | uint64_t total = get_total_count(counter); |
70 | ||
168baad4 PP |
71 | PRINTF_COUNT("Event", event); |
72 | PRINTF_COUNT("Stream beginning", stream_begin); | |
73 | PRINTF_COUNT("Stream end", stream_end); | |
168baad4 PP |
74 | PRINTF_COUNT("Packet beginning", packet_begin); |
75 | PRINTF_COUNT("Packet end", packet_end); | |
76 | PRINTF_COUNT("Discarded event", disc_events); | |
77 | PRINTF_COUNT("Discarded packet", disc_packets); | |
78 | PRINTF_COUNT("Message iterator inactivity", msg_iter_inactivity); | |
14b7ef9e PP |
79 | |
80 | if (counter->count.other > 0) { | |
168baad4 | 81 | PRINTF_COUNT("Other (unknown)", other); |
14b7ef9e PP |
82 | } |
83 | ||
b09a5592 | 84 | printf("%s%15" PRIu64 " message%s (TOTAL)%s\n", |
14b7ef9e PP |
85 | bt_common_color_bold(), total, total == 1 ? "" : "s", |
86 | bt_common_color_reset()); | |
87 | counter->last_printed_total = total; | |
88 | } | |
89 | ||
90 | static | |
b09a5592 | 91 | void try_print_count(struct counter *counter, uint64_t msg_count) |
14b7ef9e | 92 | { |
14b7ef9e PP |
93 | if (counter->step == 0) { |
94 | /* No update */ | |
95 | return; | |
96 | } | |
97 | ||
b09a5592 | 98 | counter->at += msg_count; |
14b7ef9e | 99 | |
3fd7b79d PP |
100 | if (counter->at >= counter->step) { |
101 | counter->at = 0; | |
102 | print_count(counter); | |
14b7ef9e PP |
103 | putchar('\n'); |
104 | } | |
105 | } | |
106 | ||
107 | static | |
108 | void try_print_last(struct counter *counter) | |
109 | { | |
110 | const uint64_t total = get_total_count(counter); | |
111 | ||
112 | if (total != counter->last_printed_total) { | |
3fd7b79d | 113 | print_count(counter); |
14b7ef9e PP |
114 | } |
115 | } | |
116 | ||
f3847c75 | 117 | static |
14b7ef9e PP |
118 | void destroy_private_counter_data(struct counter *counter) |
119 | { | |
888e0925 FD |
120 | if (counter) { |
121 | bt_self_component_port_input_message_iterator_put_ref( | |
122 | counter->msg_iter); | |
123 | g_free(counter); | |
124 | } | |
14b7ef9e PP |
125 | } |
126 | ||
834e9996 | 127 | BT_HIDDEN |
8eee8ea2 | 128 | void counter_finalize(bt_self_component_sink *comp) |
14b7ef9e PP |
129 | { |
130 | struct counter *counter; | |
131 | ||
834e9996 PP |
132 | BT_ASSERT(comp); |
133 | counter = bt_self_component_get_data( | |
bb61965b | 134 | bt_self_component_sink_as_self_component(comp)); |
8b45963b | 135 | BT_ASSERT(counter); |
14b7ef9e | 136 | try_print_last(counter); |
b09a5592 | 137 | bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter); |
14b7ef9e PP |
138 | g_free(counter); |
139 | } | |
140 | ||
5ca9cc5a | 141 | static |
9e632b22 SM |
142 | struct bt_param_validation_map_value_entry_descr counter_params[] = { |
143 | { "step", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_UNSIGNED_INTEGER } }, | |
144 | { "hide-zero", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
145 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
146 | }; | |
147 | ||
834e9996 | 148 | BT_HIDDEN |
4175c1d5 | 149 | bt_component_class_initialize_method_status counter_init( |
8eee8ea2 | 150 | bt_self_component_sink *component, |
e3250e61 | 151 | bt_self_component_sink_configuration *config, |
8eee8ea2 | 152 | const bt_value *params, |
f807570c | 153 | __attribute__((unused)) void *init_method_data) |
14b7ef9e | 154 | { |
9e632b22 | 155 | bt_component_class_initialize_method_status status; |
fb25b9e3 | 156 | bt_self_component_add_port_status add_port_status; |
14b7ef9e | 157 | struct counter *counter = g_new0(struct counter, 1); |
8eee8ea2 PP |
158 | const bt_value *step = NULL; |
159 | const bt_value *hide_zero = NULL; | |
9e632b22 SM |
160 | enum bt_param_validation_status validation_status; |
161 | gchar *validate_error = NULL; | |
14b7ef9e PP |
162 | |
163 | if (!counter) { | |
4175c1d5 | 164 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
834e9996 | 165 | goto error; |
14b7ef9e PP |
166 | } |
167 | ||
627c70e6 PP |
168 | counter->self_comp = |
169 | bt_self_component_sink_as_self_component(component); | |
c58e2582 | 170 | counter->log_level = bt_component_get_logging_level( |
627c70e6 | 171 | bt_self_component_as_component(counter->self_comp)); |
fb25b9e3 | 172 | add_port_status = bt_self_component_sink_add_input_port(component, |
14b7ef9e | 173 | "in", NULL, NULL); |
9e632b22 SM |
174 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { |
175 | status = (int) add_port_status; | |
834e9996 | 176 | goto error; |
9e632b22 SM |
177 | } |
178 | ||
179 | validation_status = bt_param_validation_validate(params, | |
180 | counter_params, &validate_error); | |
181 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
4175c1d5 | 182 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
fb25b9e3 | 183 | goto error; |
9e632b22 SM |
184 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { |
185 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
186 | BT_COMP_LOGE_APPEND_CAUSE(counter->self_comp, | |
187 | "%s", validate_error); | |
188 | goto error; | |
14b7ef9e PP |
189 | } |
190 | ||
191 | counter->last_printed_total = -1ULL; | |
a79f976c | 192 | counter->step = 10000; |
ce141536 | 193 | step = bt_value_map_borrow_entry_value_const(params, "step"); |
68d9d039 | 194 | if (step) { |
60bbfc7c | 195 | counter->step = bt_value_integer_unsigned_get(step); |
14b7ef9e PP |
196 | } |
197 | ||
ce141536 | 198 | hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero"); |
68d9d039 | 199 | if (hide_zero) { |
68d9d039 | 200 | counter->hide_zero = (bool) bt_value_bool_get(hide_zero); |
14b7ef9e PP |
201 | } |
202 | ||
834e9996 | 203 | bt_self_component_set_data( |
bb61965b | 204 | bt_self_component_sink_as_self_component(component), |
834e9996 | 205 | counter); |
9e632b22 SM |
206 | |
207 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
14b7ef9e PP |
208 | goto end; |
209 | ||
210 | error: | |
211 | destroy_private_counter_data(counter); | |
fb25b9e3 | 212 | |
14b7ef9e | 213 | end: |
9e632b22 | 214 | g_free(validate_error); |
fb25b9e3 | 215 | return status; |
14b7ef9e PP |
216 | } |
217 | ||
834e9996 | 218 | BT_HIDDEN |
fb25b9e3 PP |
219 | bt_component_class_sink_graph_is_configured_method_status |
220 | counter_graph_is_configured( | |
1043fdea | 221 | bt_self_component_sink *comp) |
14b7ef9e | 222 | { |
ab8b2b1b SM |
223 | bt_component_class_sink_graph_is_configured_method_status status; |
224 | bt_self_component_port_input_message_iterator_create_from_sink_component_status | |
225 | msg_iter_status; | |
14b7ef9e | 226 | struct counter *counter; |
b09a5592 | 227 | bt_self_component_port_input_message_iterator *iterator; |
14b7ef9e | 228 | |
834e9996 | 229 | counter = bt_self_component_get_data( |
bb61965b | 230 | bt_self_component_sink_as_self_component(comp)); |
8b45963b | 231 | BT_ASSERT(counter); |
ab8b2b1b SM |
232 | |
233 | msg_iter_status = bt_self_component_port_input_message_iterator_create_from_sink_component( | |
692f1a01 | 234 | comp, bt_self_component_sink_borrow_input_port_by_name(comp, |
ab8b2b1b SM |
235 | in_port_name), &iterator); |
236 | if (msg_iter_status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) { | |
237 | status = (int) msg_iter_status; | |
14b7ef9e PP |
238 | goto end; |
239 | } | |
240 | ||
b09a5592 PP |
241 | BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF( |
242 | counter->msg_iter, iterator); | |
14b7ef9e | 243 | |
ab8b2b1b | 244 | status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK; |
14b7ef9e | 245 | end: |
634f394c | 246 | return status; |
14b7ef9e PP |
247 | } |
248 | ||
834e9996 | 249 | BT_HIDDEN |
fb25b9e3 | 250 | bt_component_class_sink_consume_method_status counter_consume( |
8eee8ea2 | 251 | bt_self_component_sink *comp) |
14b7ef9e | 252 | { |
fb25b9e3 PP |
253 | bt_component_class_sink_consume_method_status status = |
254 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; | |
14b7ef9e | 255 | struct counter *counter; |
fb25b9e3 | 256 | bt_message_iterator_next_status next_status; |
b09a5592 PP |
257 | uint64_t msg_count; |
258 | bt_message_array_const msgs; | |
14b7ef9e | 259 | |
834e9996 | 260 | counter = bt_self_component_get_data( |
bb61965b | 261 | bt_self_component_sink_as_self_component(comp)); |
ec4a3354 | 262 | BT_ASSERT_DBG(counter); |
14b7ef9e | 263 | |
85e7137b | 264 | if (G_UNLIKELY(!counter->msg_iter)) { |
14b7ef9e | 265 | try_print_last(counter); |
fb25b9e3 | 266 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END; |
14b7ef9e PP |
267 | goto end; |
268 | } | |
269 | ||
b09a5592 | 270 | /* Consume messages */ |
fb25b9e3 | 271 | next_status = bt_self_component_port_input_message_iterator_next( |
b09a5592 | 272 | counter->msg_iter, &msgs, &msg_count); |
fb25b9e3 PP |
273 | if (next_status < 0) { |
274 | status = (int) next_status; | |
14b7ef9e PP |
275 | goto end; |
276 | } | |
277 | ||
fb25b9e3 PP |
278 | switch (next_status) { |
279 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK: | |
14b7ef9e | 280 | { |
3fd7b79d PP |
281 | uint64_t i; |
282 | ||
b09a5592 PP |
283 | for (i = 0; i < msg_count; i++) { |
284 | const bt_message *msg = msgs[i]; | |
3fd7b79d | 285 | |
ec4a3354 | 286 | BT_ASSERT_DBG(msg); |
b09a5592 PP |
287 | switch (bt_message_get_type(msg)) { |
288 | case BT_MESSAGE_TYPE_EVENT: | |
3fd7b79d PP |
289 | counter->count.event++; |
290 | break; | |
168baad4 PP |
291 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: |
292 | counter->count.packet_begin++; | |
293 | break; | |
294 | case BT_MESSAGE_TYPE_PACKET_END: | |
295 | counter->count.packet_end++; | |
296 | break; | |
40bf6fd0 FD |
297 | case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: |
298 | counter->count.msg_iter_inactivity++; | |
3fd7b79d | 299 | break; |
b09a5592 | 300 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: |
3fd7b79d PP |
301 | counter->count.stream_begin++; |
302 | break; | |
b09a5592 | 303 | case BT_MESSAGE_TYPE_STREAM_END: |
3fd7b79d PP |
304 | counter->count.stream_end++; |
305 | break; | |
168baad4 PP |
306 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: |
307 | counter->count.disc_events++; | |
308 | break; | |
309 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
310 | counter->count.disc_packets++; | |
3fd7b79d | 311 | break; |
3fd7b79d PP |
312 | default: |
313 | counter->count.other++; | |
14b7ef9e | 314 | } |
3fd7b79d | 315 | |
b09a5592 | 316 | bt_message_put_ref(msg); |
14b7ef9e | 317 | } |
834e9996 | 318 | |
fb25b9e3 | 319 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; |
834e9996 | 320 | break; |
14b7ef9e | 321 | } |
fb25b9e3 PP |
322 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN: |
323 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN; | |
834e9996 | 324 | goto end; |
fb25b9e3 | 325 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_END: |
834e9996 | 326 | try_print_last(counter); |
fb25b9e3 | 327 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END; |
834e9996 | 328 | goto end; |
fb25b9e3 PP |
329 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR: |
330 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR; | |
834e9996 | 331 | goto end; |
14b7ef9e PP |
332 | default: |
333 | break; | |
334 | } | |
335 | ||
b09a5592 | 336 | try_print_count(counter, msg_count); |
14b7ef9e PP |
337 | |
338 | end: | |
fb25b9e3 | 339 | return status; |
14b7ef9e | 340 | } |