src/plugins/utils/counter/counter.c

   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 "plugins/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
  47 static
  48 const char * const in_port_name = "in";
  49
  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.stream_activity_begin +
  57                 counter->count.stream_activity_end +
  58                 counter->count.packet_begin +
  59                 counter->count.packet_end +
  60                 counter->count.disc_events +
  61                 counter->count.disc_packets +
  62                 counter->count.msg_iter_inactivity +
  63                 counter->count.other;
  64 }
  65
  66 static
  67 void print_count(struct counter *counter)
  68 {
  69         uint64_t total = get_total_count(counter);
  70
  71         PRINTF_COUNT("Event", event);
  72         PRINTF_COUNT("Stream beginning", stream_begin);
  73         PRINTF_COUNT("Stream end", stream_end);
  74         PRINTF_COUNT("Stream activity beginning", stream_activity_begin);
  75         PRINTF_COUNT("Stream activity end", stream_activity_end);
  76         PRINTF_COUNT("Packet beginning", packet_begin);
  77         PRINTF_COUNT("Packet end", packet_end);
  78         PRINTF_COUNT("Discarded event", disc_events);
  79         PRINTF_COUNT("Discarded packet", disc_packets);
  80         PRINTF_COUNT("Message iterator inactivity", msg_iter_inactivity);
  81
  82         if (counter->count.other > 0) {
  83                 PRINTF_COUNT("Other (unknown)", other);
  84         }
  85
  86         printf("%s%15" PRIu64 " message%s (TOTAL)%s\n",
  87                 bt_common_color_bold(), total, total == 1 ? "" : "s",
  88                 bt_common_color_reset());
  89         counter->last_printed_total = total;
  90 }
  91
  92 static
  93 void try_print_count(struct counter *counter, uint64_t msg_count)
  94 {
  95         if (counter->step == 0) {
  96                 /* No update */
  97                 return;
  98         }
  99
 100         counter->at += msg_count;
 101
 102         if (counter->at >= counter->step) {
 103                 counter->at = 0;
 104                 print_count(counter);
 105                 putchar('\n');
 106         }
 107 }
 108
 109 static
 110 void try_print_last(struct counter *counter)
 111 {
 112         const uint64_t total = get_total_count(counter);
 113
 114         if (total != counter->last_printed_total) {
 115                 print_count(counter);
 116         }
 117 }
 118
 119 void destroy_private_counter_data(struct counter *counter)
 120 {
 121         bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
 122         g_free(counter);
 123 }
 124
 125 BT_HIDDEN
 126 void counter_finalize(bt_self_component_sink *comp)
 127 {
 128         struct counter *counter;
 129
 130         BT_ASSERT(comp);
 131         counter = bt_self_component_get_data(
 132                         bt_self_component_sink_as_self_component(comp));
 133         BT_ASSERT(counter);
 134         try_print_last(counter);
 135         bt_self_component_port_input_message_iterator_put_ref(counter->msg_iter);
 136         g_free(counter);
 137 }
 138
 139 BT_HIDDEN
 140 bt_self_component_status counter_init(
 141                 bt_self_component_sink *component,
 142                 const bt_value *params,
 143                 __attribute__((unused)) void *init_method_data)
 144 {
 145         bt_self_component_status ret;
 146         struct counter *counter = g_new0(struct counter, 1);
 147         const bt_value *step = NULL;
 148         const bt_value *hide_zero = NULL;
 149
 150         if (!counter) {
 151                 ret = BT_SELF_COMPONENT_STATUS_NOMEM;
 152                 goto error;
 153         }
 154
 155         counter->self_comp =
 156                 bt_self_component_sink_as_self_component(component);
 157         counter->log_level = bt_component_get_logging_level(
 158                 bt_self_component_as_component(counter->self_comp));
 159         ret = bt_self_component_sink_add_input_port(component,
 160                 "in", NULL, NULL);
 161         if (ret != BT_SELF_COMPONENT_STATUS_OK) {
 162                 goto error;
 163         }
 164
 165         counter->last_printed_total = -1ULL;
 166         counter->step = 10000;
 167         step = bt_value_map_borrow_entry_value_const(params, "step");
 168         if (step) {
 169                 if (!bt_value_is_unsigned_integer(step)) {
 170                         BT_COMP_LOGE("`step` parameter: expecting an unsigned integer value: "
 171                                 "type=%s", bt_common_value_type_string(
 172                                         bt_value_get_type(step)));
 173                         goto error;
 174                 }
 175
 176                 counter->step = bt_value_unsigned_integer_get(step);
 177         }
 178
 179         hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
 180         if (hide_zero) {
 181                 if (!bt_value_is_bool(hide_zero)) {
 182                         BT_COMP_LOGE("`hide-zero` parameter: expecting a boolean value: "
 183                                 "type=%s", bt_common_value_type_string(
 184                                         bt_value_get_type(hide_zero)));
 185                         goto error;
 186                 }
 187
 188                 counter->hide_zero = (bool) bt_value_bool_get(hide_zero);
 189         }
 190
 191         bt_self_component_set_data(
 192                 bt_self_component_sink_as_self_component(component),
 193                 counter);
 194         goto end;
 195
 196 error:
 197         destroy_private_counter_data(counter);
 198         ret = BT_SELF_COMPONENT_STATUS_ERROR;
 199
 200 end:
 201         return ret;
 202 }
 203
 204 BT_HIDDEN
 205 bt_self_component_status counter_graph_is_configured(
 206                 bt_self_component_sink *comp)
 207 {
 208         bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
 209         struct counter *counter;
 210         bt_self_component_port_input_message_iterator *iterator;
 211
 212         counter = bt_self_component_get_data(
 213                 bt_self_component_sink_as_self_component(comp));
 214         BT_ASSERT(counter);
 215         iterator = bt_self_component_port_input_message_iterator_create(
 216                 bt_self_component_sink_borrow_input_port_by_name(comp,
 217                         in_port_name));
 218         if (!iterator) {
 219                 status = BT_SELF_COMPONENT_STATUS_NOMEM;
 220                 goto end;
 221         }
 222
 223         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
 224                 counter->msg_iter, iterator);
 225
 226 end:
 227         return status;
 228 }
 229
 230 BT_HIDDEN
 231 bt_self_component_status counter_consume(
 232                 bt_self_component_sink *comp)
 233 {
 234         bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
 235         struct counter *counter;
 236         bt_message_iterator_status it_ret;
 237         uint64_t msg_count;
 238         bt_message_array_const msgs;
 239
 240         counter = bt_self_component_get_data(
 241                         bt_self_component_sink_as_self_component(comp));
 242         BT_ASSERT(counter);
 243
 244         if (G_UNLIKELY(!counter->msg_iter)) {
 245                 try_print_last(counter);
 246                 ret = BT_SELF_COMPONENT_STATUS_END;
 247                 goto end;
 248         }
 249
 250         /* Consume messages */
 251         it_ret = bt_self_component_port_input_message_iterator_next(
 252                 counter->msg_iter, &msgs, &msg_count);
 253         if (it_ret < 0) {
 254                 ret = BT_SELF_COMPONENT_STATUS_ERROR;
 255                 goto end;
 256         }
 257
 258         switch (it_ret) {
 259         case BT_MESSAGE_ITERATOR_STATUS_OK:
 260         {
 261                 uint64_t i;
 262
 263                 for (i = 0; i < msg_count; i++) {
 264                         const bt_message *msg = msgs[i];
 265
 266                         BT_ASSERT(msg);
 267                         switch (bt_message_get_type(msg)) {
 268                         case BT_MESSAGE_TYPE_EVENT:
 269                                 counter->count.event++;
 270                                 break;
 271                         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
 272                                 counter->count.packet_begin++;
 273                                 break;
 274                         case BT_MESSAGE_TYPE_PACKET_END:
 275                                 counter->count.packet_end++;
 276                                 break;
 277                         case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
 278                                 counter->count.msg_iter_inactivity++;
 279                                 break;
 280                         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
 281                                 counter->count.stream_begin++;
 282                                 break;
 283                         case BT_MESSAGE_TYPE_STREAM_END:
 284                                 counter->count.stream_end++;
 285                                 break;
 286                         case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
 287                                 counter->count.stream_activity_begin++;
 288                                 break;
 289                         case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
 290                                 counter->count.stream_activity_end++;
 291                                 break;
 292                         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
 293                                 counter->count.disc_events++;
 294                                 break;
 295                         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
 296                                 counter->count.disc_packets++;
 297                                 break;
 298                         default:
 299                                 counter->count.other++;
 300                         }
 301
 302                         bt_message_put_ref(msg);
 303                 }
 304
 305                 ret = BT_SELF_COMPONENT_STATUS_OK;
 306                 break;
 307         }
 308         case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
 309                 ret = BT_SELF_COMPONENT_STATUS_AGAIN;
 310                 goto end;
 311         case BT_MESSAGE_ITERATOR_STATUS_END:
 312                 try_print_last(counter);
 313                 ret = BT_SELF_COMPONENT_STATUS_END;
 314                 goto end;
 315         case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
 316                 ret = BT_SELF_COMPONENT_STATUS_NOMEM;
 317                 goto end;
 318         default:
 319                 break;
 320         }
 321
 322         try_print_count(counter, msg_count);
 323
 324 end:
 325         return ret;
 326 }