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.other;
  52 }
  53
  54 static
  55 void print_count(struct counter *counter)
  56 {
  57         uint64_t total = get_total_count(counter);
  58
  59         PRINTF_COUNT("event", "events", event);
  60         PRINTF_COUNT("stream beginning", "stream beginnings", stream_begin);
  61         PRINTF_COUNT("stream end", "stream ends", stream_end);
  62         PRINTF_COUNT("packet beginning", "packet beginnings", packet_begin);
  63         PRINTF_COUNT("packet end", "packet ends", packet_end);
  64         PRINTF_COUNT("inactivity", "inactivities", inactivity);
  65
  66         if (counter->count.other > 0) {
  67                 PRINTF_COUNT("  other (unknown) notification",
  68                         "  other (unknown) notifications", other);
  69         }
  70
  71         printf("%s%15" PRIu64 " notification%s (TOTAL)%s\n",
  72                 bt_common_color_bold(), total, total == 1 ? "" : "s",
  73                 bt_common_color_reset());
  74         counter->last_printed_total = total;
  75 }
  76
  77 static
  78 void try_print_count(struct counter *counter, uint64_t notif_count)
  79 {
  80         if (counter->step == 0) {
  81                 /* No update */
  82                 return;
  83         }
  84
  85         counter->at += notif_count;
  86
  87         if (counter->at >= counter->step) {
  88                 counter->at = 0;
  89                 print_count(counter);
  90                 putchar('\n');
  91         }
  92 }
  93
  94 static
  95 void try_print_last(struct counter *counter)
  96 {
  97         const uint64_t total = get_total_count(counter);
  98
  99         if (total != counter->last_printed_total) {
 100                 print_count(counter);
 101         }
 102 }
 103
 104 void destroy_private_counter_data(struct counter *counter)
 105 {
 106         bt_object_put_ref(counter->notif_iter);
 107         g_free(counter);
 108 }
 109
 110 BT_HIDDEN
 111 void counter_finalize(struct bt_self_component_sink *comp)
 112 {
 113         struct counter *counter;
 114
 115         BT_ASSERT(comp);
 116         counter = bt_self_component_get_data(
 117                         bt_self_component_sink_as_self_component(comp));
 118         BT_ASSERT(counter);
 119         try_print_last(counter);
 120         bt_object_put_ref(counter->notif_iter);
 121         g_free(counter);
 122 }
 123
 124 BT_HIDDEN
 125 enum bt_self_component_status counter_init(
 126                 struct bt_self_component_sink *component,
 127                 const struct bt_value *params,
 128                 UNUSED_VAR void *init_method_data)
 129 {
 130         enum bt_self_component_status ret;
 131         struct counter *counter = g_new0(struct counter, 1);
 132         const struct bt_value *step = NULL;
 133         const struct bt_value *hide_zero = NULL;
 134
 135         if (!counter) {
 136                 ret = BT_SELF_COMPONENT_STATUS_NOMEM;
 137                 goto error;
 138         }
 139
 140         ret = bt_self_component_sink_add_input_port(component,
 141                 "in", NULL, NULL);
 142         if (ret != BT_SELF_COMPONENT_STATUS_OK) {
 143                 goto error;
 144         }
 145
 146         counter->last_printed_total = -1ULL;
 147         counter->step = 1000;
 148         step = bt_value_map_borrow_entry_value_const(params, "step");
 149         if (step && bt_value_is_integer(step)) {
 150                 int64_t val;
 151
 152                 val = bt_value_integer_get(step);
 153                 if (val >= 0) {
 154                         counter->step = (uint64_t) val;
 155                 }
 156         }
 157
 158         hide_zero = bt_value_map_borrow_entry_value_const(params, "hide-zero");
 159         if (hide_zero && bt_value_is_bool(hide_zero)) {
 160                 bt_bool val;
 161
 162                 val = bt_value_bool_get(hide_zero);
 163                 counter->hide_zero = (bool) val;
 164         }
 165
 166         bt_self_component_set_data(
 167                 bt_self_component_sink_as_self_component(component),
 168                 counter);
 169         goto end;
 170
 171 error:
 172         destroy_private_counter_data(counter);
 173
 174 end:
 175         return ret;
 176 }
 177
 178 BT_HIDDEN
 179 enum bt_self_component_status counter_port_connected(
 180                 struct bt_self_component_sink *comp,
 181                 struct bt_self_component_port_input *self_port,
 182                 const struct bt_port_output *other_port)
 183 {
 184         enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
 185         struct counter *counter;
 186         struct bt_self_component_port_input_notification_iterator *iterator;
 187
 188         counter = bt_self_component_get_data(
 189                 bt_self_component_sink_as_self_component(comp));
 190         BT_ASSERT(counter);
 191         iterator = bt_self_component_port_input_notification_iterator_create(
 192                 self_port);
 193         if (!iterator) {
 194                 status = BT_SELF_COMPONENT_STATUS_NOMEM;
 195                 goto end;
 196         }
 197
 198         BT_OBJECT_MOVE_REF(counter->notif_iter, iterator);
 199
 200 end:
 201         return status;
 202 }
 203
 204 BT_HIDDEN
 205 enum bt_self_component_status counter_consume(
 206                 struct bt_self_component_sink *comp)
 207 {
 208         enum bt_self_component_status ret = BT_SELF_COMPONENT_STATUS_OK;
 209         struct counter *counter;
 210         enum bt_notification_iterator_status it_ret;
 211         uint64_t notif_count;
 212         bt_notification_array_const notifs;
 213
 214         counter = bt_self_component_get_data(
 215                         bt_self_component_sink_as_self_component(comp));
 216         BT_ASSERT(counter);
 217
 218         if (unlikely(!counter->notif_iter)) {
 219                 try_print_last(counter);
 220                 ret = BT_SELF_COMPONENT_STATUS_END;
 221                 goto end;
 222         }
 223
 224         /* Consume notifications */
 225         it_ret = bt_self_component_port_input_notification_iterator_next(
 226                 counter->notif_iter, &notifs, &notif_count);
 227         if (it_ret < 0) {
 228                 ret = BT_SELF_COMPONENT_STATUS_ERROR;
 229                 goto end;
 230         }
 231
 232         switch (it_ret) {
 233         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 234         {
 235                 uint64_t i;
 236
 237                 for (i = 0; i < notif_count; i++) {
 238                         const struct bt_notification *notif = notifs[i];
 239
 240                         BT_ASSERT(notif);
 241                         switch (bt_notification_get_type(notif)) {
 242                         case BT_NOTIFICATION_TYPE_EVENT:
 243                                 counter->count.event++;
 244                                 break;
 245                         case BT_NOTIFICATION_TYPE_INACTIVITY:
 246                                 counter->count.inactivity++;
 247                                 break;
 248                         case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
 249                                 counter->count.stream_begin++;
 250                                 break;
 251                         case BT_NOTIFICATION_TYPE_STREAM_END:
 252                                 counter->count.stream_end++;
 253                                 break;
 254                         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
 255                                 counter->count.packet_begin++;
 256                                 break;
 257                         case BT_NOTIFICATION_TYPE_PACKET_END:
 258                                 counter->count.packet_end++;
 259                                 break;
 260                         default:
 261                                 counter->count.other++;
 262                         }
 263
 264                         bt_object_put_ref(notif);
 265                 }
 266
 267                 ret = BT_SELF_COMPONENT_STATUS_OK;
 268                 break;
 269         }
 270         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 271                 ret = BT_SELF_COMPONENT_STATUS_AGAIN;
 272                 goto end;
 273         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 274                 try_print_last(counter);
 275                 ret = BT_SELF_COMPONENT_STATUS_END;
 276                 goto end;
 277         case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
 278                 ret = BT_SELF_COMPONENT_STATUS_NOMEM;
 279                 goto end;
 280         default:
 281                 break;
 282         }
 283
 284         try_print_count(counter, notif_count);
 285
 286 end:
 287         return ret;
 288 }