lib/librte_meter/rte_meter.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <inttypes.h>
   6 #include <stdio.h>
   7 #include <math.h>
   8
   9 #include <rte_common.h>
  10 #include <rte_log.h>
  11 #include <rte_cycles.h>
  12 #include <rte_function_versioning.h>
  13
  14 #include "rte_meter.h"
  15
  16 #ifndef RTE_METER_TB_PERIOD_MIN
  17 #define RTE_METER_TB_PERIOD_MIN      100
  18 #endif
  19
  20 static void
  21 rte_meter_get_tb_params(uint64_t hz, uint64_t rate, uint64_t *tb_period, uint64_t *tb_bytes_per_period)
  22 {
  23         double period;
  24
  25         if (rate == 0) {
  26                 *tb_bytes_per_period = 0;
  27                 *tb_period = RTE_METER_TB_PERIOD_MIN;
  28                 return;
  29         }
  30
  31         period = ((double) hz) / ((double) rate);
  32
  33         if (period >= RTE_METER_TB_PERIOD_MIN) {
  34                 *tb_bytes_per_period = 1;
  35                 *tb_period = (uint64_t) period;
  36         } else {
  37                 *tb_bytes_per_period = (uint64_t) ceil(RTE_METER_TB_PERIOD_MIN / period);
  38                 *tb_period = (hz * (*tb_bytes_per_period)) / rate;
  39         }
  40 }
  41
  42 int
  43 rte_meter_srtcm_profile_config(struct rte_meter_srtcm_profile *p,
  44         struct rte_meter_srtcm_params *params)
  45 {
  46         uint64_t hz = rte_get_tsc_hz();
  47
  48         /* Check input parameters */
  49         if ((p == NULL) ||
  50                 (params == NULL) ||
  51                 (params->cir == 0) ||
  52                 ((params->cbs == 0) && (params->ebs == 0)))
  53                 return -EINVAL;
  54
  55         /* Initialize srTCM run-time structure */
  56         p->cbs = params->cbs;
  57         p->ebs = params->ebs;
  58         rte_meter_get_tb_params(hz, params->cir, &p->cir_period,
  59                 &p->cir_bytes_per_period);
  60
  61         return 0;
  62 }
  63
  64 int
  65 rte_meter_srtcm_config(struct rte_meter_srtcm *m,
  66         struct rte_meter_srtcm_profile *p)
  67 {
  68         /* Check input parameters */
  69         if ((m == NULL) || (p == NULL))
  70                 return -EINVAL;
  71
  72         /* Initialize srTCM run-time structure */
  73         m->time = rte_get_tsc_cycles();
  74         m->tc = p->cbs;
  75         m->te = p->ebs;
  76
  77         return 0;
  78 }
  79
  80 int
  81 rte_meter_trtcm_profile_config(struct rte_meter_trtcm_profile *p,
  82         struct rte_meter_trtcm_params *params)
  83 {
  84         uint64_t hz = rte_get_tsc_hz();
  85
  86         /* Check input parameters */
  87         if ((p == NULL) ||
  88                 (params == NULL) ||
  89                 (params->cir == 0) ||
  90                 (params->pir == 0) ||
  91                 (params->pir < params->cir) ||
  92                 (params->cbs == 0) ||
  93                 (params->pbs == 0))
  94                 return -EINVAL;
  95
  96         /* Initialize trTCM run-time structure */
  97         p->cbs = params->cbs;
  98         p->pbs = params->pbs;
  99         rte_meter_get_tb_params(hz, params->cir, &p->cir_period,
 100                 &p->cir_bytes_per_period);
 101         rte_meter_get_tb_params(hz, params->pir, &p->pir_period,
 102                 &p->pir_bytes_per_period);
 103
 104         return 0;
 105 }
 106
 107 int
 108 rte_meter_trtcm_config(struct rte_meter_trtcm *m,
 109         struct rte_meter_trtcm_profile *p)
 110 {
 111         /* Check input parameters */
 112         if ((m == NULL) || (p == NULL))
 113                 return -EINVAL;
 114
 115         /* Initialize trTCM run-time structure */
 116         m->time_tc = m->time_tp = rte_get_tsc_cycles();
 117         m->tc = p->cbs;
 118         m->tp = p->pbs;
 119
 120         return 0;
 121 }
 122
 123 /*
 124  *  ABI aliasing done for 'rte_meter_trtcm_rfc4115_profile_config'
 125  *  to support both EXPERIMENTAL and DPDK_21 versions
 126  *  This versioning will be removed on next ABI version (v20.11)
 127  *  and '__rte_meter_trtcm_rfc4115_profile_config' will be restrored back to
 128  *  'rte_meter_trtcm_rfc4115_profile_config' without versioning.
 129  */
 130 static int
 131 __rte_meter_trtcm_rfc4115_profile_config(
 132         struct rte_meter_trtcm_rfc4115_profile *p,
 133         struct rte_meter_trtcm_rfc4115_params *params)
 134 {
 135         uint64_t hz = rte_get_tsc_hz();
 136
 137         /* Check input parameters */
 138         if ((p == NULL) ||
 139                 (params == NULL) ||
 140                 (params->cir != 0 && params->cbs == 0) ||
 141                 (params->eir != 0 && params->ebs == 0))
 142                 return -EINVAL;
 143
 144         /* Initialize trTCM run-time structure */
 145         p->cbs = params->cbs;
 146         p->ebs = params->ebs;
 147         rte_meter_get_tb_params(hz, params->cir, &p->cir_period,
 148                 &p->cir_bytes_per_period);
 149         rte_meter_get_tb_params(hz, params->eir, &p->eir_period,
 150                 &p->eir_bytes_per_period);
 151
 152         return 0;
 153 }
 154
 155 int
 156 rte_meter_trtcm_rfc4115_profile_config_s(
 157         struct rte_meter_trtcm_rfc4115_profile *p,
 158         struct rte_meter_trtcm_rfc4115_params *params);
 159 int
 160 rte_meter_trtcm_rfc4115_profile_config_s(
 161         struct rte_meter_trtcm_rfc4115_profile *p,
 162         struct rte_meter_trtcm_rfc4115_params *params)
 163 {
 164         return __rte_meter_trtcm_rfc4115_profile_config(p, params);
 165 }
 166 BIND_DEFAULT_SYMBOL(rte_meter_trtcm_rfc4115_profile_config, _s, 21);
 167 MAP_STATIC_SYMBOL(int rte_meter_trtcm_rfc4115_profile_config(struct rte_meter_trtcm_rfc4115_profile *p,
 168                 struct rte_meter_trtcm_rfc4115_params *params), rte_meter_trtcm_rfc4115_profile_config_s);
 169
 170 int
 171 rte_meter_trtcm_rfc4115_profile_config_e(
 172         struct rte_meter_trtcm_rfc4115_profile *p,
 173         struct rte_meter_trtcm_rfc4115_params *params);
 174 int
 175 rte_meter_trtcm_rfc4115_profile_config_e(
 176         struct rte_meter_trtcm_rfc4115_profile *p,
 177         struct rte_meter_trtcm_rfc4115_params *params)
 178 {
 179         return __rte_meter_trtcm_rfc4115_profile_config(p, params);
 180 }
 181 VERSION_SYMBOL_EXPERIMENTAL(rte_meter_trtcm_rfc4115_profile_config, _e);
 182
 183 /*
 184  *  ABI aliasing done for 'rte_meter_trtcm_rfc4115_config'
 185  *  to support both EXPERIMENTAL and DPDK_21 versions
 186  *  This versioning will be removed on next ABI version (v20.11)
 187  *  and '__rte_meter_trtcm_rfc4115_config' will be restrored back to
 188  *  'rte_meter_trtcm_rfc4115_config' without versioning.
 189  */
 190 static int
 191 __rte_meter_trtcm_rfc4115_config(
 192         struct rte_meter_trtcm_rfc4115 *m,
 193         struct rte_meter_trtcm_rfc4115_profile *p)
 194 {
 195         /* Check input parameters */
 196         if ((m == NULL) || (p == NULL))
 197                 return -EINVAL;
 198
 199         /* Initialize trTCM run-time structure */
 200         m->time_tc = m->time_te = rte_get_tsc_cycles();
 201         m->tc = p->cbs;
 202         m->te = p->ebs;
 203
 204         return 0;
 205 }
 206
 207 int
 208 rte_meter_trtcm_rfc4115_config_s(struct rte_meter_trtcm_rfc4115 *m,
 209         struct rte_meter_trtcm_rfc4115_profile *p);
 210 int
 211 rte_meter_trtcm_rfc4115_config_s(struct rte_meter_trtcm_rfc4115 *m,
 212         struct rte_meter_trtcm_rfc4115_profile *p)
 213 {
 214         return __rte_meter_trtcm_rfc4115_config(m, p);
 215 }
 216 BIND_DEFAULT_SYMBOL(rte_meter_trtcm_rfc4115_config, _s, 21);
 217 MAP_STATIC_SYMBOL(int rte_meter_trtcm_rfc4115_config(struct rte_meter_trtcm_rfc4115 *m,
 218                  struct rte_meter_trtcm_rfc4115_profile *p), rte_meter_trtcm_rfc4115_config_s);
 219
 220 int
 221 rte_meter_trtcm_rfc4115_config_e(struct rte_meter_trtcm_rfc4115 *m,
 222         struct rte_meter_trtcm_rfc4115_profile *p);
 223 int
 224 rte_meter_trtcm_rfc4115_config_e(struct rte_meter_trtcm_rfc4115 *m,
 225         struct rte_meter_trtcm_rfc4115_profile *p)
 226 {
 227         return __rte_meter_trtcm_rfc4115_config(m, p);
 228 }
 229 VERSION_SYMBOL_EXPERIMENTAL(rte_meter_trtcm_rfc4115_config, _e);