1 #ifndef __NET_SCHED_CODEL_H 2 #define __NET_SCHED_CODEL_H 3 4 /* 5 * Codel - The Controlled-Delay Active Queue Management algorithm 6 * 7 * Copyright (C) 2011-2012 Kathleen Nichols <nichols@pollere.com> 8 * Copyright (C) 2011-2012 Van Jacobson <van@pollere.net> 9 * Copyright (C) 2012 Michael D. Taht <dave.taht@bufferbloat.net> 10 * Copyright (C) 2012,2015 Eric Dumazet <edumazet@google.com> 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions, and the following disclaimer, 17 * without modification. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. The names of the authors may not be used to endorse or promote products 22 * derived from this software without specific prior written permission. 23 * 24 * Alternatively, provided that this notice is retained in full, this 25 * software may be distributed under the terms of the GNU General 26 * Public License ("GPL") version 2, in which case the provisions of the 27 * GPL apply INSTEAD OF those given above. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 40 * DAMAGE. 41 * 42 */ 43 44 #include <linux/types.h> 45 #include <linux/ktime.h> 46 #include <linux/skbuff.h> 47 #include <net/pkt_sched.h> 48 #include <net/inet_ecn.h> 49 50 /* Controlling Queue Delay (CoDel) algorithm 51 * ========================================= 52 * Source : Kathleen Nichols and Van Jacobson 53 * http://queue.acm.org/detail.cfm?id=2209336 54 * 55 * Implemented on linux by Dave Taht and Eric Dumazet 56 */ 57 58 59 /* CoDel uses a 1024 nsec clock, encoded in u32 60 * This gives a range of 2199 seconds, because of signed compares 61 */ 62 typedef u32 codel_time_t; 63 typedef s32 codel_tdiff_t; 64 #define CODEL_SHIFT 10 65 #define MS2TIME(a) ((a * NSEC_PER_MSEC) >> CODEL_SHIFT) 66 67 static inline codel_time_t codel_get_time(void) 68 { 69 u64 ns = ktime_get_ns(); 70 71 return ns >> CODEL_SHIFT; 72 } 73 74 /* Dealing with timer wrapping, according to RFC 1982, as desc in wikipedia: 75 * https://en.wikipedia.org/wiki/Serial_number_arithmetic#General_Solution 76 * codel_time_after(a,b) returns true if the time a is after time b. 77 */ 78 #define codel_time_after(a, b) \ 79 (typecheck(codel_time_t, a) && \ 80 typecheck(codel_time_t, b) && \ 81 ((s32)((a) - (b)) > 0)) 82 #define codel_time_before(a, b) codel_time_after(b, a) 83 84 #define codel_time_after_eq(a, b) \ 85 (typecheck(codel_time_t, a) && \ 86 typecheck(codel_time_t, b) && \ 87 ((s32)((a) - (b)) >= 0)) 88 #define codel_time_before_eq(a, b) codel_time_after_eq(b, a) 89 90 /* Qdiscs using codel plugin must use codel_skb_cb in their own cb[] */ 91 struct codel_skb_cb { 92 codel_time_t enqueue_time; 93 }; 94 95 static struct codel_skb_cb *get_codel_cb(const struct sk_buff *skb) 96 { 97 qdisc_cb_private_validate(skb, sizeof(struct codel_skb_cb)); 98 return (struct codel_skb_cb *)qdisc_skb_cb(skb)->data; 99 } 100 101 static codel_time_t codel_get_enqueue_time(const struct sk_buff *skb) 102 { 103 return get_codel_cb(skb)->enqueue_time; 104 } 105 106 static void codel_set_enqueue_time(struct sk_buff *skb) 107 { 108 get_codel_cb(skb)->enqueue_time = codel_get_time(); 109 } 110 111 static inline u32 codel_time_to_us(codel_time_t val) 112 { 113 u64 valns = ((u64)val << CODEL_SHIFT); 114 115 do_div(valns, NSEC_PER_USEC); 116 return (u32)valns; 117 } 118 119 /** 120 * struct codel_params - contains codel parameters 121 * @target: target queue size (in time units) 122 * @ce_threshold: threshold for marking packets with ECN CE 123 * @interval: width of moving time window 124 * @ecn: is Explicit Congestion Notification enabled 125 */ 126 struct codel_params { 127 codel_time_t target; 128 codel_time_t ce_threshold; 129 codel_time_t interval; 130 bool ecn; 131 }; 132 133 /** 134 * struct codel_vars - contains codel variables 135 * @count: how many drops we've done since the last time we 136 * entered dropping state 137 * @lastcount: count at entry to dropping state 138 * @dropping: set to true if in dropping state 139 * @rec_inv_sqrt: reciprocal value of sqrt(count) >> 1 140 * @first_above_time: when we went (or will go) continuously above target 141 * for interval 142 * @drop_next: time to drop next packet, or when we dropped last 143 * @ldelay: sojourn time of last dequeued packet 144 */ 145 struct codel_vars { 146 u32 count; 147 u32 lastcount; 148 bool dropping; 149 u16 rec_inv_sqrt; 150 codel_time_t first_above_time; 151 codel_time_t drop_next; 152 codel_time_t ldelay; 153 }; 154 155 #define REC_INV_SQRT_BITS (8 * sizeof(u16)) /* or sizeof_in_bits(rec_inv_sqrt) */ 156 /* needed shift to get a Q0.32 number from rec_inv_sqrt */ 157 #define REC_INV_SQRT_SHIFT (32 - REC_INV_SQRT_BITS) 158 159 /** 160 * struct codel_stats - contains codel shared variables and stats 161 * @maxpacket: largest packet we've seen so far 162 * @drop_count: temp count of dropped packets in dequeue() 163 * ecn_mark: number of packets we ECN marked instead of dropping 164 * ce_mark: number of packets CE marked because sojourn time was above ce_threshold 165 */ 166 struct codel_stats { 167 u32 maxpacket; 168 u32 drop_count; 169 u32 ecn_mark; 170 u32 ce_mark; 171 }; 172 173 #define CODEL_DISABLED_THRESHOLD INT_MAX 174 175 static void codel_params_init(struct codel_params *params) 176 { 177 params->interval = MS2TIME(100); 178 params->target = MS2TIME(5); 179 params->ce_threshold = CODEL_DISABLED_THRESHOLD; 180 params->ecn = false; 181 } 182 183 static void codel_vars_init(struct codel_vars *vars) 184 { 185 memset(vars, 0, sizeof(*vars)); 186 } 187 188 static void codel_stats_init(struct codel_stats *stats) 189 { 190 stats->maxpacket = 256; 191 } 192 193 /* 194 * http://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Iterative_methods_for_reciprocal_square_roots 195 * new_invsqrt = (invsqrt / 2) * (3 - count * invsqrt^2) 196 * 197 * Here, invsqrt is a fixed point number (< 1.0), 32bit mantissa, aka Q0.32 198 */ 199 static void codel_Newton_step(struct codel_vars *vars) 200 { 201 u32 invsqrt = ((u32)vars->rec_inv_sqrt) << REC_INV_SQRT_SHIFT; 202 u32 invsqrt2 = ((u64)invsqrt * invsqrt) >> 32; 203 u64 val = (3LL << 32) - ((u64)vars->count * invsqrt2); 204 205 val >>= 2; /* avoid overflow in following multiply */ 206 val = (val * invsqrt) >> (32 - 2 + 1); 207 208 vars->rec_inv_sqrt = val >> REC_INV_SQRT_SHIFT; 209 } 210 211 /* 212 * CoDel control_law is t + interval/sqrt(count) 213 * We maintain in rec_inv_sqrt the reciprocal value of sqrt(count) to avoid 214 * both sqrt() and divide operation. 215 */ 216 static codel_time_t codel_control_law(codel_time_t t, 217 codel_time_t interval, 218 u32 rec_inv_sqrt) 219 { 220 return t + reciprocal_scale(interval, rec_inv_sqrt << REC_INV_SQRT_SHIFT); 221 } 222 223 static bool codel_should_drop(const struct sk_buff *skb, 224 struct Qdisc *sch, 225 struct codel_vars *vars, 226 struct codel_params *params, 227 struct codel_stats *stats, 228 codel_time_t now) 229 { 230 bool ok_to_drop; 231 232 if (!skb) { 233 vars->first_above_time = 0; 234 return false; 235 } 236 237 vars->ldelay = now - codel_get_enqueue_time(skb); 238 sch->qstats.backlog -= qdisc_pkt_len(skb); 239 240 if (unlikely(qdisc_pkt_len(skb) > stats->maxpacket)) 241 stats->maxpacket = qdisc_pkt_len(skb); 242 243 if (codel_time_before(vars->ldelay, params->target) || 244 sch->qstats.backlog <= stats->maxpacket) { 245 /* went below - stay below for at least interval */ 246 vars->first_above_time = 0; 247 return false; 248 } 249 ok_to_drop = false; 250 if (vars->first_above_time == 0) { 251 /* just went above from below. If we stay above 252 * for at least interval we'll say it's ok to drop 253 */ 254 vars->first_above_time = now + params->interval; 255 } else if (codel_time_after(now, vars->first_above_time)) { 256 ok_to_drop = true; 257 } 258 return ok_to_drop; 259 } 260 261 typedef struct sk_buff * (*codel_skb_dequeue_t)(struct codel_vars *vars, 262 struct Qdisc *sch); 263 264 static struct sk_buff *codel_dequeue(struct Qdisc *sch, 265 struct codel_params *params, 266 struct codel_vars *vars, 267 struct codel_stats *stats, 268 codel_skb_dequeue_t dequeue_func) 269 { 270 struct sk_buff *skb = dequeue_func(vars, sch); 271 codel_time_t now; 272 bool drop; 273 274 if (!skb) { 275 vars->dropping = false; 276 return skb; 277 } 278 now = codel_get_time(); 279 drop = codel_should_drop(skb, sch, vars, params, stats, now); 280 if (vars->dropping) { 281 if (!drop) { 282 /* sojourn time below target - leave dropping state */ 283 vars->dropping = false; 284 } else if (codel_time_after_eq(now, vars->drop_next)) { 285 /* It's time for the next drop. Drop the current 286 * packet and dequeue the next. The dequeue might 287 * take us out of dropping state. 288 * If not, schedule the next drop. 289 * A large backlog might result in drop rates so high 290 * that the next drop should happen now, 291 * hence the while loop. 292 */ 293 while (vars->dropping && 294 codel_time_after_eq(now, vars->drop_next)) { 295 vars->count++; /* dont care of possible wrap 296 * since there is no more divide 297 */ 298 codel_Newton_step(vars); 299 if (params->ecn && INET_ECN_set_ce(skb)) { 300 stats->ecn_mark++; 301 vars->drop_next = 302 codel_control_law(vars->drop_next, 303 params->interval, 304 vars->rec_inv_sqrt); 305 goto end; 306 } 307 qdisc_drop(skb, sch); 308 stats->drop_count++; 309 skb = dequeue_func(vars, sch); 310 if (!codel_should_drop(skb, sch, 311 vars, params, stats, now)) { 312 /* leave dropping state */ 313 vars->dropping = false; 314 } else { 315 /* and schedule the next drop */ 316 vars->drop_next = 317 codel_control_law(vars->drop_next, 318 params->interval, 319 vars->rec_inv_sqrt); 320 } 321 } 322 } 323 } else if (drop) { 324 u32 delta; 325 326 if (params->ecn && INET_ECN_set_ce(skb)) { 327 stats->ecn_mark++; 328 } else { 329 qdisc_drop(skb, sch); 330 stats->drop_count++; 331 332 skb = dequeue_func(vars, sch); 333 drop = codel_should_drop(skb, sch, vars, params, 334 stats, now); 335 } 336 vars->dropping = true; 337 /* if min went above target close to when we last went below it 338 * assume that the drop rate that controlled the queue on the 339 * last cycle is a good starting point to control it now. 340 */ 341 delta = vars->count - vars->lastcount; 342 if (delta > 1 && 343 codel_time_before(now - vars->drop_next, 344 16 * params->interval)) { 345 vars->count = delta; 346 /* we dont care if rec_inv_sqrt approximation 347 * is not very precise : 348 * Next Newton steps will correct it quadratically. 349 */ 350 codel_Newton_step(vars); 351 } else { 352 vars->count = 1; 353 vars->rec_inv_sqrt = ~0U >> REC_INV_SQRT_SHIFT; 354 } 355 vars->lastcount = vars->count; 356 vars->drop_next = codel_control_law(now, params->interval, 357 vars->rec_inv_sqrt); 358 } 359 end: 360 if (skb && codel_time_after(vars->ldelay, params->ce_threshold) && 361 INET_ECN_set_ce(skb)) 362 stats->ce_mark++; 363 return skb; 364 } 365 #endif 366