lib/librte_sched/rte_red.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __RTE_RED_H_INCLUDED__
  35 #define __RTE_RED_H_INCLUDED__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Random Early Detection (RED)
  44  *
  45  *
  46  ***/
  47
  48 #include <stdint.h>
  49 #include <limits.h>
  50 #include <rte_common.h>
  51 #include <rte_debug.h>
  52 #include <rte_cycles.h>
  53 #include <rte_branch_prediction.h>
  54
  55 #define RTE_RED_SCALING                     10         /**< Fraction size for fixed-point */
  56 #define RTE_RED_S                           (1 << 22)  /**< Packet size multiplied by number of leaf queues */
  57 #define RTE_RED_MAX_TH_MAX                  1023       /**< Max threshold limit in fixed point format */
  58 #define RTE_RED_WQ_LOG2_MIN                 1          /**< Min inverse filter weight value */
  59 #define RTE_RED_WQ_LOG2_MAX                 12         /**< Max inverse filter weight value */
  60 #define RTE_RED_MAXP_INV_MIN                1          /**< Min inverse mark probability value */
  61 #define RTE_RED_MAXP_INV_MAX                255        /**< Max inverse mark probability value */
  62 #define RTE_RED_2POW16                      (1<<16)    /**< 2 power 16 */
  63 #define RTE_RED_INT16_NBITS                 (sizeof(uint16_t) * CHAR_BIT)
  64 #define RTE_RED_WQ_LOG2_NUM                 (RTE_RED_WQ_LOG2_MAX - RTE_RED_WQ_LOG2_MIN + 1)
  65
  66 #ifdef RTE_RED_DEBUG
  67
  68 #define RTE_RED_ASSERT(exp)                                      \
  69 if (!(exp)) {                                                    \
  70         rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
  71 }
  72
  73 #else
  74
  75 #define RTE_RED_ASSERT(exp)                 do { } while(0)
  76
  77 #endif /* RTE_RED_DEBUG */
  78
  79 /**
  80  * Externs
  81  */
  82 extern uint32_t rte_red_rand_val;
  83 extern uint32_t rte_red_rand_seed;
  84 extern uint16_t rte_red_log2_1_minus_Wq[RTE_RED_WQ_LOG2_NUM];
  85 extern uint16_t rte_red_pow2_frac_inv[16];
  86
  87 /**
  88  * RED configuration parameters passed by user
  89  */
  90 struct rte_red_params {
  91         uint16_t min_th;   /**< Minimum threshold for queue (max_th) */
  92         uint16_t max_th;   /**< Maximum threshold for queue (max_th) */
  93         uint16_t maxp_inv; /**< Inverse of packet marking probability maximum value (maxp = 1 / maxp_inv) */
  94         uint16_t wq_log2;  /**< Negated log2 of queue weight (wq = 1 / (2 ^ wq_log2)) */
  95 };
  96
  97 /**
  98  * RED configuration parameters
  99  */
 100 struct rte_red_config {
 101         uint32_t min_th;   /**< min_th scaled in fixed-point format */
 102         uint32_t max_th;   /**< max_th scaled in fixed-point format */
 103         uint32_t pa_const; /**< Precomputed constant value used for pa calculation (scaled in fixed-point format) */
 104         uint8_t maxp_inv;  /**< maxp_inv */
 105         uint8_t wq_log2;   /**< wq_log2 */
 106 };
 107
 108 /**
 109  * RED run-time data
 110  */
 111 struct rte_red {
 112         uint32_t avg;      /**< Average queue size (avg), scaled in fixed-point format */
 113         uint32_t count;    /**< Number of packets since last marked packet (count) */
 114         uint64_t q_time;   /**< Start of the queue idle time (q_time) */
 115 };
 116
 117 /**
 118  * @brief Initialises run-time data
 119  *
 120  * @param [in,out] data pointer to RED runtime data
 121  *
 122  * @return Operation status
 123  * @retval 0 success
 124  * @retval !0 error
 125  */
 126 int
 127 rte_red_rt_data_init(struct rte_red *red);
 128
 129 /**
 130  * @brief Configures a single RED configuration parameter structure.
 131  *
 132  * @param [in,out] config pointer to a RED configuration parameter structure
 133  * @param [in] wq_log2 log2 of the filter weight, valid range is:
 134  *             RTE_RED_WQ_LOG2_MIN <= wq_log2 <= RTE_RED_WQ_LOG2_MAX
 135  * @param [in] min_th queue minimum threshold in number of packets
 136  * @param [in] max_th queue maximum threshold in number of packets
 137  * @param [in] maxp_inv inverse maximum mark probability
 138  *
 139  * @return Operation status
 140  * @retval 0 success
 141  * @retval !0 error
 142  */
 143 int
 144 rte_red_config_init(struct rte_red_config *red_cfg,
 145         const uint16_t wq_log2,
 146         const uint16_t min_th,
 147         const uint16_t max_th,
 148         const uint16_t maxp_inv);
 149
 150 /**
 151  * @brief Generate random number for RED
 152  *
 153  * Implemenetation based on:
 154  * http://software.intel.com/en-us/articles/fast-random-number-generator-on-the-intel-pentiumr-4-processor/
 155  *
 156  * 10 bit shift has been found through empirical tests (was 16).
 157  *
 158  * @return Random number between 0 and (2^22 - 1)
 159  */
 160 static inline uint32_t
 161 rte_fast_rand(void)
 162 {
 163         rte_red_rand_seed = (214013 * rte_red_rand_seed) + 2531011;
 164         return (rte_red_rand_seed >> 10);
 165 }
 166
 167 /**
 168  * @brief calculate factor to scale average queue size when queue
 169  *        becomes empty
 170  *
 171  * @param [in] wq_log2, where EWMA filter weight wq = 1/(2 ^ wq_log2)
 172  * @param [in] m exponent in the computed value (1 - wq) ^ m
 173  *
 174  * @return computed value
 175  * @retval ((1 - wq) ^ m) scaled in fixed-point format
 176  */
 177 static inline uint16_t
 178 __rte_red_calc_qempty_factor(uint8_t wq_log2, uint16_t m)
 179 {
 180         uint32_t n = 0;
 181         uint32_t f = 0;
 182
 183         /**
 184          * Basic math tells us that:
 185          *   a^b = 2^(b * log2(a) )
 186          *
 187          * in our case:
 188          *   a = (1-Wq)
 189          *   b = m
 190          *  Wq = 1/ (2^log2n)
 191          *
 192          * So we are computing this equation:
 193          *   factor = 2 ^ ( m * log2(1-Wq))
 194          *
 195          * First we are computing:
 196          *    n = m * log2(1-Wq)
 197          *
 198          * To avoid dealing with signed numbers log2 values are positive
 199          * but they should be negative because (1-Wq) is always < 1.
 200          * Contents of log2 table values are also scaled for precision.
 201          */
 202
 203         n = m * rte_red_log2_1_minus_Wq[wq_log2 - RTE_RED_WQ_LOG2_MIN];
 204
 205         /**
 206          * The tricky part is computing 2^n, for this I split n into
 207          * integer part and fraction part.
 208          *   f - is fraction part of n
 209          *   n - is integer part of original n
 210          *
 211          * Now using basic math we compute 2^n:
 212          *   2^(f+n) = 2^f * 2^n
 213          *   2^f - we use lookup table
 214          *   2^n - can be replaced with bit shift right oeprations
 215          */
 216
 217         f = (n >> 6) & 0xf;
 218         n >>= 10;
 219
 220         if (n < RTE_RED_SCALING)
 221                 return (uint16_t) ((rte_red_pow2_frac_inv[f] + (1 << (n - 1))) >> n);
 222
 223         return 0;
 224 }
 225
 226 /**
 227  * @brief Updates queue average in condition when queue is empty
 228  *
 229  * Note: packet is never dropped in this particular case.
 230  *
 231  * @param [in] config pointer to a RED configuration parameter structure
 232  * @param [in,out] data pointer to RED runtime data
 233  * @param [in] time current time stamp
 234  *
 235  * @return Operation status
 236  * @retval 0 enqueue the packet
 237  * @retval 1 drop the packet based on max threshold criterion
 238  * @retval 2 drop the packet based on mark probability criterion
 239  */
 240 static inline int
 241 rte_red_enqueue_empty(const struct rte_red_config *red_cfg,
 242         struct rte_red *red,
 243         const uint64_t time)
 244 {
 245         uint64_t time_diff = 0, m = 0;
 246
 247         RTE_RED_ASSERT(red_cfg != NULL);
 248         RTE_RED_ASSERT(red != NULL);
 249
 250         red->count ++;
 251
 252         /**
 253          * We compute avg but we don't compare avg against
 254          *  min_th or max_th, nor calculate drop probability
 255          */
 256         time_diff = time - red->q_time;
 257
 258         /**
 259          * m is the number of packets that might have arrived while the queue was empty.
 260          * In this case we have time stamps provided by scheduler in byte units (bytes
 261          * transmitted on network port). Such time stamp translates into time units as
 262          * port speed is fixed but such approach simplifies the code.
 263          */
 264         m = time_diff / RTE_RED_S;
 265
 266         /**
 267          * Check that m will fit into 16-bit unsigned integer
 268          */
 269         if (m >= RTE_RED_2POW16) {
 270                 red->avg = 0;
 271         } else {
 272                 red->avg = (red->avg >> RTE_RED_SCALING) * __rte_red_calc_qempty_factor(red_cfg->wq_log2, (uint16_t) m);
 273         }
 274
 275         return 0;
 276 }
 277
 278 /**
 279  *  Drop probability (Sally Floyd and Van Jacobson):
 280  *
 281  *     pb = (1 / maxp_inv) * (avg - min_th) / (max_th - min_th)
 282  *     pa = pb / (2 - count * pb)
 283  *
 284  *
 285  *                 (1 / maxp_inv) * (avg - min_th)
 286  *                ---------------------------------
 287  *                         max_th - min_th
 288  *     pa = -----------------------------------------------
 289  *                count * (1 / maxp_inv) * (avg - min_th)
 290  *           2 - -----------------------------------------
 291  *                          max_th - min_th
 292  *
 293  *
 294  *                                  avg - min_th
 295  *     pa = -----------------------------------------------------------
 296  *           2 * (max_th - min_th) * maxp_inv - count * (avg - min_th)
 297  *
 298  *
 299  *  We define pa_const as: pa_const =  2 * (max_th - min_th) * maxp_inv. Then:
 300  *
 301  *
 302  *                     avg - min_th
 303  *     pa = -----------------------------------
 304  *           pa_const - count * (avg - min_th)
 305  */
 306
 307 /**
 308  * @brief make a decision to drop or enqueue a packet based on mark probability
 309  *        criteria
 310  *
 311  * @param [in] config pointer to structure defining RED parameters
 312  * @param [in,out] data pointer to RED runtime data
 313  *
 314  * @return operation status
 315  * @retval 0 enqueue the packet
 316  * @retval 1 drop the packet
 317  */
 318 static inline int
 319 __rte_red_drop(const struct rte_red_config *red_cfg, struct rte_red *red)
 320 {
 321         uint32_t pa_num = 0;    /* numerator of drop-probability */
 322         uint32_t pa_den = 0;    /* denominator of drop-probability */
 323         uint32_t pa_num_count = 0;
 324
 325         pa_num = (red->avg - red_cfg->min_th) >> (red_cfg->wq_log2);
 326
 327         pa_num_count = red->count * pa_num;
 328
 329         if (red_cfg->pa_const <= pa_num_count)
 330                 return 1;
 331
 332         pa_den = red_cfg->pa_const - pa_num_count;
 333
 334         /* If drop, generate and save random number to be used next time */
 335         if (unlikely((rte_red_rand_val % pa_den) < pa_num)) {
 336                 rte_red_rand_val = rte_fast_rand();
 337
 338                 return 1;
 339         }
 340
 341         /* No drop */
 342         return 0;
 343 }
 344
 345 /**
 346  * @brief Decides if new packet should be enqeued or dropped in queue non-empty case
 347  *
 348  * @param [in] config pointer to a RED configuration parameter structure
 349  * @param [in,out] data pointer to RED runtime data
 350  * @param [in] q current queue size (measured in packets)
 351  *
 352  * @return Operation status
 353  * @retval 0 enqueue the packet
 354  * @retval 1 drop the packet based on max threshold criterion
 355  * @retval 2 drop the packet based on mark probability criterion
 356  */
 357 static inline int
 358 rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg,
 359         struct rte_red *red,
 360         const unsigned q)
 361 {
 362         RTE_RED_ASSERT(red_cfg != NULL);
 363         RTE_RED_ASSERT(red != NULL);
 364
 365         /**
 366         * EWMA filter (Sally Floyd and Van Jacobson):
 367         *    avg = (1 - wq) * avg + wq * q
 368         *    avg = avg + q * wq - avg * wq
 369         *
 370         * We select: wq = 2^(-n). Let scaled version of avg be: avg_s = avg * 2^(N+n). We get:
 371         *    avg_s = avg_s + q * 2^N - avg_s * 2^(-n)
 372         *
 373         * By using shift left/right operations, we get:
 374         *    avg_s = avg_s + (q << N) - (avg_s >> n)
 375         *    avg_s += (q << N) - (avg_s >> n)
 376         */
 377
 378         /* avg update */
 379         red->avg += (q << RTE_RED_SCALING) - (red->avg >> red_cfg->wq_log2);
 380
 381         /* avg < min_th: do not mark the packet  */
 382         if (red->avg < red_cfg->min_th) {
 383                 red->count ++;
 384                 return 0;
 385         }
 386
 387         /* min_th <= avg < max_th: mark the packet with pa probability */
 388         if (red->avg < red_cfg->max_th) {
 389                 if (!__rte_red_drop(red_cfg, red)) {
 390                         red->count ++;
 391                         return 0;
 392                 }
 393
 394                 red->count = 0;
 395                 return 2;
 396         }
 397
 398         /* max_th <= avg: always mark the packet */
 399         red->count = 0;
 400         return 1;
 401 }
 402
 403 /**
 404  * @brief Decides if new packet should be enqeued or dropped
 405  * Updates run time data based on new queue size value.
 406  * Based on new queue average and RED configuration parameters
 407  * gives verdict whether to enqueue or drop the packet.
 408  *
 409  * @param [in] config pointer to a RED configuration parameter structure
 410  * @param [in,out] data pointer to RED runtime data
 411  * @param [in] q updated queue size in packets
 412  * @param [in] time current time stamp
 413  *
 414  * @return Operation status
 415  * @retval 0 enqueue the packet
 416  * @retval 1 drop the packet based on max threshold criteria
 417  * @retval 2 drop the packet based on mark probability criteria
 418  */
 419 static inline int
 420 rte_red_enqueue(const struct rte_red_config *red_cfg,
 421         struct rte_red *red,
 422         const unsigned q,
 423         const uint64_t time)
 424 {
 425         RTE_RED_ASSERT(red_cfg != NULL);
 426         RTE_RED_ASSERT(red != NULL);
 427
 428         if (q != 0) {
 429                 return rte_red_enqueue_nonempty(red_cfg, red, q);
 430         } else {
 431                 return rte_red_enqueue_empty(red_cfg, red, time);
 432         }
 433 }
 434
 435 /**
 436  * @brief Callback to records time that queue became empty
 437  *
 438  * @param [in,out] data pointer to RED runtime data
 439  * @param [in] time current time stamp
 440  */
 441 static inline void
 442 rte_red_mark_queue_empty(struct rte_red *red, const uint64_t time)
 443 {
 444         red->q_time = time;
 445 }
 446
 447 #ifdef __cplusplus
 448 }
 449 #endif
 450
 451 #endif /* __RTE_RED_H_INCLUDED__ */