lib: split real FC/field into single and double prec FC/field
[babeltrace.git] / src / plugins / utils / counter / counter.c
... / ...
CommitLineData
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
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"
27
28#include <babeltrace2/babeltrace.h>
29#include "common/macros.h"
30#include "common/common.h"
31#include "common/assert.h"
32#include <inttypes.h>
33#include <stdint.h>
34
35#include "counter.h"
36
37#define PRINTF_COUNT(_what, _var, args...) \
38 do { \
39 if (counter->count._var != 0 || !counter->hide_zero) { \
40 printf("%15" PRIu64 " %s message%s\n", \
41 counter->count._var, \
42 (_what), \
43 counter->count._var == 1 ? "" : "s"); \
44 } \
45 } while (0)
46
47static
48const char * const in_port_name = "in";
49
50static
51uint64_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 +
58 counter->count.disc_events +
59 counter->count.disc_packets +
60 counter->count.msg_iter_inactivity +
61 counter->count.other;
62}
63
64static
65void print_count(struct counter *counter)
66{
67 uint64_t total = get_total_count(counter);
68
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);
77
78 if (counter->count.other > 0) {
79 PRINTF_COUNT("Other (unknown)", other);
80 }
81
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;
86}
87
88static
89void try_print_count(struct counter *counter, uint64_t msg_count)
90{
91 if (counter->step == 0) {
92 /* No update */
93 return;
94 }
95
96 counter->at += msg_count;
97
98 if (counter->at >= counter->step) {
99 counter->at = 0;
100 print_count(counter);
101 putchar('\n');
102 }
103}
104
105static
106void try_print_last(struct counter *counter)
107{
108 const uint64_t total = get_total_count(counter);
109
110 if (total != counter->last_printed_total) {
111 print_count(counter);
112 }
113}
114
115void destroy_private_counter_data(struct counter *counter)
116{
117 if (counter) {
118 bt_self_component_port_input_message_iterator_put_ref(
119 counter->msg_iter);
120 g_free(counter);
121 }
122}
123
124BT_HIDDEN
125void counter_finalize(bt_self_component_sink *comp)
126{
127 struct counter *counter;
128
129 BT_ASSERT(comp);
130 counter = bt_self_component_get_data(
131 bt_self_component_sink_as_self_component(comp));
132 BT_ASSERT(counter);
133 try_print_last(counter);
134 bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
135 g_free(counter);
136}
137
138BT_HIDDEN
139bt_component_class_init_method_status counter_init(
140 bt_self_component_sink *component,
141 bt_self_component_sink_configuration *config,
142 const bt_value *params,
143 __attribute__((unused)) void *init_method_data)
144{
145 bt_component_class_init_method_status status =
146 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
147 bt_self_component_add_port_status add_port_status;
148 struct counter *counter = g_new0(struct counter, 1);
149 const bt_value *step = NULL;
150 const bt_value *hide_zero = NULL;
151
152 if (!counter) {
153 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
154 goto error;
155 }
156
157 counter->self_comp =
158 bt_self_component_sink_as_self_component(component);
159 counter->log_level = bt_component_get_logging_level(
160 bt_self_component_as_component(counter->self_comp));
161 add_port_status = bt_self_component_sink_add_input_port(component,
162 "in", NULL, NULL);
163 switch (add_port_status) {
164 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
165 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
166 goto error;
167 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
168 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
169 goto error;
170 default:
171 break;
172 }
173
174 counter->last_printed_total = -1ULL;
175 counter->step = 10000;
176 step = bt_value_map_borrow_entry_value_const(params, "step");
177 if (step) {
178 if (!bt_value_is_unsigned_integer(step)) {
179 BT_COMP_LOGE("`step` parameter: expecting an unsigned integer value: "
180 "type=%s", bt_common_value_type_string(
181 bt_value_get_type(step)));
182 goto error;
183 }
184
185 counter->step = bt_value_integer_unsigned_get(step);
186 }
187
188 hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
189 if (hide_zero) {
190 if (!bt_value_is_bool(hide_zero)) {
191 BT_COMP_LOGE("`hide-zero` parameter: expecting a boolean value: "
192 "type=%s", bt_common_value_type_string(
193 bt_value_get_type(hide_zero)));
194 goto error;
195 }
196
197 counter->hide_zero = (bool) bt_value_bool_get(hide_zero);
198 }
199
200 bt_self_component_set_data(
201 bt_self_component_sink_as_self_component(component),
202 counter);
203 goto end;
204
205error:
206 destroy_private_counter_data(counter);
207
208 if (status == BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) {
209 status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
210 }
211
212end:
213 return status;
214}
215
216BT_HIDDEN
217bt_component_class_sink_graph_is_configured_method_status
218counter_graph_is_configured(
219 bt_self_component_sink *comp)
220{
221 bt_component_class_sink_graph_is_configured_method_status status;
222 bt_self_component_port_input_message_iterator_create_from_sink_component_status
223 msg_iter_status;
224 struct counter *counter;
225 bt_self_component_port_input_message_iterator *iterator;
226
227 counter = bt_self_component_get_data(
228 bt_self_component_sink_as_self_component(comp));
229 BT_ASSERT(counter);
230
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;
236 goto end;
237 }
238
239 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
240 counter->msg_iter, iterator);
241
242 status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;
243end:
244 return status;
245}
246
247BT_HIDDEN
248bt_component_class_sink_consume_method_status counter_consume(
249 bt_self_component_sink *comp)
250{
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;
255 uint64_t msg_count;
256 bt_message_array_const msgs;
257
258 counter = bt_self_component_get_data(
259 bt_self_component_sink_as_self_component(comp));
260 BT_ASSERT(counter);
261
262 if (G_UNLIKELY(!counter->msg_iter)) {
263 try_print_last(counter);
264 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
265 goto end;
266 }
267
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;
273 goto end;
274 }
275
276 switch (next_status) {
277 case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK:
278 {
279 uint64_t i;
280
281 for (i = 0; i < msg_count; i++) {
282 const bt_message *msg = msgs[i];
283
284 BT_ASSERT(msg);
285 switch (bt_message_get_type(msg)) {
286 case BT_MESSAGE_TYPE_EVENT:
287 counter->count.event++;
288 break;
289 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
290 counter->count.packet_begin++;
291 break;
292 case BT_MESSAGE_TYPE_PACKET_END:
293 counter->count.packet_end++;
294 break;
295 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
296 counter->count.msg_iter_inactivity++;
297 break;
298 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
299 counter->count.stream_begin++;
300 break;
301 case BT_MESSAGE_TYPE_STREAM_END:
302 counter->count.stream_end++;
303 break;
304 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
305 counter->count.disc_events++;
306 break;
307 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
308 counter->count.disc_packets++;
309 break;
310 default:
311 counter->count.other++;
312 }
313
314 bt_message_put_ref(msg);
315 }
316
317 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
318 break;
319 }
320 case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN:
321 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN;
322 goto end;
323 case BT_MESSAGE_ITERATOR_NEXT_STATUS_END:
324 try_print_last(counter);
325 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END;
326 goto end;
327 case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
328 status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR;
329 goto end;
330 default:
331 break;
332 }
333
334 try_print_count(counter, msg_count);
335
336end:
337 return status;
338}
This page took 0.027137 seconds and 4 git commands to generate.