X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_sched%2Frte_red.h;h=ca1222755df409f6057aa38605ed42669b45b889;hb=cbc12b0a96f5751ab2ed10001f44d39211e3bd45;hp=debe556f4ca87f0450f79a5eec52e5d557a2fcf9;hpb=de3cfa2c9823a7e0391d4f4a355e2d78b83eec62;p=dpdk.git diff --git a/lib/librte_sched/rte_red.h b/lib/librte_sched/rte_red.h index debe556f4c..ca1222755d 100644 --- a/lib/librte_sched/rte_red.h +++ b/lib/librte_sched/rte_red.h @@ -1,35 +1,34 @@ /*- * BSD LICENSE - * - * Copyright(c) 2010-2013 Intel Corporation. All rights reserved. + * + * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions * are met: - * - * * Redistributions of source code must retain the above copyright + * + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the * distribution. - * * Neither the name of Intel Corporation nor the names of its - * contributors may be used to endorse or promote products derived + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * */ #ifndef __RTE_RED_H_INCLUDED__ @@ -64,22 +63,9 @@ 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 - * + * */ extern uint32_t rte_red_rand_val; extern uint32_t rte_red_rand_seed; @@ -88,7 +74,7 @@ extern uint16_t rte_red_pow2_frac_inv[16]; /** * RED configuration parameters passed by user - * + * */ struct rte_red_params { uint16_t min_th; /**< Minimum threshold for queue (max_th) */ @@ -117,10 +103,10 @@ struct rte_red { uint64_t q_time; /**< Start of the queue idle time (q_time) */ }; -/** +/** * @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 @@ -129,16 +115,16 @@ struct rte_red { int 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 * @retval !0 error @@ -164,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 @@ -226,15 +212,15 @@ __rte_red_calc_qempty_factor(uint8_t wq_log2, uint16_t m) return 0; } -/** +/** * @brief Updates queue average in condition when queue is empty * * 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 * @retval 1 drop the packet based on max threshold criterion @@ -246,9 +232,9 @@ rte_red_enqueue_empty(const struct rte_red_config *red_cfg, const uint64_t time) { 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 ++; @@ -260,7 +246,7 @@ rte_red_enqueue_empty(const struct rte_red_config *red_cfg, /** * m is the number of packets that might have arrived while the queue was empty. - * In this case we have time stamps provided by scheduler in byte units (bytes + * In this case we have time stamps provided by scheduler in byte units (bytes * transmitted on network port). Such time stamp translates into time units as * port speed is fixed but such approach simplifies the code. */ @@ -311,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 @@ -337,21 +323,21 @@ __rte_red_drop(const struct rte_red_config *red_cfg, struct rte_red *red) /* If drop, generate and save random number to be used next time */ if (unlikely((rte_red_rand_val % pa_den) < pa_num)) { rte_red_rand_val = rte_fast_rand(); - + return 1; } - + /* No drop */ return 0; } -/** +/** * @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 * @retval 1 drop the packet based on max threshold criterion @@ -362,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): @@ -377,7 +363,7 @@ rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg, * avg_s = avg_s + (q << N) - (avg_s >> n) * avg_s += (q << N) - (avg_s >> n) */ - + /* avg update */ red->avg += (q << RTE_RED_SCALING) - (red->avg >> red_cfg->wq_log2); @@ -397,23 +383,23 @@ rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg, red->count = 0; return 2; } - + /* max_th <= avg: always mark the packet */ red->count = 0; return 1; } -/** +/** * @brief Decides if new packet should be enqeued or dropped * Updates run time data based on new queue size value. * Based on new queue average and RED configuration parameters - * gives verdict whether to enqueue or drop the packet. + * gives verdict whether to enqueue or drop the packet. + * + * @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 * - * @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 - * * @return Operation status * @retval 0 enqueue the packet * @retval 1 drop the packet based on max threshold criteria @@ -425,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); @@ -435,11 +421,11 @@ 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)