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