X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_sched%2Frte_red.h;h=ca1222755df409f6057aa38605ed42669b45b889;hb=63b32fda0c575609429a3c93078b6049c7bdebf1;hp=0d8412ff3cbe6d6ee2d02311be75a6441c891bf2;hpb=3031749c2df04a63cdcef186dcce3781e61436e8;p=dpdk.git diff --git a/lib/librte_sched/rte_red.h b/lib/librte_sched/rte_red.h index 0d8412ff3c..ca1222755d 100644 --- a/lib/librte_sched/rte_red.h +++ b/lib/librte_sched/rte_red.h @@ -63,19 +63,6 @@ extern "C" { #define RTE_RED_INT16_NBITS (sizeof(uint16_t) * CHAR_BIT) #define RTE_RED_WQ_LOG2_NUM (RTE_RED_WQ_LOG2_MAX - RTE_RED_WQ_LOG2_MIN + 1) -#ifdef RTE_RED_DEBUG - -#define RTE_RED_ASSERT(exp) \ -if (!(exp)) { \ - rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \ -} - -#else - -#define RTE_RED_ASSERT(exp) do { } while(0) - -#endif /* RTE_RED_DEBUG */ - /** * Externs * @@ -119,7 +106,7 @@ struct rte_red { /** * @brief Initialises run-time data * - * @param [in,out] data pointer to RED runtime data + * @param red [in,out] data pointer to RED runtime data * * @return Operation status * @retval 0 success @@ -131,12 +118,12 @@ rte_red_rt_data_init(struct rte_red *red); /** * @brief Configures a single RED configuration parameter structure. * - * @param [in,out] config pointer to a RED configuration parameter structure - * @param [in] wq_log2 log2 of the filter weight, valid range is: + * @param red_cfg [in,out] config pointer to a RED configuration parameter structure + * @param wq_log2 [in] log2 of the filter weight, valid range is: * RTE_RED_WQ_LOG2_MIN <= wq_log2 <= RTE_RED_WQ_LOG2_MAX - * @param [in] min_th queue minimum threshold in number of packets - * @param [in] max_th queue maximum threshold in number of packets - * @param [in] maxp_inv inverse maximum mark probability + * @param min_th [in] queue minimum threshold in number of packets + * @param max_th [in] queue maximum threshold in number of packets + * @param maxp_inv [in] inverse maximum mark probability * * @return Operation status * @retval 0 success @@ -163,15 +150,15 @@ static inline uint32_t rte_fast_rand(void) { rte_red_rand_seed = (214013 * rte_red_rand_seed) + 2531011; - return (rte_red_rand_seed >> 10); + return rte_red_rand_seed >> 10; } /** * @brief calculate factor to scale average queue size when queue * becomes empty * - * @param [in] wq_log2, where EWMA filter weight wq = 1/(2 ^ wq_log2) - * @param [in] m exponent in the computed value (1 - wq) ^ m + * @param wq_log2 [in] where EWMA filter weight wq = 1/(2 ^ wq_log2) + * @param m [in] exponent in the computed value (1 - wq) ^ m * * @return computed value * @retval ((1 - wq) ^ m) scaled in fixed-point format @@ -230,9 +217,9 @@ __rte_red_calc_qempty_factor(uint8_t wq_log2, uint16_t m) * * Note: packet is never dropped in this particular case. * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] time current time stamp + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param time [in] current time stamp * * @return Operation status * @retval 0 enqueue the packet @@ -246,8 +233,8 @@ rte_red_enqueue_empty(const struct rte_red_config *red_cfg, { uint64_t time_diff = 0, m = 0; - RTE_RED_ASSERT(red_cfg != NULL); - RTE_RED_ASSERT(red != NULL); + RTE_ASSERT(red_cfg != NULL); + RTE_ASSERT(red != NULL); red->count ++; @@ -310,8 +297,8 @@ rte_red_enqueue_empty(const struct rte_red_config *red_cfg, * @brief make a decision to drop or enqueue a packet based on mark probability * criteria * - * @param [in] config pointer to structure defining RED parameters - * @param [in,out] data pointer to RED runtime data + * @param red_cfg [in] config pointer to structure defining RED parameters + * @param red [in,out] data pointer to RED runtime data * * @return operation status * @retval 0 enqueue the packet @@ -347,9 +334,9 @@ __rte_red_drop(const struct rte_red_config *red_cfg, struct rte_red *red) /** * @brief Decides if new packet should be enqeued or dropped in queue non-empty case * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] q current queue size (measured in packets) + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param q [in] current queue size (measured in packets) * * @return Operation status * @retval 0 enqueue the packet @@ -361,8 +348,8 @@ rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg, struct rte_red *red, const unsigned q) { - RTE_RED_ASSERT(red_cfg != NULL); - RTE_RED_ASSERT(red != NULL); + RTE_ASSERT(red_cfg != NULL); + RTE_ASSERT(red != NULL); /** * EWMA filter (Sally Floyd and Van Jacobson): @@ -408,10 +395,10 @@ rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg, * Based on new queue average and RED configuration parameters * gives verdict whether to enqueue or drop the packet. * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] q updated queue size in packets - * @param [in] time current time stamp + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param q [in] updated queue size in packets + * @param time [in] current time stamp * * @return Operation status * @retval 0 enqueue the packet @@ -424,8 +411,8 @@ rte_red_enqueue(const struct rte_red_config *red_cfg, const unsigned q, const uint64_t time) { - RTE_RED_ASSERT(red_cfg != NULL); - RTE_RED_ASSERT(red != NULL); + RTE_ASSERT(red_cfg != NULL); + RTE_ASSERT(red != NULL); if (q != 0) { return rte_red_enqueue_nonempty(red_cfg, red, q); @@ -437,8 +424,8 @@ rte_red_enqueue(const struct rte_red_config *red_cfg, /** * @brief Callback to records time that queue became empty * - * @param [in,out] data pointer to RED runtime data - * @param [in] time current time stamp + * @param red [in,out] data pointer to RED runtime data + * @param time [in] current time stamp */ static inline void rte_red_mark_queue_empty(struct rte_red *red, const uint64_t time)