lib/librte_bitratestats/rte_bitrate.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #include <rte_common.h>
   6 #include <rte_ethdev.h>
   7 #include <rte_malloc.h>
   8 #include <rte_metrics.h>
   9 #include <rte_bitrate.h>
  10
  11 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  12
  13 /*
  14  * Persistent bit-rate data.
  15  * @internal
  16  */
  17 struct rte_stats_bitrate {
  18         uint64_t last_ibytes;
  19         uint64_t last_obytes;
  20         uint64_t peak_ibits;
  21         uint64_t peak_obits;
  22         uint64_t mean_ibits;
  23         uint64_t mean_obits;
  24         uint64_t ewma_ibits;
  25         uint64_t ewma_obits;
  26 };
  27
  28 struct rte_stats_bitrates {
  29         struct rte_stats_bitrate port_stats[RTE_MAX_ETHPORTS];
  30         uint16_t id_stats_set;
  31 };
  32
  33 struct rte_stats_bitrates *
  34 rte_stats_bitrate_create(void)
  35 {
  36         return rte_zmalloc(NULL, sizeof(struct rte_stats_bitrates),
  37                 RTE_CACHE_LINE_SIZE);
  38 }
  39
  40 int
  41 rte_stats_bitrate_reg(struct rte_stats_bitrates *bitrate_data)
  42 {
  43         const char * const names[] = {
  44                 "ewma_bits_in", "ewma_bits_out",
  45                 "mean_bits_in", "mean_bits_out",
  46                 "peak_bits_in", "peak_bits_out",
  47         };
  48         int return_value;
  49
  50         return_value = rte_metrics_reg_names(&names[0], ARRAY_SIZE(names));
  51         if (return_value >= 0)
  52                 bitrate_data->id_stats_set = return_value;
  53         return return_value;
  54 }
  55
  56 int
  57 rte_stats_bitrate_calc(struct rte_stats_bitrates *bitrate_data,
  58                         uint16_t port_id)
  59 {
  60         struct rte_stats_bitrate *port_data;
  61         struct rte_eth_stats eth_stats;
  62         int ret_code;
  63         uint64_t cnt_bits;
  64         int64_t delta;
  65         const int64_t alpha_percent = 20;
  66         uint64_t values[6];
  67
  68         ret_code = rte_eth_stats_get(port_id, &eth_stats);
  69         if (ret_code != 0)
  70                 return ret_code;
  71
  72         port_data = &bitrate_data->port_stats[port_id];
  73
  74         /* Incoming bitrate. This is an iteratively calculated EWMA
  75          * (Exponentially Weighted Moving Average) that uses a
  76          * weighting factor of alpha_percent. An unsmoothed mean
  77          * for just the current time delta is also calculated for the
  78          * benefit of people who don't understand signal processing.
  79          */
  80         cnt_bits = (eth_stats.ibytes - port_data->last_ibytes) << 3;
  81         port_data->last_ibytes = eth_stats.ibytes;
  82         if (cnt_bits > port_data->peak_ibits)
  83                 port_data->peak_ibits = cnt_bits;
  84         delta = cnt_bits;
  85         delta -= port_data->ewma_ibits;
  86         /* The +-50 fixes integer rounding during division */
  87         if (delta > 0)
  88                 delta = (delta * alpha_percent + 50) / 100;
  89         else
  90                 delta = (delta * alpha_percent - 50) / 100;
  91         port_data->ewma_ibits += delta;
  92         /* Integer roundoff prevents EWMA between 0 and (100/alpha_percent)
  93          * ever reaching zero in no-traffic conditions
  94          */
  95         if (cnt_bits == 0 && delta == 0)
  96                 port_data->ewma_ibits = 0;
  97         port_data->mean_ibits = cnt_bits;
  98
  99         /* Outgoing bitrate (also EWMA) */
 100         cnt_bits = (eth_stats.obytes - port_data->last_obytes) << 3;
 101         port_data->last_obytes = eth_stats.obytes;
 102         if (cnt_bits > port_data->peak_obits)
 103                 port_data->peak_obits = cnt_bits;
 104         delta = cnt_bits;
 105         delta -= port_data->ewma_obits;
 106         if (delta > 0)
 107                 delta = (delta * alpha_percent + 50) / 100;
 108         else
 109                 delta = (delta * alpha_percent - 50) / 100;
 110         port_data->ewma_obits += delta;
 111         if (cnt_bits == 0 && delta == 0)
 112                 port_data->ewma_obits = 0;
 113         port_data->mean_obits = cnt_bits;
 114
 115         values[0] = port_data->ewma_ibits;
 116         values[1] = port_data->ewma_obits;
 117         values[2] = port_data->mean_ibits;
 118         values[3] = port_data->mean_obits;
 119         values[4] = port_data->peak_ibits;
 120         values[5] = port_data->peak_obits;
 121         rte_metrics_update_values(port_id, bitrate_data->id_stats_set,
 122                 values, ARRAY_SIZE(values));
 123         return 0;
 124 }