+
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2014 Intel Corporation
*/
* 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)
*
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.
*/
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
*
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_experimental
+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
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_experimental
+rte_meter_trtcm_rfc4115_config(struct rte_meter_trtcm_rfc4115 *m,
+ struct rte_meter_trtcm_rfc4115_profile *p);
+
/**
* srTCM color blind traffic metering
*
uint32_t pkt_len,
enum rte_meter_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_meter_color __rte_experimental
+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_meter_color __rte_experimental
+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_meter_color pkt_color);
+
/*
* Inline implementation of run-time methods
*
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 */
};
+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_meter_color
rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m,
struct rte_meter_srtcm_profile *p,
return e_RTE_METER_GREEN;
}
+static inline enum rte_meter_color __rte_experimental
+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 e_RTE_METER_GREEN;
+ }
+ if (te >= pkt_len) {
+ m->tc = tc;
+ m->te = te - pkt_len;
+ return e_RTE_METER_YELLOW;
+ }
+
+ /* If we end up here the color is RED */
+ m->tc = tc;
+ m->te = te;
+ return e_RTE_METER_RED;
+}
+
+static inline enum rte_meter_color __rte_experimental
+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_meter_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 == 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;
+ }
+
+ /* If we end up here the color is RED */
+ m->tc = tc;
+ m->te = te;
+ return e_RTE_METER_RED;
+}
+
+
#ifdef __cplusplus
}
#endif
#define TM_TEST_TRTCM_CIR_DF 46000000
#define TM_TEST_TRTCM_PIR_DF 69000000
+#define TM_TEST_TRTCM_EIR_DF 69000000
#define TM_TEST_TRTCM_CBS_DF 2048
#define TM_TEST_TRTCM_PBS_DF 4096
+#define TM_TEST_TRTCM_EBS_DF 4096
static struct rte_meter_srtcm_params sparams =
{.cir = TM_TEST_SRTCM_CIR_DF,
.cbs = TM_TEST_TRTCM_CBS_DF,
.pbs = TM_TEST_TRTCM_PBS_DF,};
+static struct rte_meter_trtcm_rfc4115_params rfc4115params =
+ {.cir = TM_TEST_TRTCM_CIR_DF,
+ .eir = TM_TEST_TRTCM_EIR_DF,
+ .cbs = TM_TEST_TRTCM_CBS_DF,
+ .ebs = TM_TEST_TRTCM_EBS_DF,};
+
/**
* functional test for rte_meter_srtcm_config
*/
return 0;
}
+/**
+ * functional test for rte_meter_trtcm_rfc4115_config
+ */
+static inline int
+tm_test_trtcm_rfc4115_config(void)
+{
+ struct rte_meter_trtcm_rfc4115_profile tp;
+ struct rte_meter_trtcm_rfc4115_params rfc4115params1;
+#define TRTCM_RFC4115_CFG_MSG "trtcm_rfc4115_config"
+
+ /* invalid parameter test */
+ if (rte_meter_trtcm_rfc4115_profile_config(NULL, NULL) == 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, NULL) == 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+ if (rte_meter_trtcm_rfc4115_profile_config(NULL, &rfc4115params) == 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+
+ /*
+ * cbs and pbs should be none-zero if cir and eir are none-zero
+ * respectively
+ */
+ rfc4115params1 = rfc4115params;
+ rfc4115params1.cbs = 0;
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params1) == 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+
+ rfc4115params1 = rfc4115params;
+ rfc4115params1.ebs = 0;
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params1) == 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+
+ /* usual parameter, should be successful */
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_CFG_MSG);
+
+ return 0;
+}
+
/**
* functional test for rte_meter_srtcm_color_blind_check
*/
return 0;
}
+/**
+ * functional test for rte_meter_trtcm_rfc4115_color_blind_check
+ */
+static inline int
+tm_test_trtcm_rfc4115_color_blind_check(void)
+{
+#define TRTCM_RFC4115_BLIND_CHECK_MSG "trtcm_rfc4115_blind_check"
+
+ uint64_t time;
+ struct rte_meter_trtcm_rfc4115_profile tp;
+ struct rte_meter_trtcm_rfc4115 tm;
+ uint64_t hz = rte_get_tsc_hz();
+
+ /* Test green */
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_blind_check(
+ &tm, &tp, time, TM_TEST_TRTCM_CBS_DF - 1)
+ != e_RTE_METER_GREEN)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG" GREEN");
+
+ /* Test yellow */
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_blind_check(
+ &tm, &tp, time, TM_TEST_TRTCM_CBS_DF + 1)
+ != e_RTE_METER_YELLOW)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG" YELLOW");
+
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_blind_check(
+ &tm, &tp, time, TM_TEST_TRTCM_EBS_DF - 1)
+ != e_RTE_METER_YELLOW)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG" YELLOW");
+
+ /* Test red */
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_blind_check(
+ &tm, &tp, time, TM_TEST_TRTCM_EBS_DF + 1)
+ != e_RTE_METER_RED)
+ melog(TRTCM_RFC4115_BLIND_CHECK_MSG" RED");
+
+ return 0;
+}
+
/**
* @in[4] : the flags packets carries.
return 0;
}
+/**
+ * @in[4] : the flags packets carries.
+ * @in[4] : the flags function expect to return.
+ * It will do blind check at the time of 1 second from beginning.
+ * At the time, it will use packets length of cbs -1, cbs + 1,
+ * ebs -1 and ebs +1 with flag in[0], in[1], in[2] and in[3] to do
+ * aware check, expect flag out[0], out[1], out[2] and out[3]
+ */
+static inline int
+tm_test_trtcm_rfc4115_aware_check
+(enum rte_meter_color in[4], enum rte_meter_color out[4])
+{
+#define TRTCM_RFC4115_AWARE_CHECK_MSG "trtcm_rfc4115_aware_check"
+ struct rte_meter_trtcm_rfc4115_profile tp;
+ struct rte_meter_trtcm_rfc4115 tm;
+ uint64_t time;
+ uint64_t hz = rte_get_tsc_hz();
+
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_AWARE_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_aware_check(
+ &tm, &tp, time, TM_TEST_TRTCM_CBS_DF - 1, in[0]) != out[0])
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG" %u:%u", in[0], out[0]);
+
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_aware_check(
+ &tm, &tp, time, TM_TEST_TRTCM_CBS_DF + 1, in[1]) != out[1])
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG" %u:%u", in[1], out[1]);
+
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_aware_check(
+ &tm, &tp, time, TM_TEST_TRTCM_EBS_DF - 1, in[2]) != out[2])
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG" %u:%u", in[2], out[2]);
+
+ if (rte_meter_trtcm_rfc4115_profile_config(&tp, &rfc4115params) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ if (rte_meter_trtcm_rfc4115_config(&tm, &tp) != 0)
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG);
+ time = rte_get_tsc_cycles() + hz;
+ if (rte_meter_trtcm_rfc4115_color_aware_check(
+ &tm, &tp, time, TM_TEST_TRTCM_EBS_DF + 1, in[3]) != out[3])
+ melog(TRTCM_RFC4115_AWARE_CHECK_MSG" %u:%u", in[3], out[3]);
+
+ return 0;
+}
+
+/**
+ * functional test for rte_meter_trtcm_rfc4115_color_aware_check
+ */
+static inline int
+tm_test_trtcm_rfc4115_color_aware_check(void)
+{
+ enum rte_meter_color in[4], out[4];
+ /**
+ * test 4 points that will produce green, yellow, yellow, red flag
+ * if using blind check
+ */
+
+ /* previouly have a green, test points should keep unchanged */
+ in[0] = in[1] = in[2] = in[3] = e_RTE_METER_GREEN;
+ out[0] = e_RTE_METER_GREEN;
+ out[1] = e_RTE_METER_YELLOW;
+ out[2] = e_RTE_METER_YELLOW;
+ out[3] = e_RTE_METER_RED;
+ if (tm_test_trtcm_rfc4115_aware_check(in, out) != 0)
+ return -1;
+
+ in[0] = in[1] = in[2] = in[3] = e_RTE_METER_YELLOW;
+ out[0] = e_RTE_METER_YELLOW;
+ out[1] = e_RTE_METER_YELLOW;
+ out[2] = e_RTE_METER_YELLOW;
+ out[3] = e_RTE_METER_RED;
+ if (tm_test_trtcm_rfc4115_aware_check(in, out) != 0)
+ return -1;
+
+ in[0] = in[1] = in[2] = in[3] = e_RTE_METER_RED;
+ out[0] = e_RTE_METER_RED;
+ out[1] = e_RTE_METER_RED;
+ out[2] = e_RTE_METER_RED;
+ out[3] = e_RTE_METER_RED;
+ if (tm_test_trtcm_rfc4115_aware_check(in, out) != 0)
+ return -1;
+
+ return 0;
+}
+
/**
* test main entrance for library meter
*/
if (tm_test_trtcm_config() != 0)
return -1;
+ if (tm_test_trtcm_rfc4115_config() != 0)
+ return -1;
+
if (tm_test_srtcm_color_blind_check() != 0)
return -1;
if (tm_test_trtcm_color_blind_check() != 0)
return -1;
+ if (tm_test_trtcm_rfc4115_color_blind_check() != 0)
+ return -1;
+
if (tm_test_srtcm_color_aware_check() != 0)
return -1;
if (tm_test_trtcm_color_aware_check() != 0)
return -1;
+ if (tm_test_trtcm_rfc4115_color_aware_check() != 0)
+ return -1;
+
return 0;
}
git.droids-corp.org / dpdk.git / commitdiff