Commit | Line | Data |
---|---|---|
358340ec 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 | ||
82e80647 | 23 | #define BT_COMP_LOG_SELF_COMP (counter->self_comp) |
9d87d0ea | 24 | #define BT_LOG_OUTPUT_LEVEL (counter->log_level) |
350ad6c1 | 25 | #define BT_LOG_TAG "PLUGIN/FLT.UTILS.COUNTER" |
d9c39b0a | 26 | #include "logging/comp-logging.h" |
fdd3a2da | 27 | |
3fadfbc0 | 28 | #include <babeltrace2/babeltrace.h> |
91d81473 | 29 | #include "common/macros.h" |
578e048b | 30 | #include "common/common.h" |
578e048b | 31 | #include "common/assert.h" |
358340ec PP |
32 | #include <inttypes.h> |
33 | #include <stdint.h> | |
34 | ||
35 | #include "counter.h" | |
36 | ||
0e847b69 | 37 | #define PRINTF_COUNT(_what, _var, args...) \ |
358340ec PP |
38 | do { \ |
39 | if (counter->count._var != 0 || !counter->hide_zero) { \ | |
0e847b69 | 40 | printf("%15" PRIu64 " %s message%s\n", \ |
358340ec | 41 | counter->count._var, \ |
0e847b69 PP |
42 | (_what), \ |
43 | counter->count._var == 1 ? "" : "s"); \ | |
358340ec PP |
44 | } \ |
45 | } while (0) | |
46 | ||
5badd463 PP |
47 | static |
48 | const char * const in_port_name = "in"; | |
49 | ||
358340ec PP |
50 | static |
51 | uint64_t get_total_count(struct counter *counter) | |
52 | { | |
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 + | |
0e847b69 PP |
58 | counter->count.disc_events + |
59 | counter->count.disc_packets + | |
b9fd9cbb | 60 | counter->count.msg_iter_inactivity + |
358340ec PP |
61 | counter->count.other; |
62 | } | |
63 | ||
64 | static | |
d4393e08 | 65 | void print_count(struct counter *counter) |
358340ec | 66 | { |
d4393e08 PP |
67 | uint64_t total = get_total_count(counter); |
68 | ||
0e847b69 PP |
69 | PRINTF_COUNT("Event", event); |
70 | PRINTF_COUNT("Stream beginning", stream_begin); | |
71 | PRINTF_COUNT("Stream end", stream_end); | |
0e847b69 PP |
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); | |
358340ec PP |
77 | |
78 | if (counter->count.other > 0) { | |
0e847b69 | 79 | PRINTF_COUNT("Other (unknown)", other); |
358340ec PP |
80 | } |
81 | ||
d6e69534 | 82 | printf("%s%15" PRIu64 " message%s (TOTAL)%s\n", |
358340ec PP |
83 | bt_common_color_bold(), total, total == 1 ? "" : "s", |
84 | bt_common_color_reset()); | |
85 | counter->last_printed_total = total; | |
86 | } | |
87 | ||
88 | static | |
d6e69534 | 89 | void try_print_count(struct counter *counter, uint64_t msg_count) |
358340ec | 90 | { |
358340ec PP |
91 | if (counter->step == 0) { |
92 | /* No update */ | |
93 | return; | |
94 | } | |
95 | ||
d6e69534 | 96 | counter->at += msg_count; |
358340ec | 97 | |
d4393e08 PP |
98 | if (counter->at >= counter->step) { |
99 | counter->at = 0; | |
100 | print_count(counter); | |
358340ec PP |
101 | putchar('\n'); |
102 | } | |
103 | } | |
104 | ||
105 | static | |
106 | void try_print_last(struct counter *counter) | |
107 | { | |
108 | const uint64_t total = get_total_count(counter); | |
109 | ||
110 | if (total != counter->last_printed_total) { | |
d4393e08 | 111 | print_count(counter); |
358340ec PP |
112 | } |
113 | } | |
114 | ||
115 | void destroy_private_counter_data(struct counter *counter) | |
116 | { | |
d6e69534 | 117 | bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter); |
358340ec PP |
118 | g_free(counter); |
119 | } | |
120 | ||
d94d92ac | 121 | BT_HIDDEN |
b19ff26f | 122 | void counter_finalize(bt_self_component_sink *comp) |
358340ec PP |
123 | { |
124 | struct counter *counter; | |
125 | ||
d94d92ac PP |
126 | BT_ASSERT(comp); |
127 | counter = bt_self_component_get_data( | |
707b7d35 | 128 | bt_self_component_sink_as_self_component(comp)); |
f6ccaed9 | 129 | BT_ASSERT(counter); |
358340ec | 130 | try_print_last(counter); |
d6e69534 | 131 | bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter); |
358340ec PP |
132 | g_free(counter); |
133 | } | |
134 | ||
d94d92ac | 135 | BT_HIDDEN |
d24d5663 | 136 | bt_component_class_init_method_status counter_init( |
b19ff26f PP |
137 | bt_self_component_sink *component, |
138 | const bt_value *params, | |
c88dd1cb | 139 | __attribute__((unused)) void *init_method_data) |
358340ec | 140 | { |
d24d5663 PP |
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; | |
358340ec | 144 | struct counter *counter = g_new0(struct counter, 1); |
b19ff26f PP |
145 | const bt_value *step = NULL; |
146 | const bt_value *hide_zero = NULL; | |
358340ec PP |
147 | |
148 | if (!counter) { | |
d24d5663 | 149 | status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; |
d94d92ac | 150 | goto error; |
358340ec PP |
151 | } |
152 | ||
82e80647 PP |
153 | counter->self_comp = |
154 | bt_self_component_sink_as_self_component(component); | |
9d87d0ea | 155 | counter->log_level = bt_component_get_logging_level( |
82e80647 | 156 | bt_self_component_as_component(counter->self_comp)); |
d24d5663 | 157 | add_port_status = bt_self_component_sink_add_input_port(component, |
358340ec | 158 | "in", NULL, NULL); |
d24d5663 PP |
159 | switch (add_port_status) { |
160 | case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR: | |
161 | status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; | |
d94d92ac | 162 | goto error; |
d24d5663 PP |
163 | case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR: |
164 | status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; | |
165 | goto error; | |
166 | default: | |
167 | break; | |
358340ec PP |
168 | } |
169 | ||
170 | counter->last_printed_total = -1ULL; | |
a5bc50e4 | 171 | counter->step = 10000; |
05e21286 | 172 | step = bt_value_map_borrow_entry_value_const(params, "step"); |
fdd3a2da PP |
173 | if (step) { |
174 | if (!bt_value_is_unsigned_integer(step)) { | |
82e80647 | 175 | BT_COMP_LOGE("`step` parameter: expecting an unsigned integer value: " |
fdd3a2da PP |
176 | "type=%s", bt_common_value_type_string( |
177 | bt_value_get_type(step))); | |
178 | goto error; | |
358340ec | 179 | } |
fdd3a2da | 180 | |
9c08c816 | 181 | counter->step = bt_value_integer_unsigned_get(step); |
358340ec PP |
182 | } |
183 | ||
05e21286 | 184 | hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero"); |
fdd3a2da PP |
185 | if (hide_zero) { |
186 | if (!bt_value_is_bool(hide_zero)) { | |
82e80647 | 187 | BT_COMP_LOGE("`hide-zero` parameter: expecting a boolean value: " |
fdd3a2da PP |
188 | "type=%s", bt_common_value_type_string( |
189 | bt_value_get_type(hide_zero))); | |
190 | goto error; | |
191 | } | |
358340ec | 192 | |
fdd3a2da | 193 | counter->hide_zero = (bool) bt_value_bool_get(hide_zero); |
358340ec PP |
194 | } |
195 | ||
d94d92ac | 196 | bt_self_component_set_data( |
707b7d35 | 197 | bt_self_component_sink_as_self_component(component), |
d94d92ac | 198 | counter); |
358340ec PP |
199 | goto end; |
200 | ||
201 | error: | |
202 | destroy_private_counter_data(counter); | |
d24d5663 PP |
203 | |
204 | if (status == BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) { | |
205 | status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; | |
206 | } | |
358340ec PP |
207 | |
208 | end: | |
d24d5663 | 209 | return status; |
358340ec PP |
210 | } |
211 | ||
d94d92ac | 212 | BT_HIDDEN |
d24d5663 PP |
213 | bt_component_class_sink_graph_is_configured_method_status |
214 | counter_graph_is_configured( | |
5badd463 | 215 | bt_self_component_sink *comp) |
358340ec | 216 | { |
d24d5663 PP |
217 | bt_component_class_sink_graph_is_configured_method_status status = |
218 | BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK; | |
358340ec | 219 | struct counter *counter; |
d6e69534 | 220 | bt_self_component_port_input_message_iterator *iterator; |
358340ec | 221 | |
d94d92ac | 222 | counter = bt_self_component_get_data( |
707b7d35 | 223 | bt_self_component_sink_as_self_component(comp)); |
f6ccaed9 | 224 | BT_ASSERT(counter); |
ca02df0a PP |
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, | |
5badd463 | 227 | in_port_name)); |
d94d92ac | 228 | if (!iterator) { |
d24d5663 | 229 | status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR; |
358340ec PP |
230 | goto end; |
231 | } | |
232 | ||
d6e69534 PP |
233 | BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF( |
234 | counter->msg_iter, iterator); | |
358340ec PP |
235 | |
236 | end: | |
bf55043c | 237 | return status; |
358340ec PP |
238 | } |
239 | ||
d94d92ac | 240 | BT_HIDDEN |
d24d5663 | 241 | bt_component_class_sink_consume_method_status counter_consume( |
b19ff26f | 242 | bt_self_component_sink *comp) |
358340ec | 243 | { |
d24d5663 PP |
244 | bt_component_class_sink_consume_method_status status = |
245 | BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; | |
358340ec | 246 | struct counter *counter; |
d24d5663 | 247 | bt_message_iterator_next_status next_status; |
d6e69534 PP |
248 | uint64_t msg_count; |
249 | bt_message_array_const msgs; | |
358340ec | 250 | |
d94d92ac | 251 | counter = bt_self_component_get_data( |
707b7d35 | 252 | bt_self_component_sink_as_self_component(comp)); |
f6ccaed9 | 253 | BT_ASSERT(counter); |
358340ec | 254 | |
91d81473 | 255 | if (G_UNLIKELY(!counter->msg_iter)) { |
358340ec | 256 | try_print_last(counter); |
d24d5663 | 257 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END; |
358340ec PP |
258 | goto end; |
259 | } | |
260 | ||
d6e69534 | 261 | /* Consume messages */ |
d24d5663 | 262 | next_status = bt_self_component_port_input_message_iterator_next( |
d6e69534 | 263 | counter->msg_iter, &msgs, &msg_count); |
d24d5663 PP |
264 | if (next_status < 0) { |
265 | status = (int) next_status; | |
358340ec PP |
266 | goto end; |
267 | } | |
268 | ||
d24d5663 PP |
269 | switch (next_status) { |
270 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK: | |
358340ec | 271 | { |
d4393e08 PP |
272 | uint64_t i; |
273 | ||
d6e69534 PP |
274 | for (i = 0; i < msg_count; i++) { |
275 | const bt_message *msg = msgs[i]; | |
d4393e08 | 276 | |
d6e69534 PP |
277 | BT_ASSERT(msg); |
278 | switch (bt_message_get_type(msg)) { | |
279 | case BT_MESSAGE_TYPE_EVENT: | |
d4393e08 PP |
280 | counter->count.event++; |
281 | break; | |
0e847b69 PP |
282 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: |
283 | counter->count.packet_begin++; | |
284 | break; | |
285 | case BT_MESSAGE_TYPE_PACKET_END: | |
286 | counter->count.packet_end++; | |
287 | break; | |
b9fd9cbb FD |
288 | case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: |
289 | counter->count.msg_iter_inactivity++; | |
d4393e08 | 290 | break; |
d6e69534 | 291 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: |
d4393e08 PP |
292 | counter->count.stream_begin++; |
293 | break; | |
d6e69534 | 294 | case BT_MESSAGE_TYPE_STREAM_END: |
d4393e08 PP |
295 | counter->count.stream_end++; |
296 | break; | |
0e847b69 PP |
297 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: |
298 | counter->count.disc_events++; | |
299 | break; | |
300 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
301 | counter->count.disc_packets++; | |
d4393e08 | 302 | break; |
d4393e08 PP |
303 | default: |
304 | counter->count.other++; | |
358340ec | 305 | } |
d4393e08 | 306 | |
d6e69534 | 307 | bt_message_put_ref(msg); |
358340ec | 308 | } |
d94d92ac | 309 | |
d24d5663 | 310 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK; |
d94d92ac | 311 | break; |
358340ec | 312 | } |
d24d5663 PP |
313 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN: |
314 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN; | |
d94d92ac | 315 | goto end; |
d24d5663 | 316 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_END: |
d94d92ac | 317 | try_print_last(counter); |
d24d5663 | 318 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END; |
d94d92ac | 319 | goto end; |
d24d5663 PP |
320 | case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR: |
321 | status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR; | |
d94d92ac | 322 | goto end; |
358340ec PP |
323 | default: |
324 | break; | |
325 | } | |
326 | ||
d6e69534 | 327 | try_print_count(counter, msg_count); |
358340ec PP |
328 | |
329 | end: | |
d24d5663 | 330 | return status; |
358340ec | 331 | } |