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/jhash.h>
27 #include <net/pkt_sched.h>
28 #include <net/inet_ecn.h>
31 * SFB uses two B[l][n] : L x N arrays of bins (L levels, N bins per level)
32 * This implementation uses L = 8 and N = 16
33 * This permits us to split one 32bit hash (provided per packet by rxhash or
34 * external classifier) into 8 subhashes of 4 bits.
36 #define SFB_BUCKET_SHIFT 4
37 #define SFB_NUMBUCKETS (1 << SFB_BUCKET_SHIFT) /* N bins per Level */
38 #define SFB_BUCKET_MASK (SFB_NUMBUCKETS - 1)
39 #define SFB_LEVELS (32 / SFB_BUCKET_SHIFT) /* L */
41 /* SFB algo uses a virtual queue, named "bin" */
43 u16 qlen; /* length of virtual queue */
44 u16 p_mark; /* marking probability */
47 /* We use a double buffering right before hash change
48 * (Section 4.4 of SFB reference : moving hash functions)
51 u32 perturbation; /* jhash perturbation */
52 struct sfb_bucket bins[SFB_LEVELS][SFB_NUMBUCKETS];
55 struct sfb_sched_data {
57 struct tcf_proto *filter_list;
58 unsigned long rehash_interval;
59 unsigned long warmup_time; /* double buffering warmup time in jiffies */
61 u32 bin_size; /* maximum queue length per bin */
62 u32 increment; /* d1 */
63 u32 decrement; /* d2 */
64 u32 limit; /* HARD maximal queue length */
68 unsigned long rehash_time;
69 unsigned long token_time;
71 u8 slot; /* current active bins (0 or 1) */
72 bool double_buffering;
73 struct sfb_bins bins[2];
80 u32 childdrop; /* drops in child qdisc */
81 u32 marked; /* ECN mark */
86 * Each queued skb might be hashed on one or two bins
87 * We store in skb_cb the two hash values.
88 * (A zero value means double buffering was not used)
94 static inline struct sfb_skb_cb *sfb_skb_cb(const struct sk_buff *skb)
96 BUILD_BUG_ON(sizeof(skb->cb) <
97 sizeof(struct qdisc_skb_cb) + sizeof(struct sfb_skb_cb));
98 return (struct sfb_skb_cb *)qdisc_skb_cb(skb)->data;
102 * If using 'internal' SFB flow classifier, hash comes from skb rxhash
103 * If using external classifier, hash comes from the classid.
105 static u32 sfb_hash(const struct sk_buff *skb, u32 slot)
107 return sfb_skb_cb(skb)->hashes[slot];
110 /* Probabilities are coded as Q0.16 fixed-point values,
111 * with 0xFFFF representing 65535/65536 (almost 1.0)
112 * Addition and subtraction are saturating in [0, 65535]
114 static u32 prob_plus(u32 p1, u32 p2)
118 return min_t(u32, res, SFB_MAX_PROB);
121 static u32 prob_minus(u32 p1, u32 p2)
123 return p1 > p2 ? p1 - p2 : 0;
126 static void increment_one_qlen(u32 sfbhash, u32 slot, struct sfb_sched_data *q)
129 struct sfb_bucket *b = &q->bins[slot].bins[0][0];
131 for (i = 0; i < SFB_LEVELS; i++) {
132 u32 hash = sfbhash & SFB_BUCKET_MASK;
134 sfbhash >>= SFB_BUCKET_SHIFT;
135 if (b[hash].qlen < 0xFFFF)
137 b += SFB_NUMBUCKETS; /* next level */
141 static void increment_qlen(const struct sk_buff *skb, struct sfb_sched_data *q)
145 sfbhash = sfb_hash(skb, 0);
147 increment_one_qlen(sfbhash, 0, q);
149 sfbhash = sfb_hash(skb, 1);
151 increment_one_qlen(sfbhash, 1, q);
154 static void decrement_one_qlen(u32 sfbhash, u32 slot,
155 struct sfb_sched_data *q)
158 struct sfb_bucket *b = &q->bins[slot].bins[0][0];
160 for (i = 0; i < SFB_LEVELS; i++) {
161 u32 hash = sfbhash & SFB_BUCKET_MASK;
163 sfbhash >>= SFB_BUCKET_SHIFT;
164 if (b[hash].qlen > 0)
166 b += SFB_NUMBUCKETS; /* next level */
170 static void decrement_qlen(const struct sk_buff *skb, struct sfb_sched_data *q)
174 sfbhash = sfb_hash(skb, 0);
176 decrement_one_qlen(sfbhash, 0, q);
178 sfbhash = sfb_hash(skb, 1);
180 decrement_one_qlen(sfbhash, 1, q);
183 static void decrement_prob(struct sfb_bucket *b, struct sfb_sched_data *q)
185 b->p_mark = prob_minus(b->p_mark, q->decrement);
188 static void increment_prob(struct sfb_bucket *b, struct sfb_sched_data *q)
190 b->p_mark = prob_plus(b->p_mark, q->increment);
193 static void sfb_zero_all_buckets(struct sfb_sched_data *q)
195 memset(&q->bins, 0, sizeof(q->bins));
199 * compute max qlen, max p_mark, and avg p_mark
201 static u32 sfb_compute_qlen(u32 *prob_r, u32 *avgpm_r, const struct sfb_sched_data *q)
204 u32 qlen = 0, prob = 0, totalpm = 0;
205 const struct sfb_bucket *b = &q->bins[q->slot].bins[0][0];
207 for (i = 0; i < SFB_LEVELS * SFB_NUMBUCKETS; i++) {
210 totalpm += b->p_mark;
211 if (prob < b->p_mark)
216 *avgpm_r = totalpm / (SFB_LEVELS * SFB_NUMBUCKETS);
221 static void sfb_init_perturbation(u32 slot, struct sfb_sched_data *q)
223 q->bins[slot].perturbation = net_random();
226 static void sfb_swap_slot(struct sfb_sched_data *q)
228 sfb_init_perturbation(q->slot, q);
230 q->double_buffering = false;
233 /* Non elastic flows are allowed to use part of the bandwidth, expressed
234 * in "penalty_rate" packets per second, with "penalty_burst" burst
236 static bool sfb_rate_limit(struct sk_buff *skb, struct sfb_sched_data *q)
238 if (q->penalty_rate == 0 || q->penalty_burst == 0)
241 if (q->tokens_avail < 1) {
242 unsigned long age = min(10UL * HZ, jiffies - q->token_time);
244 q->tokens_avail = (age * q->penalty_rate) / HZ;
245 if (q->tokens_avail > q->penalty_burst)
246 q->tokens_avail = q->penalty_burst;
247 q->token_time = jiffies;
248 if (q->tokens_avail < 1)
256 static bool sfb_classify(struct sk_buff *skb, struct sfb_sched_data *q,
257 int *qerr, u32 *salt)
259 struct tcf_result res;
262 result = tc_classify(skb, q->filter_list, &res);
264 #ifdef CONFIG_NET_CLS_ACT
268 *qerr = NET_XMIT_SUCCESS | __NET_XMIT_STOLEN;
273 *salt = TC_H_MIN(res.classid);
279 static int sfb_enqueue(struct sk_buff *skb, struct Qdisc *sch)
282 struct sfb_sched_data *q = qdisc_priv(sch);
283 struct Qdisc *child = q->qdisc;
287 u32 r, slot, salt, sfbhash;
288 int ret = NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
290 if (q->rehash_interval > 0) {
291 unsigned long limit = q->rehash_time + q->rehash_interval;
293 if (unlikely(time_after(jiffies, limit))) {
295 q->rehash_time = jiffies;
296 } else if (unlikely(!q->double_buffering && q->warmup_time > 0 &&
297 time_after(jiffies, limit - q->warmup_time))) {
298 q->double_buffering = true;
302 if (q->filter_list) {
303 /* If using external classifiers, get result and record it. */
304 if (!sfb_classify(skb, q, &ret, &salt))
307 salt = skb_get_rxhash(skb);
312 sfbhash = jhash_1word(salt, q->bins[slot].perturbation);
315 sfb_skb_cb(skb)->hashes[slot] = sfbhash;
317 for (i = 0; i < SFB_LEVELS; i++) {
318 u32 hash = sfbhash & SFB_BUCKET_MASK;
319 struct sfb_bucket *b = &q->bins[slot].bins[i][hash];
321 sfbhash >>= SFB_BUCKET_SHIFT;
323 decrement_prob(b, q);
324 else if (b->qlen >= q->bin_size)
325 increment_prob(b, q);
326 if (minqlen > b->qlen)
328 if (p_min > b->p_mark)
333 sfb_skb_cb(skb)->hashes[slot] = 0;
335 if (unlikely(minqlen >= q->max || sch->q.qlen >= q->limit)) {
336 sch->qstats.overlimits++;
337 if (minqlen >= q->max)
338 q->stats.bucketdrop++;
340 q->stats.queuedrop++;
344 if (unlikely(p_min >= SFB_MAX_PROB)) {
346 if (q->double_buffering) {
347 sfbhash = jhash_1word(salt, q->bins[slot].perturbation);
350 sfb_skb_cb(skb)->hashes[slot] = sfbhash;
352 for (i = 0; i < SFB_LEVELS; i++) {
353 u32 hash = sfbhash & SFB_BUCKET_MASK;
354 struct sfb_bucket *b = &q->bins[slot].bins[i][hash];
356 sfbhash >>= SFB_BUCKET_SHIFT;
358 decrement_prob(b, q);
359 else if (b->qlen >= q->bin_size)
360 increment_prob(b, q);
363 if (sfb_rate_limit(skb, q)) {
364 sch->qstats.overlimits++;
365 q->stats.penaltydrop++;
371 r = net_random() & SFB_MAX_PROB;
373 if (unlikely(r < p_min)) {
374 if (unlikely(p_min > SFB_MAX_PROB / 2)) {
375 /* If we're marking that many packets, then either
376 * this flow is unresponsive, or we're badly congested.
377 * In either case, we want to start dropping packets.
379 if (r < (p_min - SFB_MAX_PROB / 2) * 2) {
380 q->stats.earlydrop++;
384 if (INET_ECN_set_ce(skb)) {
387 q->stats.earlydrop++;
393 ret = qdisc_enqueue(skb, child);
394 if (likely(ret == NET_XMIT_SUCCESS)) {
396 increment_qlen(skb, q);
397 } else if (net_xmit_drop_count(ret)) {
398 q->stats.childdrop++;
404 qdisc_drop(skb, sch);
407 if (ret & __NET_XMIT_BYPASS)
413 static struct sk_buff *sfb_dequeue(struct Qdisc *sch)
415 struct sfb_sched_data *q = qdisc_priv(sch);
416 struct Qdisc *child = q->qdisc;
419 skb = child->dequeue(q->qdisc);
422 qdisc_bstats_update(sch, skb);
424 decrement_qlen(skb, q);
430 static struct sk_buff *sfb_peek(struct Qdisc *sch)
432 struct sfb_sched_data *q = qdisc_priv(sch);
433 struct Qdisc *child = q->qdisc;
435 return child->ops->peek(child);
438 /* No sfb_drop -- impossible since the child doesn't return the dropped skb. */
440 static void sfb_reset(struct Qdisc *sch)
442 struct sfb_sched_data *q = qdisc_priv(sch);
444 qdisc_reset(q->qdisc);
447 q->double_buffering = false;
448 sfb_zero_all_buckets(q);
449 sfb_init_perturbation(0, q);
452 static void sfb_destroy(struct Qdisc *sch)
454 struct sfb_sched_data *q = qdisc_priv(sch);
456 tcf_destroy_chain(&q->filter_list);
457 qdisc_destroy(q->qdisc);
460 static const struct nla_policy sfb_policy[TCA_SFB_MAX + 1] = {
461 [TCA_SFB_PARMS] = { .len = sizeof(struct tc_sfb_qopt) },
464 static const struct tc_sfb_qopt sfb_default_ops = {
465 .rehash_interval = 600 * MSEC_PER_SEC,
466 .warmup_time = 60 * MSEC_PER_SEC,
470 .increment = (SFB_MAX_PROB + 500) / 1000, /* 0.1 % */
471 .decrement = (SFB_MAX_PROB + 3000) / 6000,
476 static int sfb_change(struct Qdisc *sch, struct nlattr *opt)
478 struct sfb_sched_data *q = qdisc_priv(sch);
480 struct nlattr *tb[TCA_SFB_MAX + 1];
481 const struct tc_sfb_qopt *ctl = &sfb_default_ops;
486 err = nla_parse_nested(tb, TCA_SFB_MAX, opt, sfb_policy);
490 if (tb[TCA_SFB_PARMS] == NULL)
493 ctl = nla_data(tb[TCA_SFB_PARMS]);
498 limit = max_t(u32, qdisc_dev(sch)->tx_queue_len, 1);
500 child = fifo_create_dflt(sch, &pfifo_qdisc_ops, limit);
502 return PTR_ERR(child);
506 qdisc_tree_decrease_qlen(q->qdisc, q->qdisc->q.qlen);
507 qdisc_destroy(q->qdisc);
510 q->rehash_interval = msecs_to_jiffies(ctl->rehash_interval);
511 q->warmup_time = msecs_to_jiffies(ctl->warmup_time);
512 q->rehash_time = jiffies;
514 q->increment = ctl->increment;
515 q->decrement = ctl->decrement;
517 q->bin_size = ctl->bin_size;
518 q->penalty_rate = ctl->penalty_rate;
519 q->penalty_burst = ctl->penalty_burst;
520 q->tokens_avail = ctl->penalty_burst;
521 q->token_time = jiffies;
524 q->double_buffering = false;
525 sfb_zero_all_buckets(q);
526 sfb_init_perturbation(0, q);
527 sfb_init_perturbation(1, q);
529 sch_tree_unlock(sch);
534 static int sfb_init(struct Qdisc *sch, struct nlattr *opt)
536 struct sfb_sched_data *q = qdisc_priv(sch);
538 q->qdisc = &noop_qdisc;
539 return sfb_change(sch, opt);
542 static int sfb_dump(struct Qdisc *sch, struct sk_buff *skb)
544 struct sfb_sched_data *q = qdisc_priv(sch);
546 struct tc_sfb_qopt opt = {
547 .rehash_interval = jiffies_to_msecs(q->rehash_interval),
548 .warmup_time = jiffies_to_msecs(q->warmup_time),
551 .bin_size = q->bin_size,
552 .increment = q->increment,
553 .decrement = q->decrement,
554 .penalty_rate = q->penalty_rate,
555 .penalty_burst = q->penalty_burst,
558 sch->qstats.backlog = q->qdisc->qstats.backlog;
559 opts = nla_nest_start(skb, TCA_OPTIONS);
560 NLA_PUT(skb, TCA_SFB_PARMS, sizeof(opt), &opt);
561 return nla_nest_end(skb, opts);
564 nla_nest_cancel(skb, opts);
568 static int sfb_dump_stats(struct Qdisc *sch, struct gnet_dump *d)
570 struct sfb_sched_data *q = qdisc_priv(sch);
571 struct tc_sfb_xstats st = {
572 .earlydrop = q->stats.earlydrop,
573 .penaltydrop = q->stats.penaltydrop,
574 .bucketdrop = q->stats.bucketdrop,
575 .queuedrop = q->stats.queuedrop,
576 .childdrop = q->stats.childdrop,
577 .marked = q->stats.marked,
580 st.maxqlen = sfb_compute_qlen(&st.maxprob, &st.avgprob, q);
582 return gnet_stats_copy_app(d, &st, sizeof(st));
585 static int sfb_dump_class(struct Qdisc *sch, unsigned long cl,
586 struct sk_buff *skb, struct tcmsg *tcm)
591 static int sfb_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
594 struct sfb_sched_data *q = qdisc_priv(sch);
602 qdisc_tree_decrease_qlen(*old, (*old)->q.qlen);
604 sch_tree_unlock(sch);
608 static struct Qdisc *sfb_leaf(struct Qdisc *sch, unsigned long arg)
610 struct sfb_sched_data *q = qdisc_priv(sch);
615 static unsigned long sfb_get(struct Qdisc *sch, u32 classid)
620 static void sfb_put(struct Qdisc *sch, unsigned long arg)
624 static int sfb_change_class(struct Qdisc *sch, u32 classid, u32 parentid,
625 struct nlattr **tca, unsigned long *arg)
630 static int sfb_delete(struct Qdisc *sch, unsigned long cl)
635 static void sfb_walk(struct Qdisc *sch, struct qdisc_walker *walker)
638 if (walker->count >= walker->skip)
639 if (walker->fn(sch, 1, walker) < 0) {
647 static struct tcf_proto **sfb_find_tcf(struct Qdisc *sch, unsigned long cl)
649 struct sfb_sched_data *q = qdisc_priv(sch);
653 return &q->filter_list;
656 static unsigned long sfb_bind(struct Qdisc *sch, unsigned long parent,
663 static const struct Qdisc_class_ops sfb_class_ops = {
668 .change = sfb_change_class,
669 .delete = sfb_delete,
671 .tcf_chain = sfb_find_tcf,
672 .bind_tcf = sfb_bind,
673 .unbind_tcf = sfb_put,
674 .dump = sfb_dump_class,
677 static struct Qdisc_ops sfb_qdisc_ops __read_mostly = {
679 .priv_size = sizeof(struct sfb_sched_data),
680 .cl_ops = &sfb_class_ops,
681 .enqueue = sfb_enqueue,
682 .dequeue = sfb_dequeue,
686 .destroy = sfb_destroy,
687 .change = sfb_change,
689 .dump_stats = sfb_dump_stats,
690 .owner = THIS_MODULE,
693 static int __init sfb_module_init(void)
695 return register_qdisc(&sfb_qdisc_ops);
698 static void __exit sfb_module_exit(void)
700 unregister_qdisc(&sfb_qdisc_ops);
703 module_init(sfb_module_init)
704 module_exit(sfb_module_exit)
706 MODULE_DESCRIPTION("Stochastic Fair Blue queue discipline");
707 MODULE_AUTHOR("Juliusz Chroboczek");
708 MODULE_AUTHOR("Eric Dumazet");
709 MODULE_LICENSE("GPL");