2 * Fair Queue CoDel discipline
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Copyright (C) 2012,2015 Eric Dumazet <edumazet@google.com>
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/kernel.h>
15 #include <linux/jiffies.h>
16 #include <linux/string.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/skbuff.h>
21 #include <linux/jhash.h>
22 #include <linux/slab.h>
23 #include <linux/vmalloc.h>
24 #include <net/netlink.h>
25 #include <net/pkt_sched.h>
26 #include <net/pkt_cls.h>
27 #include <net/codel.h>
28 #include <net/codel_impl.h>
29 #include <net/codel_qdisc.h>
34 * Packets are classified (internal classifier or external) on flows.
35 * This is a Stochastic model (as we use a hash, several flows
36 * might be hashed on same slot)
37 * Each flow has a CoDel managed queue.
38 * Flows are linked onto two (Round Robin) lists,
39 * so that new flows have priority on old ones.
41 * For a given flow, packets are not reordered (CoDel uses a FIFO)
43 * ECN capability is on by default.
44 * Low memory footprint (64 bytes per flow)
47 struct fq_codel_flow {
50 struct list_head flowchain;
52 u32 dropped; /* number of drops (or ECN marks) on this flow */
53 struct codel_vars cvars;
54 }; /* please try to keep this structure <= 64 bytes */
56 struct fq_codel_sched_data {
57 struct tcf_proto __rcu *filter_list; /* optional external classifier */
58 struct tcf_block *block;
59 struct fq_codel_flow *flows; /* Flows table [flows_cnt] */
60 u32 *backlogs; /* backlog table [flows_cnt] */
61 u32 flows_cnt; /* number of flows */
62 u32 quantum; /* psched_mtu(qdisc_dev(sch)); */
65 struct codel_params cparams;
66 struct codel_stats cstats;
72 struct list_head new_flows; /* list of new flows */
73 struct list_head old_flows; /* list of old flows */
76 static unsigned int fq_codel_hash(const struct fq_codel_sched_data *q,
79 return reciprocal_scale(skb_get_hash(skb), q->flows_cnt);
82 static unsigned int fq_codel_classify(struct sk_buff *skb, struct Qdisc *sch,
85 struct fq_codel_sched_data *q = qdisc_priv(sch);
86 struct tcf_proto *filter;
87 struct tcf_result res;
90 if (TC_H_MAJ(skb->priority) == sch->handle &&
91 TC_H_MIN(skb->priority) > 0 &&
92 TC_H_MIN(skb->priority) <= q->flows_cnt)
93 return TC_H_MIN(skb->priority);
95 filter = rcu_dereference_bh(q->filter_list);
97 return fq_codel_hash(q, skb) + 1;
99 *qerr = NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
100 result = tcf_classify(skb, filter, &res, false);
102 #ifdef CONFIG_NET_CLS_ACT
107 *qerr = NET_XMIT_SUCCESS | __NET_XMIT_STOLEN;
113 if (TC_H_MIN(res.classid) <= q->flows_cnt)
114 return TC_H_MIN(res.classid);
119 /* helper functions : might be changed when/if skb use a standard list_head */
121 /* remove one skb from head of slot queue */
122 static inline struct sk_buff *dequeue_head(struct fq_codel_flow *flow)
124 struct sk_buff *skb = flow->head;
126 flow->head = skb->next;
131 /* add skb to flow queue (tail add) */
132 static inline void flow_queue_add(struct fq_codel_flow *flow,
135 if (flow->head == NULL)
138 flow->tail->next = skb;
143 static unsigned int fq_codel_drop(struct Qdisc *sch, unsigned int max_packets,
144 struct sk_buff **to_free)
146 struct fq_codel_sched_data *q = qdisc_priv(sch);
148 unsigned int maxbacklog = 0, idx = 0, i, len;
149 struct fq_codel_flow *flow;
150 unsigned int threshold;
151 unsigned int mem = 0;
153 /* Queue is full! Find the fat flow and drop packet(s) from it.
154 * This might sound expensive, but with 1024 flows, we scan
155 * 4KB of memory, and we dont need to handle a complex tree
156 * in fast path (packet queue/enqueue) with many cache misses.
157 * In stress mode, we'll try to drop 64 packets from the flow,
158 * amortizing this linear lookup to one cache line per drop.
160 for (i = 0; i < q->flows_cnt; i++) {
161 if (q->backlogs[i] > maxbacklog) {
162 maxbacklog = q->backlogs[i];
167 /* Our goal is to drop half of this fat flow backlog */
168 threshold = maxbacklog >> 1;
170 flow = &q->flows[idx];
174 skb = dequeue_head(flow);
175 len += qdisc_pkt_len(skb);
176 mem += get_codel_cb(skb)->mem_usage;
177 __qdisc_drop(skb, to_free);
178 } while (++i < max_packets && len < threshold);
181 q->backlogs[idx] -= len;
182 q->memory_usage -= mem;
183 sch->qstats.drops += i;
184 sch->qstats.backlog -= len;
189 static int fq_codel_enqueue(struct sk_buff *skb, struct Qdisc *sch,
190 struct sk_buff **to_free)
192 struct fq_codel_sched_data *q = qdisc_priv(sch);
193 unsigned int idx, prev_backlog, prev_qlen;
194 struct fq_codel_flow *flow;
195 int uninitialized_var(ret);
196 unsigned int pkt_len;
199 idx = fq_codel_classify(skb, sch, &ret);
201 if (ret & __NET_XMIT_BYPASS)
202 qdisc_qstats_drop(sch);
203 __qdisc_drop(skb, to_free);
208 codel_set_enqueue_time(skb);
209 flow = &q->flows[idx];
210 flow_queue_add(flow, skb);
211 q->backlogs[idx] += qdisc_pkt_len(skb);
212 qdisc_qstats_backlog_inc(sch, skb);
214 if (list_empty(&flow->flowchain)) {
215 list_add_tail(&flow->flowchain, &q->new_flows);
217 flow->deficit = q->quantum;
220 get_codel_cb(skb)->mem_usage = skb->truesize;
221 q->memory_usage += get_codel_cb(skb)->mem_usage;
222 memory_limited = q->memory_usage > q->memory_limit;
223 if (++sch->q.qlen <= sch->limit && !memory_limited)
224 return NET_XMIT_SUCCESS;
226 prev_backlog = sch->qstats.backlog;
227 prev_qlen = sch->q.qlen;
229 /* save this packet length as it might be dropped by fq_codel_drop() */
230 pkt_len = qdisc_pkt_len(skb);
231 /* fq_codel_drop() is quite expensive, as it performs a linear search
232 * in q->backlogs[] to find a fat flow.
233 * So instead of dropping a single packet, drop half of its backlog
234 * with a 64 packets limit to not add a too big cpu spike here.
236 ret = fq_codel_drop(sch, q->drop_batch_size, to_free);
238 prev_qlen -= sch->q.qlen;
239 prev_backlog -= sch->qstats.backlog;
240 q->drop_overlimit += prev_qlen;
242 q->drop_overmemory += prev_qlen;
244 /* As we dropped packet(s), better let upper stack know this.
245 * If we dropped a packet for this flow, return NET_XMIT_CN,
246 * but in this case, our parents wont increase their backlogs.
249 qdisc_tree_reduce_backlog(sch, prev_qlen - 1,
250 prev_backlog - pkt_len);
253 qdisc_tree_reduce_backlog(sch, prev_qlen, prev_backlog);
254 return NET_XMIT_SUCCESS;
257 /* This is the specific function called from codel_dequeue()
258 * to dequeue a packet from queue. Note: backlog is handled in
259 * codel, we dont need to reduce it here.
261 static struct sk_buff *dequeue_func(struct codel_vars *vars, void *ctx)
263 struct Qdisc *sch = ctx;
264 struct fq_codel_sched_data *q = qdisc_priv(sch);
265 struct fq_codel_flow *flow;
266 struct sk_buff *skb = NULL;
268 flow = container_of(vars, struct fq_codel_flow, cvars);
270 skb = dequeue_head(flow);
271 q->backlogs[flow - q->flows] -= qdisc_pkt_len(skb);
272 q->memory_usage -= get_codel_cb(skb)->mem_usage;
274 sch->qstats.backlog -= qdisc_pkt_len(skb);
279 static void drop_func(struct sk_buff *skb, void *ctx)
281 struct Qdisc *sch = ctx;
284 qdisc_qstats_drop(sch);
287 static struct sk_buff *fq_codel_dequeue(struct Qdisc *sch)
289 struct fq_codel_sched_data *q = qdisc_priv(sch);
291 struct fq_codel_flow *flow;
292 struct list_head *head;
293 u32 prev_drop_count, prev_ecn_mark;
296 head = &q->new_flows;
297 if (list_empty(head)) {
298 head = &q->old_flows;
299 if (list_empty(head))
302 flow = list_first_entry(head, struct fq_codel_flow, flowchain);
304 if (flow->deficit <= 0) {
305 flow->deficit += q->quantum;
306 list_move_tail(&flow->flowchain, &q->old_flows);
310 prev_drop_count = q->cstats.drop_count;
311 prev_ecn_mark = q->cstats.ecn_mark;
313 skb = codel_dequeue(sch, &sch->qstats.backlog, &q->cparams,
314 &flow->cvars, &q->cstats, qdisc_pkt_len,
315 codel_get_enqueue_time, drop_func, dequeue_func);
317 flow->dropped += q->cstats.drop_count - prev_drop_count;
318 flow->dropped += q->cstats.ecn_mark - prev_ecn_mark;
321 /* force a pass through old_flows to prevent starvation */
322 if ((head == &q->new_flows) && !list_empty(&q->old_flows))
323 list_move_tail(&flow->flowchain, &q->old_flows);
325 list_del_init(&flow->flowchain);
328 qdisc_bstats_update(sch, skb);
329 flow->deficit -= qdisc_pkt_len(skb);
330 /* We cant call qdisc_tree_reduce_backlog() if our qlen is 0,
331 * or HTB crashes. Defer it for next round.
333 if (q->cstats.drop_count && sch->q.qlen) {
334 qdisc_tree_reduce_backlog(sch, q->cstats.drop_count,
336 q->cstats.drop_count = 0;
337 q->cstats.drop_len = 0;
342 static void fq_codel_flow_purge(struct fq_codel_flow *flow)
344 rtnl_kfree_skbs(flow->head, flow->tail);
348 static void fq_codel_reset(struct Qdisc *sch)
350 struct fq_codel_sched_data *q = qdisc_priv(sch);
353 INIT_LIST_HEAD(&q->new_flows);
354 INIT_LIST_HEAD(&q->old_flows);
355 for (i = 0; i < q->flows_cnt; i++) {
356 struct fq_codel_flow *flow = q->flows + i;
358 fq_codel_flow_purge(flow);
359 INIT_LIST_HEAD(&flow->flowchain);
360 codel_vars_init(&flow->cvars);
362 memset(q->backlogs, 0, q->flows_cnt * sizeof(u32));
364 sch->qstats.backlog = 0;
368 static const struct nla_policy fq_codel_policy[TCA_FQ_CODEL_MAX + 1] = {
369 [TCA_FQ_CODEL_TARGET] = { .type = NLA_U32 },
370 [TCA_FQ_CODEL_LIMIT] = { .type = NLA_U32 },
371 [TCA_FQ_CODEL_INTERVAL] = { .type = NLA_U32 },
372 [TCA_FQ_CODEL_ECN] = { .type = NLA_U32 },
373 [TCA_FQ_CODEL_FLOWS] = { .type = NLA_U32 },
374 [TCA_FQ_CODEL_QUANTUM] = { .type = NLA_U32 },
375 [TCA_FQ_CODEL_CE_THRESHOLD] = { .type = NLA_U32 },
376 [TCA_FQ_CODEL_DROP_BATCH_SIZE] = { .type = NLA_U32 },
377 [TCA_FQ_CODEL_MEMORY_LIMIT] = { .type = NLA_U32 },
380 static int fq_codel_change(struct Qdisc *sch, struct nlattr *opt,
381 struct netlink_ext_ack *extack)
383 struct fq_codel_sched_data *q = qdisc_priv(sch);
384 struct nlattr *tb[TCA_FQ_CODEL_MAX + 1];
391 err = nla_parse_nested(tb, TCA_FQ_CODEL_MAX, opt, fq_codel_policy,
395 if (tb[TCA_FQ_CODEL_FLOWS]) {
398 q->flows_cnt = nla_get_u32(tb[TCA_FQ_CODEL_FLOWS]);
400 q->flows_cnt > 65536)
403 if (tb[TCA_FQ_CODEL_QUANTUM]) {
404 quantum = max(256U, nla_get_u32(tb[TCA_FQ_CODEL_QUANTUM]));
405 if (quantum > FQ_CODEL_QUANTUM_MAX) {
406 NL_SET_ERR_MSG(extack, "Invalid quantum");
412 if (tb[TCA_FQ_CODEL_TARGET]) {
413 u64 target = nla_get_u32(tb[TCA_FQ_CODEL_TARGET]);
415 q->cparams.target = (target * NSEC_PER_USEC) >> CODEL_SHIFT;
418 if (tb[TCA_FQ_CODEL_CE_THRESHOLD]) {
419 u64 val = nla_get_u32(tb[TCA_FQ_CODEL_CE_THRESHOLD]);
421 q->cparams.ce_threshold = (val * NSEC_PER_USEC) >> CODEL_SHIFT;
424 if (tb[TCA_FQ_CODEL_INTERVAL]) {
425 u64 interval = nla_get_u32(tb[TCA_FQ_CODEL_INTERVAL]);
427 q->cparams.interval = (interval * NSEC_PER_USEC) >> CODEL_SHIFT;
430 if (tb[TCA_FQ_CODEL_LIMIT])
431 sch->limit = nla_get_u32(tb[TCA_FQ_CODEL_LIMIT]);
433 if (tb[TCA_FQ_CODEL_ECN])
434 q->cparams.ecn = !!nla_get_u32(tb[TCA_FQ_CODEL_ECN]);
437 q->quantum = quantum;
439 if (tb[TCA_FQ_CODEL_DROP_BATCH_SIZE])
440 q->drop_batch_size = max(1U, nla_get_u32(tb[TCA_FQ_CODEL_DROP_BATCH_SIZE]));
442 if (tb[TCA_FQ_CODEL_MEMORY_LIMIT])
443 q->memory_limit = min(1U << 31, nla_get_u32(tb[TCA_FQ_CODEL_MEMORY_LIMIT]));
445 while (sch->q.qlen > sch->limit ||
446 q->memory_usage > q->memory_limit) {
447 struct sk_buff *skb = fq_codel_dequeue(sch);
449 q->cstats.drop_len += qdisc_pkt_len(skb);
450 rtnl_kfree_skbs(skb, skb);
451 q->cstats.drop_count++;
453 qdisc_tree_reduce_backlog(sch, q->cstats.drop_count, q->cstats.drop_len);
454 q->cstats.drop_count = 0;
455 q->cstats.drop_len = 0;
457 sch_tree_unlock(sch);
461 static void fq_codel_destroy(struct Qdisc *sch)
463 struct fq_codel_sched_data *q = qdisc_priv(sch);
465 tcf_block_put(q->block);
470 static int fq_codel_init(struct Qdisc *sch, struct nlattr *opt,
471 struct netlink_ext_ack *extack)
473 struct fq_codel_sched_data *q = qdisc_priv(sch);
477 sch->limit = 10*1024;
479 q->memory_limit = 32 << 20; /* 32 MBytes */
480 q->drop_batch_size = 64;
481 q->quantum = psched_mtu(qdisc_dev(sch));
482 INIT_LIST_HEAD(&q->new_flows);
483 INIT_LIST_HEAD(&q->old_flows);
484 codel_params_init(&q->cparams);
485 codel_stats_init(&q->cstats);
486 q->cparams.ecn = true;
487 q->cparams.mtu = psched_mtu(qdisc_dev(sch));
490 err = fq_codel_change(sch, opt, extack);
495 err = tcf_block_get(&q->block, &q->filter_list, sch, extack);
500 q->flows = kvcalloc(q->flows_cnt,
501 sizeof(struct fq_codel_flow),
507 q->backlogs = kvcalloc(q->flows_cnt, sizeof(u32), GFP_KERNEL);
512 for (i = 0; i < q->flows_cnt; i++) {
513 struct fq_codel_flow *flow = q->flows + i;
515 INIT_LIST_HEAD(&flow->flowchain);
516 codel_vars_init(&flow->cvars);
520 sch->flags |= TCQ_F_CAN_BYPASS;
522 sch->flags &= ~TCQ_F_CAN_BYPASS;
533 static int fq_codel_dump(struct Qdisc *sch, struct sk_buff *skb)
535 struct fq_codel_sched_data *q = qdisc_priv(sch);
538 opts = nla_nest_start(skb, TCA_OPTIONS);
540 goto nla_put_failure;
542 if (nla_put_u32(skb, TCA_FQ_CODEL_TARGET,
543 codel_time_to_us(q->cparams.target)) ||
544 nla_put_u32(skb, TCA_FQ_CODEL_LIMIT,
546 nla_put_u32(skb, TCA_FQ_CODEL_INTERVAL,
547 codel_time_to_us(q->cparams.interval)) ||
548 nla_put_u32(skb, TCA_FQ_CODEL_ECN,
550 nla_put_u32(skb, TCA_FQ_CODEL_QUANTUM,
552 nla_put_u32(skb, TCA_FQ_CODEL_DROP_BATCH_SIZE,
553 q->drop_batch_size) ||
554 nla_put_u32(skb, TCA_FQ_CODEL_MEMORY_LIMIT,
556 nla_put_u32(skb, TCA_FQ_CODEL_FLOWS,
558 goto nla_put_failure;
560 if (q->cparams.ce_threshold != CODEL_DISABLED_THRESHOLD &&
561 nla_put_u32(skb, TCA_FQ_CODEL_CE_THRESHOLD,
562 codel_time_to_us(q->cparams.ce_threshold)))
563 goto nla_put_failure;
565 return nla_nest_end(skb, opts);
571 static int fq_codel_dump_stats(struct Qdisc *sch, struct gnet_dump *d)
573 struct fq_codel_sched_data *q = qdisc_priv(sch);
574 struct tc_fq_codel_xstats st = {
575 .type = TCA_FQ_CODEL_XSTATS_QDISC,
577 struct list_head *pos;
579 st.qdisc_stats.maxpacket = q->cstats.maxpacket;
580 st.qdisc_stats.drop_overlimit = q->drop_overlimit;
581 st.qdisc_stats.ecn_mark = q->cstats.ecn_mark;
582 st.qdisc_stats.new_flow_count = q->new_flow_count;
583 st.qdisc_stats.ce_mark = q->cstats.ce_mark;
584 st.qdisc_stats.memory_usage = q->memory_usage;
585 st.qdisc_stats.drop_overmemory = q->drop_overmemory;
588 list_for_each(pos, &q->new_flows)
589 st.qdisc_stats.new_flows_len++;
591 list_for_each(pos, &q->old_flows)
592 st.qdisc_stats.old_flows_len++;
593 sch_tree_unlock(sch);
595 return gnet_stats_copy_app(d, &st, sizeof(st));
598 static struct Qdisc *fq_codel_leaf(struct Qdisc *sch, unsigned long arg)
603 static unsigned long fq_codel_find(struct Qdisc *sch, u32 classid)
608 static unsigned long fq_codel_bind(struct Qdisc *sch, unsigned long parent,
614 static void fq_codel_unbind(struct Qdisc *q, unsigned long cl)
618 static struct tcf_block *fq_codel_tcf_block(struct Qdisc *sch, unsigned long cl,
619 struct netlink_ext_ack *extack)
621 struct fq_codel_sched_data *q = qdisc_priv(sch);
628 static int fq_codel_dump_class(struct Qdisc *sch, unsigned long cl,
629 struct sk_buff *skb, struct tcmsg *tcm)
631 tcm->tcm_handle |= TC_H_MIN(cl);
635 static int fq_codel_dump_class_stats(struct Qdisc *sch, unsigned long cl,
638 struct fq_codel_sched_data *q = qdisc_priv(sch);
640 struct gnet_stats_queue qs = { 0 };
641 struct tc_fq_codel_xstats xstats;
643 if (idx < q->flows_cnt) {
644 const struct fq_codel_flow *flow = &q->flows[idx];
645 const struct sk_buff *skb;
647 memset(&xstats, 0, sizeof(xstats));
648 xstats.type = TCA_FQ_CODEL_XSTATS_CLASS;
649 xstats.class_stats.deficit = flow->deficit;
650 xstats.class_stats.ldelay =
651 codel_time_to_us(flow->cvars.ldelay);
652 xstats.class_stats.count = flow->cvars.count;
653 xstats.class_stats.lastcount = flow->cvars.lastcount;
654 xstats.class_stats.dropping = flow->cvars.dropping;
655 if (flow->cvars.dropping) {
656 codel_tdiff_t delta = flow->cvars.drop_next -
659 xstats.class_stats.drop_next = (delta >= 0) ?
660 codel_time_to_us(delta) :
661 -codel_time_to_us(-delta);
670 sch_tree_unlock(sch);
672 qs.backlog = q->backlogs[idx];
673 qs.drops = flow->dropped;
675 if (gnet_stats_copy_queue(d, NULL, &qs, qs.qlen) < 0)
677 if (idx < q->flows_cnt)
678 return gnet_stats_copy_app(d, &xstats, sizeof(xstats));
682 static void fq_codel_walk(struct Qdisc *sch, struct qdisc_walker *arg)
684 struct fq_codel_sched_data *q = qdisc_priv(sch);
690 for (i = 0; i < q->flows_cnt; i++) {
691 if (list_empty(&q->flows[i].flowchain) ||
692 arg->count < arg->skip) {
696 if (arg->fn(sch, i + 1, arg) < 0) {
704 static const struct Qdisc_class_ops fq_codel_class_ops = {
705 .leaf = fq_codel_leaf,
706 .find = fq_codel_find,
707 .tcf_block = fq_codel_tcf_block,
708 .bind_tcf = fq_codel_bind,
709 .unbind_tcf = fq_codel_unbind,
710 .dump = fq_codel_dump_class,
711 .dump_stats = fq_codel_dump_class_stats,
712 .walk = fq_codel_walk,
715 static struct Qdisc_ops fq_codel_qdisc_ops __read_mostly = {
716 .cl_ops = &fq_codel_class_ops,
718 .priv_size = sizeof(struct fq_codel_sched_data),
719 .enqueue = fq_codel_enqueue,
720 .dequeue = fq_codel_dequeue,
721 .peek = qdisc_peek_dequeued,
722 .init = fq_codel_init,
723 .reset = fq_codel_reset,
724 .destroy = fq_codel_destroy,
725 .change = fq_codel_change,
726 .dump = fq_codel_dump,
727 .dump_stats = fq_codel_dump_stats,
728 .owner = THIS_MODULE,
731 static int __init fq_codel_module_init(void)
733 return register_qdisc(&fq_codel_qdisc_ops);
736 static void __exit fq_codel_module_exit(void)
738 unregister_qdisc(&fq_codel_qdisc_ops);
741 module_init(fq_codel_module_init)
742 module_exit(fq_codel_module_exit)
743 MODULE_AUTHOR("Eric Dumazet");
744 MODULE_LICENSE("GPL");