d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
eb7c574b21
numam-dpdk/lib/librte_meter/rte_meter.h
Cristian Dumitrescu c06ddf9698 meter: add configuration profile 
This patch adds support for meter configuration profiles.
Benefits: simplified configuration procedure, improved performance.

Q1: What is the configuration profile and why does it make sense?
A1: The configuration profile represents the set of configuration
    parameters for a given meter object, such as the rates and sizes for
    the token buckets. The configuration profile concept makes sense when
    many meter objects share the same configuration, which is the typical
    usage model: thousands of traffic flows are each individually metered
    according to just a few service levels (i.e. profiles).

Q2: How is the configuration profile improving the performance?
A2: The performance improvement is achieved by reducing the memory
    footprint of a meter object, which results in better cache utilization
    for the typical case when large arrays of meter objects are used. The
    internal data structures stored for each meter object contain:
       a) Constant fields: Low level translation of the configuration
          parameters that does not change post-configuration. This is
          really duplicated for all meters that use the same
          configuration. This is the configuration profile data that is
          moved away from the meter object. Current size (implementation
          dependent): srTCM = 32 bytes, trTCM = 32 bytes.
       b) Variable fields: Time stamps and running counters that change
          during the on-going traffic metering process. Current size
          (implementation dependent): srTCM = 24 bytes, trTCM = 32 bytes.
          Therefore, by moving the constant fields to a separate profile
          data structure shared by all the meters with the same
          configuration, the size of the meter object is reduced by ~50%.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
2018-02-19 22:28:05 +01:00

443 lines
11 KiB
C
Raw Blame History

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2014 Intel Corporation
*/
#ifndef __INCLUDE_RTE_METER_H__
#define __INCLUDE_RTE_METER_H__
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file
* RTE Traffic Metering
*
* Traffic metering algorithms:
* 1. Single Rate Three Color Marker (srTCM): defined by IETF RFC 2697
* 2. Two Rate Three Color Marker (trTCM): defined by IETF RFC 2698
*
***/
#include <stdint.h>
#include <rte_compat.h>
/*
* Application Programmer's Interface (API)
*
***/
/** Packet Color Set */
enum rte_meter_color {
e_RTE_METER_GREEN = 0, /**< Green */
e_RTE_METER_YELLOW, /**< Yellow */
e_RTE_METER_RED, /**< Red */
e_RTE_METER_COLORS /**< Number of available colors */
};
/** srTCM parameters per metered traffic flow. The CIR, CBS and EBS parameters only
count bytes of IP packets and do not include link specific headers. At least one of
the CBS or EBS parameters has to be greater than zero. */
struct rte_meter_srtcm_params {
uint64_t cir; /**< Committed Information Rate (CIR). Measured in bytes per second. */
uint64_t cbs; /**< Committed Burst Size (CBS). Measured in bytes. */
uint64_t ebs; /**< Excess Burst Size (EBS). Measured in bytes. */
};
/** trTCM parameters per metered traffic flow. The CIR, PIR, CBS and PBS parameters
only count bytes of IP packets and do not include link specific headers. PIR has to
be greater than or equal to CIR. Both CBS or EBS have to be greater than zero. */
struct rte_meter_trtcm_params {
uint64_t cir; /**< Committed Information Rate (CIR). Measured in bytes per second. */
uint64_t pir; /**< Peak Information Rate (PIR). Measured in bytes per second. */
uint64_t cbs; /**< Committed Burst Size (CBS). Measured in byes. */
uint64_t pbs; /**< Peak Burst Size (PBS). Measured in bytes. */
};
/**
* Internal data structure storing the srTCM configuration profile. Typically
* shared by multiple srTCM objects.
*/
struct rte_meter_srtcm_profile;
/**
* Internal data structure storing the trTCM configuration profile. Typically
* shared by multiple trTCM objects.
*/
struct rte_meter_trtcm_profile;
/** Internal data structure storing the srTCM run-time context per metered traffic flow. */
struct rte_meter_srtcm;
/** Internal data structure storing the trTCM run-time context per metered traffic flow. */
struct rte_meter_trtcm;
/**
* srTCM profile configuration
*
* @param p
* Pointer to pre-allocated srTCM profile data structure
* @param params
* srTCM profile parameters
* @return
* 0 upon success, error code otherwise
*/
int __rte_experimental
rte_meter_srtcm_profile_config(struct rte_meter_srtcm_profile *p,
struct rte_meter_srtcm_params *params);
/**
* trTCM profile configuration
*
* @param p
* Pointer to pre-allocated trTCM profile data structure
* @param params
* trTCM profile parameters
* @return
* 0 upon success, error code otherwise
*/
int __rte_experimental
rte_meter_trtcm_profile_config(struct rte_meter_trtcm_profile *p,
struct rte_meter_trtcm_params *params);
/**
* srTCM configuration per metered traffic flow
*
* @param m
* Pointer to pre-allocated srTCM data structure
* @param p
* srTCM profile. Needs to be valid.
* @return
* 0 upon success, error code otherwise
*/
int
rte_meter_srtcm_config(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p);
/**
* trTCM configuration per metered traffic flow
*
* @param m
* Pointer to pre-allocated trTCM data structure
* @param p
* trTCM profile. Needs to be valid.
* @return
* 0 upon success, error code otherwise
*/
int
rte_meter_trtcm_config(struct rte_meter_trtcm *m,
struct rte_meter_trtcm_profile *p);
/**
* srTCM color blind traffic metering
*
* @param m
* Handle to srTCM instance
* @param p
* srTCM profile specified at srTCM object creation time
* @param time
* Current CPU time stamp (measured in CPU cycles)
* @param pkt_len
* Length of the current IP packet (measured in bytes)
* @return
* Color assigned to the current IP packet
*/
static inline enum rte_meter_color
rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p,
uint64_t time,
uint32_t pkt_len);
/**
* srTCM color aware traffic metering
*
* @param m
* Handle to srTCM instance
* @param p
* srTCM profile specified at srTCM object creation time
* @param time
* Current CPU time stamp (measured in CPU cycles)
* @param pkt_len
* Length of the current IP packet (measured in bytes)
* @param pkt_color
* Input color of the current IP packet
* @return
* Color assigned to the current IP packet
*/
static inline enum rte_meter_color
rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p,
uint64_t time,
uint32_t pkt_len,
enum rte_meter_color pkt_color);
/**
* trTCM color blind traffic metering
*
* @param m
* Handle to trTCM instance
* @param p
* trTCM profile specified at trTCM object creation time
* @param time
* Current CPU time stamp (measured in CPU cycles)
* @param pkt_len
* Length of the current IP packet (measured in bytes)
* @return
* Color assigned to the current IP packet
*/
static inline enum rte_meter_color
rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
struct rte_meter_trtcm_profile *p,
uint64_t time,
uint32_t pkt_len);
/**
* trTCM color aware traffic metering
*
* @param m
* Handle to trTCM instance
* @param p
* trTCM profile specified at trTCM object creation time
* @param time
* Current CPU time stamp (measured in CPU cycles)
* @param pkt_len
* Length of the current IP packet (measured in bytes)
* @param pkt_color
* Input color of the current IP packet
* @return
* Color assigned to the current IP packet
*/
static inline enum rte_meter_color
rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
struct rte_meter_trtcm_profile *p,
uint64_t time,
uint32_t pkt_len,
enum rte_meter_color pkt_color);
/*
* Inline implementation of run-time methods
*
***/
struct rte_meter_srtcm_profile {
uint64_t cbs;
/**< Upper limit for C token bucket */
uint64_t ebs;
/**< Upper limit for E token bucket */
uint64_t cir_period;
/**< Number of CPU cycles for each update of C and E token buckets */
uint64_t cir_bytes_per_period;
/**< Number of bytes to add to C and E token buckets on each update */
};
/* Internal data structure storing the srTCM run-time context per metered traffic flow. */
struct rte_meter_srtcm {
uint64_t time; /* Time of latest update of C and E token buckets */
uint64_t tc; /* Number of bytes currently available in the committed (C) token bucket */
uint64_t te; /* Number of bytes currently available in the excess (E) token bucket */
};
struct rte_meter_trtcm_profile {
uint64_t cbs;
/**< Upper limit for C token bucket */
uint64_t pbs;
/**< Upper limit for P token bucket */
uint64_t cir_period;
/**< Number of CPU cycles for one update of C token bucket */
uint64_t cir_bytes_per_period;
/**< Number of bytes to add to C token bucket on each update */
uint64_t pir_period;
/**< Number of CPU cycles for one update of P token bucket */
uint64_t pir_bytes_per_period;
/**< Number of bytes to add to P token bucket on each update */
};
/**
* Internal data structure storing the trTCM run-time context per metered
* traffic flow.
*/
struct rte_meter_trtcm {
uint64_t time_tc;
/**< Time of latest update of C token bucket */
uint64_t time_tp;
/**< Time of latest update of E token bucket */
uint64_t tc;
/**< Number of bytes currently available in committed(C) token bucket */
uint64_t tp;
/**< Number of bytes currently available in the peak(P) token bucket */
};
static inline enum rte_meter_color
rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p,
uint64_t time,
uint32_t pkt_len)
{
uint64_t time_diff, n_periods, tc, te;
/* Bucket update */
time_diff = time - m->time;
n_periods = time_diff / p->cir_period;
m->time += n_periods * p->cir_period;
/* Put the tokens overflowing from tc into te bucket */
tc = m->tc + n_periods * p->cir_bytes_per_period;
te = m->te;
if (tc > p->cbs) {
te += (tc - p->cbs);
if (te > p->ebs)
te = p->ebs;
tc = p->cbs;
}
/* Color logic */
if (tc >= pkt_len) {
m->tc = tc - pkt_len;
m->te = te;
return e_RTE_METER_GREEN;
}
if (te >= pkt_len) {
m->tc = tc;
m->te = te - pkt_len;
return e_RTE_METER_YELLOW;
}
m->tc = tc;
m->te = te;
return e_RTE_METER_RED;
}
static inline enum rte_meter_color
rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p,
uint64_t time,
uint32_t pkt_len,
enum rte_meter_color pkt_color)
{
uint64_t time_diff, n_periods, tc, te;
/* Bucket update */
time_diff = time - m->time;
n_periods = time_diff / p->cir_period;
m->time += n_periods * p->cir_period;
/* Put the tokens overflowing from tc into te bucket */
tc = m->tc + n_periods * p->cir_bytes_per_period;
te = m->te;
if (tc > p->cbs) {
te += (tc - p->cbs);
if (te > p->ebs)
te = p->ebs;
tc = p->cbs;
}
/* Color logic */
if ((pkt_color == e_RTE_METER_GREEN) && (tc >= pkt_len)) {
m->tc = tc - pkt_len;
m->te = te;
return e_RTE_METER_GREEN;
}
if ((pkt_color != e_RTE_METER_RED) && (te >= pkt_len)) {
m->tc = tc;
m->te = te - pkt_len;
return e_RTE_METER_YELLOW;
}
m->tc = tc;
m->te = te;
return e_RTE_METER_RED;
}
static inline enum rte_meter_color
rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
struct rte_meter_trtcm_profile *p,
uint64_t time,
uint32_t pkt_len)
{
uint64_t time_diff_tc, time_diff_tp, n_periods_tc, n_periods_tp, tc, tp;
/* Bucket update */
time_diff_tc = time - m->time_tc;
time_diff_tp = time - m->time_tp;
n_periods_tc = time_diff_tc / p->cir_period;
n_periods_tp = time_diff_tp / p->pir_period;
m->time_tc += n_periods_tc * p->cir_period;
m->time_tp += n_periods_tp * p->pir_period;
tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
if (tc > p->cbs)
tc = p->cbs;
tp = m->tp + n_periods_tp * p->pir_bytes_per_period;
if (tp > p->pbs)
tp = p->pbs;
/* Color logic */
if (tp < pkt_len) {
m->tc = tc;
m->tp = tp;
return e_RTE_METER_RED;
}
if (tc < pkt_len) {
m->tc = tc;
m->tp = tp - pkt_len;
return e_RTE_METER_YELLOW;
}
m->tc = tc - pkt_len;
m->tp = tp - pkt_len;
return e_RTE_METER_GREEN;
}
static inline enum rte_meter_color
rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
struct rte_meter_trtcm_profile *p,
uint64_t time,
uint32_t pkt_len,
enum rte_meter_color pkt_color)
{
uint64_t time_diff_tc, time_diff_tp, n_periods_tc, n_periods_tp, tc, tp;
/* Bucket update */
time_diff_tc = time - m->time_tc;
time_diff_tp = time - m->time_tp;
n_periods_tc = time_diff_tc / p->cir_period;
n_periods_tp = time_diff_tp / p->pir_period;
m->time_tc += n_periods_tc * p->cir_period;
m->time_tp += n_periods_tp * p->pir_period;
tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
if (tc > p->cbs)
tc = p->cbs;
tp = m->tp + n_periods_tp * p->pir_bytes_per_period;
if (tp > p->pbs)
tp = p->pbs;
/* Color logic */
if ((pkt_color == e_RTE_METER_RED) || (tp < pkt_len)) {
m->tc = tc;
m->tp = tp;
return e_RTE_METER_RED;
}
if ((pkt_color == e_RTE_METER_YELLOW) || (tc < pkt_len)) {
m->tc = tc;
m->tp = tp - pkt_len;
return e_RTE_METER_YELLOW;
}
m->tc = tc - pkt_len;
m->tp = tp - pkt_len;
return e_RTE_METER_GREEN;
}
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_RTE_METER_H__ */
Reference in New Issue View Git Blame Copy Permalink