X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_meter%2Frte_meter.h;h=62c8c1ecc2091012cda7caaa57e40b337ae5dc85;hb=abd5c69bf673dabe3c5acd8b839e6745d8d18322;hp=58a051583d2ace45d50870892287b04bf4429e80;hpb=3a787d5bf14645ead95f3b31b98e661b13dde04c;p=dpdk.git

diff --git a/lib/librte_meter/rte_meter.h b/lib/librte_meter/rte_meter.h
index 58a051583d..62c8c1ecc2 100644
--- a/lib/librte_meter/rte_meter.h
+++ b/lib/librte_meter/rte_meter.h
@@ -1,3 +1,4 @@
+
 /* SPDX-License-Identifier: BSD-3-Clause
  * Copyright(c) 2010-2014 Intel Corporation
  */
@@ -16,22 +17,27 @@ extern "C" {
  * 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
+ *    3. Two Rate Three Color Marker (trTCM): defined by IETF RFC 4115
  *
  ***/
 
 #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 */
+/**
+ * Color
+ */
+enum rte_color {
+	RTE_COLOR_GREEN = 0, /**< Green */
+	RTE_COLOR_YELLOW, /**< Yellow */
+	RTE_COLOR_RED, /**< Red */
+	RTE_COLORS /**< Number of colors */
 };
 
 /** srTCM parameters per metered traffic flow. The CIR, CBS and EBS parameters only
@@ -49,10 +55,21 @@ 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 cbs; /**< Committed Burst Size (CBS). Measured in bytes. */
 	uint64_t pbs; /**< Peak Burst Size (PBS). Measured in bytes. */
 };
 
+/** trTCM parameters per metered traffic flow. The CIR, EIR, CBS and EBS
+parameters only count bytes of IP packets and do not include link specific
+headers. The CBS and EBS need to be greater than zero if CIR and EIR are
+none-zero respectively.*/
+struct rte_meter_trtcm_rfc4115_params {
+	uint64_t cir; /**< Committed Information Rate (CIR). Measured in bytes per second. */
+	uint64_t eir; /**< Excess Information Rate (EIR). 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. */
+};
+
 /**
  * Internal data structure storing the srTCM configuration profile. Typically
  * shared by multiple srTCM objects.
@@ -65,12 +82,24 @@ struct rte_meter_srtcm_profile;
  */
 struct rte_meter_trtcm_profile;
 
+/**
+ * Internal data structure storing the trTCM RFC4115 configuration profile.
+ * Typically shared by multiple trTCM objects.
+ */
+struct rte_meter_trtcm_rfc4115_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;
 
+/**
+ * Internal data structure storing the trTCM RFC4115 run-time context per
+ * metered traffic flow.
+ */
+struct rte_meter_trtcm_rfc4115;
+
 /**
  * srTCM profile configuration
  *
@@ -98,6 +127,23 @@ rte_meter_srtcm_profile_config(struct rte_meter_srtcm_profile *p,
 int
 rte_meter_trtcm_profile_config(struct rte_meter_trtcm_profile *p,
 	struct rte_meter_trtcm_params *params);
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * trTCM RFC 4115 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_meter_trtcm_rfc4115_profile_config(
+	struct rte_meter_trtcm_rfc4115_profile *p,
+	struct rte_meter_trtcm_rfc4115_params *params);
 
 /**
  * srTCM configuration per metered traffic flow
@@ -127,6 +173,23 @@ int
 rte_meter_trtcm_config(struct rte_meter_trtcm *m,
 	struct rte_meter_trtcm_profile *p);
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * trTCM RFC 4115 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_rfc4115_config(struct rte_meter_trtcm_rfc4115 *m,
+	struct rte_meter_trtcm_rfc4115_profile *p);
+
 /**
  * srTCM color blind traffic metering
  *
@@ -141,7 +204,7 @@ rte_meter_trtcm_config(struct rte_meter_trtcm *m,
  * @return
  *    Color assigned to the current IP packet
  */
-static inline enum rte_meter_color
+static inline enum rte_color
 rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
 	struct rte_meter_srtcm_profile *p,
 	uint64_t time,
@@ -163,12 +226,12 @@ rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
  * @return
  *    Color assigned to the current IP packet
  */
-static inline enum rte_meter_color
+static inline enum rte_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);
+	enum rte_color pkt_color);
 
 /**
  * trTCM color blind traffic metering
@@ -184,7 +247,7 @@ rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
  * @return
  *    Color assigned to the current IP packet
  */
-static inline enum rte_meter_color
+static inline enum rte_color
 rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
 	struct rte_meter_trtcm_profile *p,
 	uint64_t time,
@@ -206,12 +269,63 @@ rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
  * @return
  *    Color assigned to the current IP packet
  */
-static inline enum rte_meter_color
+static inline enum rte_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);
+	enum rte_color pkt_color);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * trTCM RFC4115 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_color
+rte_meter_trtcm_rfc4115_color_blind_check(
+	struct rte_meter_trtcm_rfc4115 *m,
+	struct rte_meter_trtcm_rfc4115_profile *p,
+	uint64_t time,
+	uint32_t pkt_len);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * trTCM RFC4115 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_color
+rte_meter_trtcm_rfc4115_color_aware_check(
+	struct rte_meter_trtcm_rfc4115 *m,
+	struct rte_meter_trtcm_rfc4115_profile *p,
+	uint64_t time,
+	uint32_t pkt_len,
+	enum rte_color pkt_color);
 
 /*
  * Inline implementation of run-time methods
@@ -259,14 +373,44 @@ 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 */
+	/**< Time of latest update of P 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
+struct rte_meter_trtcm_rfc4115_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 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 eir_period;
+	/**< Number of CPU cycles for one update of E token bucket */
+	uint64_t eir_bytes_per_period;
+	/**< Number of bytes to add to E token bucket on each update */
+};
+
+/**
+ * Internal data structure storing the trTCM RFC4115 run-time context per
+ * metered traffic flow.
+ */
+struct rte_meter_trtcm_rfc4115 {
+	uint64_t time_tc;
+	/**< Time of latest update of C token bucket */
+	uint64_t time_te;
+	/**< Time of latest update of E token bucket */
+	uint64_t tc;
+	/**< Number of bytes currently available in committed(C) token bucket */
+	uint64_t te;
+	/**< Number of bytes currently available in the excess(E) token bucket */
+};
+
+static inline enum rte_color
 rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
 	struct rte_meter_srtcm_profile *p,
 	uint64_t time,
@@ -293,26 +437,26 @@ rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
 	if (tc >= pkt_len) {
 		m->tc = tc - pkt_len;
 		m->te = te;
-		return e_RTE_METER_GREEN;
+		return RTE_COLOR_GREEN;
 	}
 
 	if (te >= pkt_len) {
 		m->tc = tc;
 		m->te = te - pkt_len;
-		return e_RTE_METER_YELLOW;
+		return RTE_COLOR_YELLOW;
 	}
 
 	m->tc = tc;
 	m->te = te;
-	return e_RTE_METER_RED;
+	return RTE_COLOR_RED;
 }
 
-static inline enum rte_meter_color
+static inline enum rte_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)
+	enum rte_color pkt_color)
 {
 	uint64_t time_diff, n_periods, tc, te;
 
@@ -332,24 +476,24 @@ rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m,
 	}
 
 	/* Color logic */
-	if ((pkt_color == e_RTE_METER_GREEN) && (tc >= pkt_len)) {
+	if ((pkt_color == RTE_COLOR_GREEN) && (tc >= pkt_len)) {
 		m->tc = tc - pkt_len;
 		m->te = te;
-		return e_RTE_METER_GREEN;
+		return RTE_COLOR_GREEN;
 	}
 
-	if ((pkt_color != e_RTE_METER_RED) && (te >= pkt_len)) {
+	if ((pkt_color != RTE_COLOR_RED) && (te >= pkt_len)) {
 		m->tc = tc;
 		m->te = te - pkt_len;
-		return e_RTE_METER_YELLOW;
+		return RTE_COLOR_YELLOW;
 	}
 
 	m->tc = tc;
 	m->te = te;
-	return e_RTE_METER_RED;
+	return RTE_COLOR_RED;
 }
 
-static inline enum rte_meter_color
+static inline enum rte_color
 rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
 	struct rte_meter_trtcm_profile *p,
 	uint64_t time,
@@ -377,26 +521,26 @@ rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m,
 	if (tp < pkt_len) {
 		m->tc = tc;
 		m->tp = tp;
-		return e_RTE_METER_RED;
+		return RTE_COLOR_RED;
 	}
 
 	if (tc < pkt_len) {
 		m->tc = tc;
 		m->tp = tp - pkt_len;
-		return e_RTE_METER_YELLOW;
+		return RTE_COLOR_YELLOW;
 	}
 
 	m->tc = tc - pkt_len;
 	m->tp = tp - pkt_len;
-	return e_RTE_METER_GREEN;
+	return RTE_COLOR_GREEN;
 }
 
-static inline enum rte_meter_color
+static inline enum rte_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)
+	enum rte_color pkt_color)
 {
 	uint64_t time_diff_tc, time_diff_tp, n_periods_tc, n_periods_tp, tc, tp;
 
@@ -417,23 +561,112 @@ rte_meter_trtcm_color_aware_check(struct rte_meter_trtcm *m,
 		tp = p->pbs;
 
 	/* Color logic */
-	if ((pkt_color == e_RTE_METER_RED) || (tp < pkt_len)) {
+	if ((pkt_color == RTE_COLOR_RED) || (tp < pkt_len)) {
 		m->tc = tc;
 		m->tp = tp;
-		return e_RTE_METER_RED;
+		return RTE_COLOR_RED;
 	}
 
-	if ((pkt_color == e_RTE_METER_YELLOW) || (tc < pkt_len)) {
+	if ((pkt_color == RTE_COLOR_YELLOW) || (tc < pkt_len)) {
 		m->tc = tc;
 		m->tp = tp - pkt_len;
-		return e_RTE_METER_YELLOW;
+		return RTE_COLOR_YELLOW;
 	}
 
 	m->tc = tc - pkt_len;
 	m->tp = tp - pkt_len;
-	return e_RTE_METER_GREEN;
+	return RTE_COLOR_GREEN;
+}
+
+static inline enum rte_color
+rte_meter_trtcm_rfc4115_color_blind_check(
+	struct rte_meter_trtcm_rfc4115 *m,
+	struct rte_meter_trtcm_rfc4115_profile *p,
+	uint64_t time,
+	uint32_t pkt_len)
+{
+	uint64_t time_diff_tc, time_diff_te, n_periods_tc, n_periods_te, tc, te;
+
+	/* Bucket update */
+	time_diff_tc = time - m->time_tc;
+	time_diff_te = time - m->time_te;
+	n_periods_tc = time_diff_tc / p->cir_period;
+	n_periods_te = time_diff_te / p->eir_period;
+	m->time_tc += n_periods_tc * p->cir_period;
+	m->time_te += n_periods_te * p->eir_period;
+
+	tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
+	if (tc > p->cbs)
+		tc = p->cbs;
+
+	te = m->te + n_periods_te * p->eir_bytes_per_period;
+	if (te > p->ebs)
+		te = p->ebs;
+
+	/* Color logic */
+	if (tc >= pkt_len) {
+		m->tc = tc - pkt_len;
+		m->te = te;
+		return RTE_COLOR_GREEN;
+	}
+	if (te >= pkt_len) {
+		m->tc = tc;
+		m->te = te - pkt_len;
+		return RTE_COLOR_YELLOW;
+	}
+
+	/* If we end up here the color is RED */
+	m->tc = tc;
+	m->te = te;
+	return RTE_COLOR_RED;
 }
 
+static inline enum rte_color
+rte_meter_trtcm_rfc4115_color_aware_check(
+	struct rte_meter_trtcm_rfc4115 *m,
+	struct rte_meter_trtcm_rfc4115_profile *p,
+	uint64_t time,
+	uint32_t pkt_len,
+	enum rte_color pkt_color)
+{
+	uint64_t time_diff_tc, time_diff_te, n_periods_tc, n_periods_te, tc, te;
+
+	/* Bucket update */
+	time_diff_tc = time - m->time_tc;
+	time_diff_te = time - m->time_te;
+	n_periods_tc = time_diff_tc / p->cir_period;
+	n_periods_te = time_diff_te / p->eir_period;
+	m->time_tc += n_periods_tc * p->cir_period;
+	m->time_te += n_periods_te * p->eir_period;
+
+	tc = m->tc + n_periods_tc * p->cir_bytes_per_period;
+	if (tc > p->cbs)
+		tc = p->cbs;
+
+	te = m->te + n_periods_te * p->eir_bytes_per_period;
+	if (te > p->ebs)
+		te = p->ebs;
+
+	/* Color logic */
+	if ((pkt_color == RTE_COLOR_GREEN) && (tc >= pkt_len)) {
+		m->tc = tc - pkt_len;
+		m->te = te;
+		return RTE_COLOR_GREEN;
+	}
+
+	if ((pkt_color != RTE_COLOR_RED) && (te >= pkt_len)) {
+		m->tc = tc;
+		m->te = te - pkt_len;
+		return RTE_COLOR_YELLOW;
+	}
+
+	/* If we end up here the color is RED */
+	m->tc = tc;
+	m->te = te;
+	return RTE_COLOR_RED;
+}
+
+
 #ifdef __cplusplus
 }
 #endif