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 #include <babeltrace/babeltrace.h>
  24 #include <babeltrace/babeltrace-internal.h>
  25 #include <babeltrace/common-internal.h>
  26 #include <plugins-common.h>
  27 #include <babeltrace/assert-internal.h>
  28 #include <inttypes.h>
  29 #include <stdint.h>
  30
  31 #include "counter.h"
  32
  33 #define PRINTF_COUNT(_what_sing, _what_plur, _var, args...)             \
  34         do {                                                            \
  35                 if (counter->count._var != 0 || !counter->hide_zero) {  \
  36                         printf("%15" PRIu64 " %s\n",                    \
  37                                 counter->count._var,                    \
  38                                 counter->count._var == 1 ? _what_sing : _what_plur); \
  39                 }                                                       \
  40         } while (0)
  41
  42 static
  43 uint64_t get_total_count(struct counter *counter)
  44 {
  45         return counter->count.event +
  46                 counter->count.stream_begin +
  47                 counter->count.stream_end +
  48                 counter->count.packet_begin +
  49                 counter->count.packet_end +
  50                 counter->count.inactivity +
  51                 counter->count.discarded_events +
  52                 counter->count.discarded_packets +
  53                 counter->count.other;
  54 }
  55
  56 static
  57 void print_count(struct counter *counter)
  58 {
  59         uint64_t total = get_total_count(counter);
  60
  61         PRINTF_COUNT("event", "events", event);
  62         PRINTF_COUNT("stream beginning", "stream beginnings", stream_begin);
  63         PRINTF_COUNT("stream end", "stream ends", stream_end);
  64         PRINTF_COUNT("packet beginning", "packet beginnings", packet_begin);
  65         PRINTF_COUNT("packet end", "packet ends", packet_end);
  66         PRINTF_COUNT("inactivity", "inactivities", inactivity);
  67         PRINTF_COUNT("discarded events notification",
  68                 "discarded events notifications", discarded_events_notifs);
  69         PRINTF_COUNT("  known discarded event", "  known discarded events",
  70                 discarded_events);
  71         PRINTF_COUNT("discarded packets notification",
  72                 "discarded packets notifications", discarded_packets_notifs);
  73         PRINTF_COUNT("  known discarded packet", "  known discarded packets",
  74                 discarded_packets);
  75
  76         if (counter->count.other > 0) {
  77                 PRINTF_COUNT("  other (unknown) notification",
  78                         "  other (unknown) notifications", other);
  79         }
  80
  81         printf("%s%15" PRIu64 " notification%s (TOTAL)%s\n",
  82                 bt_common_color_bold(), total, total == 1 ? "" : "s",
  83                 bt_common_color_reset());
  84         counter->last_printed_total = total;
  85 }
  86
  87 static
  88 void try_print_count(struct counter *counter, uint64_t notif_count)
  89 {
  90         if (counter->step == 0) {
  91                 /* No update */
  92                 return;
  93         }
  94
  95         counter->at += notif_count;
  96
  97         if (counter->at >= counter->step) {
  98                 counter->at = 0;
  99                 print_count(counter);
 100                 putchar('\n');
 101         }
 102 }
 103
 104 static
 105 void try_print_last(struct counter *counter)
 106 {
 107         const uint64_t total = get_total_count(counter);
 108
 109         if (total != counter->last_printed_total) {
 110                 print_count(counter);
 111         }
 112 }
 113
 114 void destroy_private_counter_data(struct counter *counter)
 115 {
 116         bt_put(counter->notif_iter);
 117         g_free(counter);
 118 }
 119
 120 void counter_finalize(struct bt_private_component *component)
 121 {
 122         struct counter *counter;
 123
 124         BT_ASSERT(component);
 125         counter = bt_private_component_get_user_data(component);
 126         BT_ASSERT(counter);
 127         try_print_last(counter);
 128         bt_put(counter->notif_iter);
 129         g_free(counter);
 130 }
 131
 132 enum bt_component_status counter_init(struct bt_private_component *component,
 133                 struct bt_value *params, UNUSED_VAR void *init_method_data)
 134 {
 135         enum bt_component_status ret;
 136         struct counter *counter = g_new0(struct counter, 1);
 137         struct bt_value *step = NULL;
 138         struct bt_value *hide_zero = NULL;
 139
 140         if (!counter) {
 141                 ret = BT_COMPONENT_STATUS_NOMEM;
 142                 goto end;
 143         }
 144
 145         ret = bt_private_component_sink_add_input_private_port(component,
 146                 "in", NULL, NULL);
 147         if (ret != BT_COMPONENT_STATUS_OK) {
 148                 goto end;
 149         }
 150
 151         counter->last_printed_total = -1ULL;
 152         counter->step = 1000;
 153         step = bt_value_map_borrow(params, "step");
 154         if (step && bt_value_is_integer(step)) {
 155                 int64_t val;
 156
 157                 (void) bt_value_integer_get(step, &val);
 158
 159                 if (val >= 0) {
 160                         counter->step = (uint64_t) val;
 161                 }
 162         }
 163
 164         hide_zero = bt_value_map_borrow(params, "hide-zero");
 165         if (hide_zero && bt_value_is_bool(hide_zero)) {
 166                 bt_bool val;
 167
 168                 (void) bt_value_bool_get(hide_zero, &val);
 169                 counter->hide_zero = (bool) val;
 170         }
 171
 172         ret = bt_private_component_set_user_data(component, counter);
 173         if (ret != BT_COMPONENT_STATUS_OK) {
 174                 goto error;
 175         }
 176
 177         goto end;
 178
 179 error:
 180         destroy_private_counter_data(counter);
 181
 182 end:
 183         return ret;
 184 }
 185
 186 enum bt_component_status counter_port_connected(
 187                 struct bt_private_component *component,
 188                 struct bt_private_port *self_port,
 189                 struct bt_port *other_port)
 190 {
 191         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 192         struct counter *counter;
 193         struct bt_notification_iterator *iterator;
 194         struct bt_private_connection *connection;
 195         enum bt_connection_status conn_status;
 196
 197         counter = bt_private_component_get_user_data(component);
 198         BT_ASSERT(counter);
 199         connection = bt_private_port_get_private_connection(self_port);
 200         BT_ASSERT(connection);
 201         conn_status = bt_private_connection_create_notification_iterator(
 202                 connection, &iterator);
 203         if (conn_status != BT_CONNECTION_STATUS_OK) {
 204                 status = BT_COMPONENT_STATUS_ERROR;
 205                 goto end;
 206         }
 207
 208         BT_MOVE(counter->notif_iter, iterator);
 209
 210 end:
 211         bt_put(connection);
 212         return status;
 213 }
 214
 215 enum bt_component_status counter_consume(struct bt_private_component *component)
 216 {
 217         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 218         struct counter *counter;
 219         enum bt_notification_iterator_status it_ret;
 220         int64_t count;
 221         uint64_t notif_count;
 222         bt_notification_array notifs;
 223
 224         counter = bt_private_component_get_user_data(component);
 225         BT_ASSERT(counter);
 226
 227         if (unlikely(!counter->notif_iter)) {
 228                 try_print_last(counter);
 229                 ret = BT_COMPONENT_STATUS_END;
 230                 goto end;
 231         }
 232
 233         /* Consume notifications */
 234         it_ret = bt_private_connection_notification_iterator_next(
 235                 counter->notif_iter, &notifs, &notif_count);
 236         if (it_ret < 0) {
 237                 ret = BT_COMPONENT_STATUS_ERROR;
 238                 goto end;
 239         }
 240
 241         switch (it_ret) {
 242         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 243                 ret = BT_COMPONENT_STATUS_AGAIN;
 244                 goto end;
 245         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 246                 try_print_last(counter);
 247                 ret = BT_COMPONENT_STATUS_END;
 248                 goto end;
 249         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 250         {
 251                 uint64_t i;
 252
 253                 for (i = 0; i < notif_count; i++) {
 254                         struct bt_notification *notif = notifs[i];
 255
 256                         BT_ASSERT(notif);
 257                         switch (bt_notification_get_type(notif)) {
 258                         case BT_NOTIFICATION_TYPE_EVENT:
 259                                 counter->count.event++;
 260                                 break;
 261                         case BT_NOTIFICATION_TYPE_INACTIVITY:
 262                                 counter->count.inactivity++;
 263                                 break;
 264                         case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
 265                                 counter->count.stream_begin++;
 266                                 break;
 267                         case BT_NOTIFICATION_TYPE_STREAM_END:
 268                                 counter->count.stream_end++;
 269                                 break;
 270                         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
 271                                 counter->count.packet_begin++;
 272                                 break;
 273                         case BT_NOTIFICATION_TYPE_PACKET_END:
 274                                 counter->count.packet_end++;
 275                                 break;
 276                         case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
 277                                 counter->count.discarded_events_notifs++;
 278                                 count = bt_notification_discarded_events_get_count(
 279                                         notif);
 280                                 if (count >= 0) {
 281                                         counter->count.discarded_events += count;
 282                                 }
 283                                 break;
 284                         case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
 285                                 counter->count.discarded_packets_notifs++;
 286                                 count = bt_notification_discarded_packets_get_count(
 287                                         notif);
 288                                 if (count >= 0) {
 289                                         counter->count.discarded_packets += count;
 290                                 }
 291                                 break;
 292                         default:
 293                                 counter->count.other++;
 294                         }
 295
 296                         bt_put(notif);
 297                 }
 298         }
 299         default:
 300                 break;
 301         }
 302
 303         try_print_count(counter, notif_count);
 304
 305 end:
 306         return ret;
 307 }