Linux 4.19.168
[linux/fpc-iii.git] / net / sched / sch_sfb.c
blob1aa95e761671e9d5d376b4fe4b503263f0f42714
1 /*
2 * net/sched/sch_sfb.c Stochastic Fair Blue
4 * Copyright (c) 2008-2011 Juliusz Chroboczek <jch@pps.jussieu.fr>
5 * Copyright (c) 2011 Eric Dumazet <eric.dumazet@gmail.com>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
11 * W. Feng, D. Kandlur, D. Saha, K. Shin. Blue:
12 * A New Class of Active Queue Management Algorithms.
13 * U. Michigan CSE-TR-387-99, April 1999.
15 * http://www.thefengs.com/wuchang/blue/CSE-TR-387-99.pdf
19 #include <linux/module.h>
20 #include <linux/types.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/skbuff.h>
24 #include <linux/random.h>
25 #include <linux/siphash.h>
26 #include <net/ip.h>
27 #include <net/pkt_sched.h>
28 #include <net/pkt_cls.h>
29 #include <net/inet_ecn.h>
32 * SFB uses two B[l][n] : L x N arrays of bins (L levels, N bins per level)
33 * This implementation uses L = 8 and N = 16
34 * This permits us to split one 32bit hash (provided per packet by rxhash or
35 * external classifier) into 8 subhashes of 4 bits.
37 #define SFB_BUCKET_SHIFT 4
38 #define SFB_NUMBUCKETS (1 << SFB_BUCKET_SHIFT) /* N bins per Level */
39 #define SFB_BUCKET_MASK (SFB_NUMBUCKETS - 1)
40 #define SFB_LEVELS (32 / SFB_BUCKET_SHIFT) /* L */
42 /* SFB algo uses a virtual queue, named "bin" */
43 struct sfb_bucket {
44 u16 qlen; /* length of virtual queue */
45 u16 p_mark; /* marking probability */
48 /* We use a double buffering right before hash change
49 * (Section 4.4 of SFB reference : moving hash functions)
51 struct sfb_bins {
52 siphash_key_t perturbation; /* siphash key */
53 struct sfb_bucket bins[SFB_LEVELS][SFB_NUMBUCKETS];
56 struct sfb_sched_data {
57 struct Qdisc *qdisc;
58 struct tcf_proto __rcu *filter_list;
59 struct tcf_block *block;
60 unsigned long rehash_interval;
61 unsigned long warmup_time; /* double buffering warmup time in jiffies */
62 u32 max;
63 u32 bin_size; /* maximum queue length per bin */
64 u32 increment; /* d1 */
65 u32 decrement; /* d2 */
66 u32 limit; /* HARD maximal queue length */
67 u32 penalty_rate;
68 u32 penalty_burst;
69 u32 tokens_avail;
70 unsigned long rehash_time;
71 unsigned long token_time;
73 u8 slot; /* current active bins (0 or 1) */
74 bool double_buffering;
75 struct sfb_bins bins[2];
77 struct {
78 u32 earlydrop;
79 u32 penaltydrop;
80 u32 bucketdrop;
81 u32 queuedrop;
82 u32 childdrop; /* drops in child qdisc */
83 u32 marked; /* ECN mark */
84 } stats;
88 * Each queued skb might be hashed on one or two bins
89 * We store in skb_cb the two hash values.
90 * (A zero value means double buffering was not used)
92 struct sfb_skb_cb {
93 u32 hashes[2];
96 static inline struct sfb_skb_cb *sfb_skb_cb(const struct sk_buff *skb)
98 qdisc_cb_private_validate(skb, sizeof(struct sfb_skb_cb));
99 return (struct sfb_skb_cb *)qdisc_skb_cb(skb)->data;
103 * If using 'internal' SFB flow classifier, hash comes from skb rxhash
104 * If using external classifier, hash comes from the classid.
106 static u32 sfb_hash(const struct sk_buff *skb, u32 slot)
108 return sfb_skb_cb(skb)->hashes[slot];
111 /* Probabilities are coded as Q0.16 fixed-point values,
112 * with 0xFFFF representing 65535/65536 (almost 1.0)
113 * Addition and subtraction are saturating in [0, 65535]
115 static u32 prob_plus(u32 p1, u32 p2)
117 u32 res = p1 + p2;
119 return min_t(u32, res, SFB_MAX_PROB);
122 static u32 prob_minus(u32 p1, u32 p2)
124 return p1 > p2 ? p1 - p2 : 0;
127 static void increment_one_qlen(u32 sfbhash, u32 slot, struct sfb_sched_data *q)
129 int i;
130 struct sfb_bucket *b = &q->bins[slot].bins[0][0];
132 for (i = 0; i < SFB_LEVELS; i++) {
133 u32 hash = sfbhash & SFB_BUCKET_MASK;
135 sfbhash >>= SFB_BUCKET_SHIFT;
136 if (b[hash].qlen < 0xFFFF)
137 b[hash].qlen++;
138 b += SFB_NUMBUCKETS; /* next level */
142 static void increment_qlen(const struct sk_buff *skb, struct sfb_sched_data *q)
144 u32 sfbhash;
146 sfbhash = sfb_hash(skb, 0);
147 if (sfbhash)
148 increment_one_qlen(sfbhash, 0, q);
150 sfbhash = sfb_hash(skb, 1);
151 if (sfbhash)
152 increment_one_qlen(sfbhash, 1, q);
155 static void decrement_one_qlen(u32 sfbhash, u32 slot,
156 struct sfb_sched_data *q)
158 int i;
159 struct sfb_bucket *b = &q->bins[slot].bins[0][0];
161 for (i = 0; i < SFB_LEVELS; i++) {
162 u32 hash = sfbhash & SFB_BUCKET_MASK;
164 sfbhash >>= SFB_BUCKET_SHIFT;
165 if (b[hash].qlen > 0)
166 b[hash].qlen--;
167 b += SFB_NUMBUCKETS; /* next level */
171 static void decrement_qlen(const struct sk_buff *skb, struct sfb_sched_data *q)
173 u32 sfbhash;
175 sfbhash = sfb_hash(skb, 0);
176 if (sfbhash)
177 decrement_one_qlen(sfbhash, 0, q);
179 sfbhash = sfb_hash(skb, 1);
180 if (sfbhash)
181 decrement_one_qlen(sfbhash, 1, q);
184 static void decrement_prob(struct sfb_bucket *b, struct sfb_sched_data *q)
186 b->p_mark = prob_minus(b->p_mark, q->decrement);
189 static void increment_prob(struct sfb_bucket *b, struct sfb_sched_data *q)
191 b->p_mark = prob_plus(b->p_mark, q->increment);
194 static void sfb_zero_all_buckets(struct sfb_sched_data *q)
196 memset(&q->bins, 0, sizeof(q->bins));
200 * compute max qlen, max p_mark, and avg p_mark
202 static u32 sfb_compute_qlen(u32 *prob_r, u32 *avgpm_r, const struct sfb_sched_data *q)
204 int i;
205 u32 qlen = 0, prob = 0, totalpm = 0;
206 const struct sfb_bucket *b = &q->bins[q->slot].bins[0][0];
208 for (i = 0; i < SFB_LEVELS * SFB_NUMBUCKETS; i++) {
209 if (qlen < b->qlen)
210 qlen = b->qlen;
211 totalpm += b->p_mark;
212 if (prob < b->p_mark)
213 prob = b->p_mark;
214 b++;
216 *prob_r = prob;
217 *avgpm_r = totalpm / (SFB_LEVELS * SFB_NUMBUCKETS);
218 return qlen;
222 static void sfb_init_perturbation(u32 slot, struct sfb_sched_data *q)
224 get_random_bytes(&q->bins[slot].perturbation,
225 sizeof(q->bins[slot].perturbation));
228 static void sfb_swap_slot(struct sfb_sched_data *q)
230 sfb_init_perturbation(q->slot, q);
231 q->slot ^= 1;
232 q->double_buffering = false;
235 /* Non elastic flows are allowed to use part of the bandwidth, expressed
236 * in "penalty_rate" packets per second, with "penalty_burst" burst
238 static bool sfb_rate_limit(struct sk_buff *skb, struct sfb_sched_data *q)
240 if (q->penalty_rate == 0 || q->penalty_burst == 0)
241 return true;
243 if (q->tokens_avail < 1) {
244 unsigned long age = min(10UL * HZ, jiffies - q->token_time);
246 q->tokens_avail = (age * q->penalty_rate) / HZ;
247 if (q->tokens_avail > q->penalty_burst)
248 q->tokens_avail = q->penalty_burst;
249 q->token_time = jiffies;
250 if (q->tokens_avail < 1)
251 return true;
254 q->tokens_avail--;
255 return false;
258 static bool sfb_classify(struct sk_buff *skb, struct tcf_proto *fl,
259 int *qerr, u32 *salt)
261 struct tcf_result res;
262 int result;
264 result = tcf_classify(skb, fl, &res, false);
265 if (result >= 0) {
266 #ifdef CONFIG_NET_CLS_ACT
267 switch (result) {
268 case TC_ACT_STOLEN:
269 case TC_ACT_QUEUED:
270 case TC_ACT_TRAP:
271 *qerr = NET_XMIT_SUCCESS | __NET_XMIT_STOLEN;
272 /* fall through */
273 case TC_ACT_SHOT:
274 return false;
276 #endif
277 *salt = TC_H_MIN(res.classid);
278 return true;
280 return false;
283 static int sfb_enqueue(struct sk_buff *skb, struct Qdisc *sch,
284 struct sk_buff **to_free)
287 struct sfb_sched_data *q = qdisc_priv(sch);
288 struct Qdisc *child = q->qdisc;
289 struct tcf_proto *fl;
290 int i;
291 u32 p_min = ~0;
292 u32 minqlen = ~0;
293 u32 r, sfbhash;
294 u32 slot = q->slot;
295 int ret = NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
297 if (unlikely(sch->q.qlen >= q->limit)) {
298 qdisc_qstats_overlimit(sch);
299 q->stats.queuedrop++;
300 goto drop;
303 if (q->rehash_interval > 0) {
304 unsigned long limit = q->rehash_time + q->rehash_interval;
306 if (unlikely(time_after(jiffies, limit))) {
307 sfb_swap_slot(q);
308 q->rehash_time = jiffies;
309 } else if (unlikely(!q->double_buffering && q->warmup_time > 0 &&
310 time_after(jiffies, limit - q->warmup_time))) {
311 q->double_buffering = true;
315 fl = rcu_dereference_bh(q->filter_list);
316 if (fl) {
317 u32 salt;
319 /* If using external classifiers, get result and record it. */
320 if (!sfb_classify(skb, fl, &ret, &salt))
321 goto other_drop;
322 sfbhash = siphash_1u32(salt, &q->bins[slot].perturbation);
323 } else {
324 sfbhash = skb_get_hash_perturb(skb, &q->bins[slot].perturbation);
328 if (!sfbhash)
329 sfbhash = 1;
330 sfb_skb_cb(skb)->hashes[slot] = sfbhash;
332 for (i = 0; i < SFB_LEVELS; i++) {
333 u32 hash = sfbhash & SFB_BUCKET_MASK;
334 struct sfb_bucket *b = &q->bins[slot].bins[i][hash];
336 sfbhash >>= SFB_BUCKET_SHIFT;
337 if (b->qlen == 0)
338 decrement_prob(b, q);
339 else if (b->qlen >= q->bin_size)
340 increment_prob(b, q);
341 if (minqlen > b->qlen)
342 minqlen = b->qlen;
343 if (p_min > b->p_mark)
344 p_min = b->p_mark;
347 slot ^= 1;
348 sfb_skb_cb(skb)->hashes[slot] = 0;
350 if (unlikely(minqlen >= q->max)) {
351 qdisc_qstats_overlimit(sch);
352 q->stats.bucketdrop++;
353 goto drop;
356 if (unlikely(p_min >= SFB_MAX_PROB)) {
357 /* Inelastic flow */
358 if (q->double_buffering) {
359 sfbhash = skb_get_hash_perturb(skb,
360 &q->bins[slot].perturbation);
361 if (!sfbhash)
362 sfbhash = 1;
363 sfb_skb_cb(skb)->hashes[slot] = sfbhash;
365 for (i = 0; i < SFB_LEVELS; i++) {
366 u32 hash = sfbhash & SFB_BUCKET_MASK;
367 struct sfb_bucket *b = &q->bins[slot].bins[i][hash];
369 sfbhash >>= SFB_BUCKET_SHIFT;
370 if (b->qlen == 0)
371 decrement_prob(b, q);
372 else if (b->qlen >= q->bin_size)
373 increment_prob(b, q);
376 if (sfb_rate_limit(skb, q)) {
377 qdisc_qstats_overlimit(sch);
378 q->stats.penaltydrop++;
379 goto drop;
381 goto enqueue;
384 r = prandom_u32() & SFB_MAX_PROB;
386 if (unlikely(r < p_min)) {
387 if (unlikely(p_min > SFB_MAX_PROB / 2)) {
388 /* If we're marking that many packets, then either
389 * this flow is unresponsive, or we're badly congested.
390 * In either case, we want to start dropping packets.
392 if (r < (p_min - SFB_MAX_PROB / 2) * 2) {
393 q->stats.earlydrop++;
394 goto drop;
397 if (INET_ECN_set_ce(skb)) {
398 q->stats.marked++;
399 } else {
400 q->stats.earlydrop++;
401 goto drop;
405 enqueue:
406 ret = qdisc_enqueue(skb, child, to_free);
407 if (likely(ret == NET_XMIT_SUCCESS)) {
408 qdisc_qstats_backlog_inc(sch, skb);
409 sch->q.qlen++;
410 increment_qlen(skb, q);
411 } else if (net_xmit_drop_count(ret)) {
412 q->stats.childdrop++;
413 qdisc_qstats_drop(sch);
415 return ret;
417 drop:
418 qdisc_drop(skb, sch, to_free);
419 return NET_XMIT_CN;
420 other_drop:
421 if (ret & __NET_XMIT_BYPASS)
422 qdisc_qstats_drop(sch);
423 kfree_skb(skb);
424 return ret;
427 static struct sk_buff *sfb_dequeue(struct Qdisc *sch)
429 struct sfb_sched_data *q = qdisc_priv(sch);
430 struct Qdisc *child = q->qdisc;
431 struct sk_buff *skb;
433 skb = child->dequeue(q->qdisc);
435 if (skb) {
436 qdisc_bstats_update(sch, skb);
437 qdisc_qstats_backlog_dec(sch, skb);
438 sch->q.qlen--;
439 decrement_qlen(skb, q);
442 return skb;
445 static struct sk_buff *sfb_peek(struct Qdisc *sch)
447 struct sfb_sched_data *q = qdisc_priv(sch);
448 struct Qdisc *child = q->qdisc;
450 return child->ops->peek(child);
453 /* No sfb_drop -- impossible since the child doesn't return the dropped skb. */
455 static void sfb_reset(struct Qdisc *sch)
457 struct sfb_sched_data *q = qdisc_priv(sch);
459 qdisc_reset(q->qdisc);
460 sch->qstats.backlog = 0;
461 sch->q.qlen = 0;
462 q->slot = 0;
463 q->double_buffering = false;
464 sfb_zero_all_buckets(q);
465 sfb_init_perturbation(0, q);
468 static void sfb_destroy(struct Qdisc *sch)
470 struct sfb_sched_data *q = qdisc_priv(sch);
472 tcf_block_put(q->block);
473 qdisc_destroy(q->qdisc);
476 static const struct nla_policy sfb_policy[TCA_SFB_MAX + 1] = {
477 [TCA_SFB_PARMS] = { .len = sizeof(struct tc_sfb_qopt) },
480 static const struct tc_sfb_qopt sfb_default_ops = {
481 .rehash_interval = 600 * MSEC_PER_SEC,
482 .warmup_time = 60 * MSEC_PER_SEC,
483 .limit = 0,
484 .max = 25,
485 .bin_size = 20,
486 .increment = (SFB_MAX_PROB + 500) / 1000, /* 0.1 % */
487 .decrement = (SFB_MAX_PROB + 3000) / 6000,
488 .penalty_rate = 10,
489 .penalty_burst = 20,
492 static int sfb_change(struct Qdisc *sch, struct nlattr *opt,
493 struct netlink_ext_ack *extack)
495 struct sfb_sched_data *q = qdisc_priv(sch);
496 struct Qdisc *child;
497 struct nlattr *tb[TCA_SFB_MAX + 1];
498 const struct tc_sfb_qopt *ctl = &sfb_default_ops;
499 u32 limit;
500 int err;
502 if (opt) {
503 err = nla_parse_nested(tb, TCA_SFB_MAX, opt, sfb_policy, NULL);
504 if (err < 0)
505 return -EINVAL;
507 if (tb[TCA_SFB_PARMS] == NULL)
508 return -EINVAL;
510 ctl = nla_data(tb[TCA_SFB_PARMS]);
513 limit = ctl->limit;
514 if (limit == 0)
515 limit = qdisc_dev(sch)->tx_queue_len;
517 child = fifo_create_dflt(sch, &pfifo_qdisc_ops, limit, extack);
518 if (IS_ERR(child))
519 return PTR_ERR(child);
521 if (child != &noop_qdisc)
522 qdisc_hash_add(child, true);
523 sch_tree_lock(sch);
525 qdisc_tree_reduce_backlog(q->qdisc, q->qdisc->q.qlen,
526 q->qdisc->qstats.backlog);
527 qdisc_destroy(q->qdisc);
528 q->qdisc = child;
530 q->rehash_interval = msecs_to_jiffies(ctl->rehash_interval);
531 q->warmup_time = msecs_to_jiffies(ctl->warmup_time);
532 q->rehash_time = jiffies;
533 q->limit = limit;
534 q->increment = ctl->increment;
535 q->decrement = ctl->decrement;
536 q->max = ctl->max;
537 q->bin_size = ctl->bin_size;
538 q->penalty_rate = ctl->penalty_rate;
539 q->penalty_burst = ctl->penalty_burst;
540 q->tokens_avail = ctl->penalty_burst;
541 q->token_time = jiffies;
543 q->slot = 0;
544 q->double_buffering = false;
545 sfb_zero_all_buckets(q);
546 sfb_init_perturbation(0, q);
547 sfb_init_perturbation(1, q);
549 sch_tree_unlock(sch);
551 return 0;
554 static int sfb_init(struct Qdisc *sch, struct nlattr *opt,
555 struct netlink_ext_ack *extack)
557 struct sfb_sched_data *q = qdisc_priv(sch);
558 int err;
560 err = tcf_block_get(&q->block, &q->filter_list, sch, extack);
561 if (err)
562 return err;
564 q->qdisc = &noop_qdisc;
565 return sfb_change(sch, opt, extack);
568 static int sfb_dump(struct Qdisc *sch, struct sk_buff *skb)
570 struct sfb_sched_data *q = qdisc_priv(sch);
571 struct nlattr *opts;
572 struct tc_sfb_qopt opt = {
573 .rehash_interval = jiffies_to_msecs(q->rehash_interval),
574 .warmup_time = jiffies_to_msecs(q->warmup_time),
575 .limit = q->limit,
576 .max = q->max,
577 .bin_size = q->bin_size,
578 .increment = q->increment,
579 .decrement = q->decrement,
580 .penalty_rate = q->penalty_rate,
581 .penalty_burst = q->penalty_burst,
584 sch->qstats.backlog = q->qdisc->qstats.backlog;
585 opts = nla_nest_start(skb, TCA_OPTIONS);
586 if (opts == NULL)
587 goto nla_put_failure;
588 if (nla_put(skb, TCA_SFB_PARMS, sizeof(opt), &opt))
589 goto nla_put_failure;
590 return nla_nest_end(skb, opts);
592 nla_put_failure:
593 nla_nest_cancel(skb, opts);
594 return -EMSGSIZE;
597 static int sfb_dump_stats(struct Qdisc *sch, struct gnet_dump *d)
599 struct sfb_sched_data *q = qdisc_priv(sch);
600 struct tc_sfb_xstats st = {
601 .earlydrop = q->stats.earlydrop,
602 .penaltydrop = q->stats.penaltydrop,
603 .bucketdrop = q->stats.bucketdrop,
604 .queuedrop = q->stats.queuedrop,
605 .childdrop = q->stats.childdrop,
606 .marked = q->stats.marked,
609 st.maxqlen = sfb_compute_qlen(&st.maxprob, &st.avgprob, q);
611 return gnet_stats_copy_app(d, &st, sizeof(st));
614 static int sfb_dump_class(struct Qdisc *sch, unsigned long cl,
615 struct sk_buff *skb, struct tcmsg *tcm)
617 return -ENOSYS;
620 static int sfb_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
621 struct Qdisc **old, struct netlink_ext_ack *extack)
623 struct sfb_sched_data *q = qdisc_priv(sch);
625 if (new == NULL)
626 new = &noop_qdisc;
628 *old = qdisc_replace(sch, new, &q->qdisc);
629 return 0;
632 static struct Qdisc *sfb_leaf(struct Qdisc *sch, unsigned long arg)
634 struct sfb_sched_data *q = qdisc_priv(sch);
636 return q->qdisc;
639 static unsigned long sfb_find(struct Qdisc *sch, u32 classid)
641 return 1;
644 static void sfb_unbind(struct Qdisc *sch, unsigned long arg)
648 static int sfb_change_class(struct Qdisc *sch, u32 classid, u32 parentid,
649 struct nlattr **tca, unsigned long *arg,
650 struct netlink_ext_ack *extack)
652 return -ENOSYS;
655 static int sfb_delete(struct Qdisc *sch, unsigned long cl)
657 return -ENOSYS;
660 static void sfb_walk(struct Qdisc *sch, struct qdisc_walker *walker)
662 if (!walker->stop) {
663 if (walker->count >= walker->skip)
664 if (walker->fn(sch, 1, walker) < 0) {
665 walker->stop = 1;
666 return;
668 walker->count++;
672 static struct tcf_block *sfb_tcf_block(struct Qdisc *sch, unsigned long cl,
673 struct netlink_ext_ack *extack)
675 struct sfb_sched_data *q = qdisc_priv(sch);
677 if (cl)
678 return NULL;
679 return q->block;
682 static unsigned long sfb_bind(struct Qdisc *sch, unsigned long parent,
683 u32 classid)
685 return 0;
689 static const struct Qdisc_class_ops sfb_class_ops = {
690 .graft = sfb_graft,
691 .leaf = sfb_leaf,
692 .find = sfb_find,
693 .change = sfb_change_class,
694 .delete = sfb_delete,
695 .walk = sfb_walk,
696 .tcf_block = sfb_tcf_block,
697 .bind_tcf = sfb_bind,
698 .unbind_tcf = sfb_unbind,
699 .dump = sfb_dump_class,
702 static struct Qdisc_ops sfb_qdisc_ops __read_mostly = {
703 .id = "sfb",
704 .priv_size = sizeof(struct sfb_sched_data),
705 .cl_ops = &sfb_class_ops,
706 .enqueue = sfb_enqueue,
707 .dequeue = sfb_dequeue,
708 .peek = sfb_peek,
709 .init = sfb_init,
710 .reset = sfb_reset,
711 .destroy = sfb_destroy,
712 .change = sfb_change,
713 .dump = sfb_dump,
714 .dump_stats = sfb_dump_stats,
715 .owner = THIS_MODULE,
718 static int __init sfb_module_init(void)
720 return register_qdisc(&sfb_qdisc_ops);
723 static void __exit sfb_module_exit(void)
725 unregister_qdisc(&sfb_qdisc_ops);
728 module_init(sfb_module_init)
729 module_exit(sfb_module_exit)
731 MODULE_DESCRIPTION("Stochastic Fair Blue queue discipline");
732 MODULE_AUTHOR("Juliusz Chroboczek");
733 MODULE_AUTHOR("Eric Dumazet");
734 MODULE_LICENSE("GPL");