lib/librte_meter/rte_meter.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <inttypes.h>
  35 #include <stdio.h>
  36 #include <math.h>
  37
  38 #include <rte_common.h>
  39 #include <rte_log.h>
  40 #include <rte_cycles.h>
  41
  42 #include "rte_meter.h"
  43
  44 #ifndef RTE_METER_TB_PERIOD_MIN
  45 #define RTE_METER_TB_PERIOD_MIN      100
  46 #endif
  47
  48 static void
  49 rte_meter_get_tb_params(uint64_t hz, uint64_t rate, uint64_t *tb_period, uint64_t *tb_bytes_per_period)
  50 {
  51         double period = ((double) hz) / ((double) rate);
  52
  53         if (period >= RTE_METER_TB_PERIOD_MIN) {
  54                 *tb_bytes_per_period = 1;
  55                 *tb_period = (uint64_t) period;
  56         } else {
  57                 *tb_bytes_per_period = (uint64_t) ceil(RTE_METER_TB_PERIOD_MIN / period);
  58                 *tb_period = (hz * (*tb_bytes_per_period)) / rate;
  59         }
  60 }
  61
  62 int
  63 rte_meter_srtcm_config(struct rte_meter_srtcm *m, struct rte_meter_srtcm_params *params)
  64 {
  65         uint64_t hz;
  66
  67         /* Check input parameters */
  68         if ((m == NULL) || (params == NULL)) {
  69                 return -1;
  70         }
  71
  72         if ((params->cir == 0) || ((params->cbs == 0) && (params->ebs == 0))) {
  73                 return -2;
  74         }
  75
  76         /* Initialize srTCM run-time structure */
  77         hz = rte_get_tsc_hz();
  78         m->time = rte_get_tsc_cycles();
  79         m->tc = m->cbs = params->cbs;
  80         m->te = m->ebs = params->ebs;
  81         rte_meter_get_tb_params(hz, params->cir, &m->cir_period, &m->cir_bytes_per_period);
  82
  83         RTE_LOG(INFO, METER, "Low level srTCM config: \n"
  84                 "\tCIR period = %" PRIu64 ", CIR bytes per period = %" PRIu64 "\n",
  85                 m->cir_period, m->cir_bytes_per_period);
  86
  87         return 0;
  88 }
  89
  90 int
  91 rte_meter_trtcm_config(struct rte_meter_trtcm *m, struct rte_meter_trtcm_params *params)
  92 {
  93         uint64_t hz;
  94
  95         /* Check input parameters */
  96         if ((m == NULL) || (params == NULL)) {
  97                 return -1;
  98         }
  99
 100         if ((params->cir == 0) || (params->pir == 0) || (params->pir < params->cir) ||
 101                 (params->cbs == 0) || (params->pbs == 0)) {
 102                 return -2;
 103         }
 104
 105         /* Initialize trTCM run-time structure */
 106         hz = rte_get_tsc_hz();
 107         m->time_tc = m->time_tp = rte_get_tsc_cycles();
 108         m->tc = m->cbs = params->cbs;
 109         m->tp = m->pbs = params->pbs;
 110         rte_meter_get_tb_params(hz, params->cir, &m->cir_period, &m->cir_bytes_per_period);
 111         rte_meter_get_tb_params(hz, params->pir, &m->pir_period, &m->pir_bytes_per_period);
 112
 113         RTE_LOG(INFO, METER, "Low level trTCM config: \n"
 114                 "\tCIR period = %" PRIu64 ", CIR bytes per period = %" PRIu64 "\n"
 115                 "\tPIR period = %" PRIu64 ", PIR bytes per period = %" PRIu64 "\n",
 116                 m->cir_period, m->cir_bytes_per_period,
 117                 m->pir_period, m->pir_bytes_per_period);
 118
 119         return 0;
 120 }