2 * net/sched/sch_generic.c Generic packet scheduler routines.
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 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
10 * Jamal Hadi Salim, <hadi@cyberus.ca> 990601
14 #include <linux/bitops.h>
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/kernel.h>
18 #include <linux/sched.h>
19 #include <linux/string.h>
20 #include <linux/errno.h>
21 #include <linux/netdevice.h>
22 #include <linux/skbuff.h>
23 #include <linux/rtnetlink.h>
24 #include <linux/init.h>
25 #include <linux/rcupdate.h>
26 #include <linux/list.h>
27 #include <net/pkt_sched.h>
29 /* Main transmission queue. */
31 /* Modifications to data participating in scheduling must be protected with
32 * qdisc_lock(qdisc) spinlock.
34 * The idea is the following:
35 * - enqueue, dequeue are serialized via qdisc root lock
36 * - ingress filtering is also serialized via qdisc root lock
37 * - updates to tree and tree walking are only done under the rtnl mutex.
40 static inline int qdisc_qlen(struct Qdisc *q)
45 static inline int dev_requeue_skb(struct sk_buff *skb, struct Qdisc *q)
54 static inline struct sk_buff *dequeue_skb(struct Qdisc *q)
56 struct sk_buff *skb = q->gso_skb;
59 struct net_device *dev = qdisc_dev(q);
60 struct netdev_queue *txq;
62 /* check the reason of requeuing without tx lock first */
63 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
64 if (!netif_tx_queue_stopped(txq) && !netif_tx_queue_frozen(txq))
75 static inline int handle_dev_cpu_collision(struct sk_buff *skb,
76 struct netdev_queue *dev_queue,
81 if (unlikely(dev_queue->xmit_lock_owner == smp_processor_id())) {
83 * Same CPU holding the lock. It may be a transient
84 * configuration error, when hard_start_xmit() recurses. We
85 * detect it by checking xmit owner and drop the packet when
86 * deadloop is detected. Return OK to try the next skb.
90 printk(KERN_WARNING "Dead loop on netdevice %s, "
91 "fix it urgently!\n", dev_queue->dev->name);
95 * Another cpu is holding lock, requeue & delay xmits for
98 __get_cpu_var(netdev_rx_stat).cpu_collision++;
99 ret = dev_requeue_skb(skb, q);
106 * NOTE: Called under qdisc_lock(q) with locally disabled BH.
108 * __QDISC_STATE_RUNNING guarantees only one CPU can process
109 * this qdisc at a time. qdisc_lock(q) serializes queue accesses for
112 * netif_tx_lock serializes accesses to device driver.
114 * qdisc_lock(q) and netif_tx_lock are mutually exclusive,
115 * if one is grabbed, another must be free.
117 * Note, that this procedure can be called by a watchdog timer
119 * Returns to the caller:
120 * 0 - queue is empty or throttled.
121 * >0 - queue is not empty.
124 static inline int qdisc_restart(struct Qdisc *q)
126 struct netdev_queue *txq;
127 int ret = NETDEV_TX_BUSY;
128 struct net_device *dev;
129 spinlock_t *root_lock;
133 if (unlikely((skb = dequeue_skb(q)) == NULL))
136 root_lock = qdisc_lock(q);
138 /* And release qdisc */
139 spin_unlock(root_lock);
142 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
144 HARD_TX_LOCK(dev, txq, smp_processor_id());
145 if (!netif_tx_queue_stopped(txq) &&
146 !netif_tx_queue_frozen(txq))
147 ret = dev_hard_start_xmit(skb, dev, txq);
148 HARD_TX_UNLOCK(dev, txq);
150 spin_lock(root_lock);
154 /* Driver sent out skb successfully */
158 case NETDEV_TX_LOCKED:
159 /* Driver try lock failed */
160 ret = handle_dev_cpu_collision(skb, txq, q);
164 /* Driver returned NETDEV_TX_BUSY - requeue skb */
165 if (unlikely (ret != NETDEV_TX_BUSY && net_ratelimit()))
166 printk(KERN_WARNING "BUG %s code %d qlen %d\n",
167 dev->name, ret, q->q.qlen);
169 ret = dev_requeue_skb(skb, q);
173 if (ret && (netif_tx_queue_stopped(txq) ||
174 netif_tx_queue_frozen(txq)))
180 void __qdisc_run(struct Qdisc *q)
182 unsigned long start_time = jiffies;
184 while (qdisc_restart(q)) {
186 * Postpone processing if
187 * 1. another process needs the CPU;
188 * 2. we've been doing it for too long.
190 if (need_resched() || jiffies != start_time) {
196 clear_bit(__QDISC_STATE_RUNNING, &q->state);
199 static void dev_watchdog(unsigned long arg)
201 struct net_device *dev = (struct net_device *)arg;
204 if (!qdisc_tx_is_noop(dev)) {
205 if (netif_device_present(dev) &&
206 netif_running(dev) &&
207 netif_carrier_ok(dev)) {
208 int some_queue_stopped = 0;
211 for (i = 0; i < dev->num_tx_queues; i++) {
212 struct netdev_queue *txq;
214 txq = netdev_get_tx_queue(dev, i);
215 if (netif_tx_queue_stopped(txq)) {
216 some_queue_stopped = 1;
221 if (some_queue_stopped &&
222 time_after(jiffies, (dev->trans_start +
223 dev->watchdog_timeo))) {
225 WARN_ONCE(1, KERN_INFO "NETDEV WATCHDOG: %s (%s): transmit timed out\n",
226 dev->name, netdev_drivername(dev, drivername, 64));
227 dev->tx_timeout(dev);
229 if (!mod_timer(&dev->watchdog_timer,
230 round_jiffies(jiffies +
231 dev->watchdog_timeo)))
235 netif_tx_unlock(dev);
240 void __netdev_watchdog_up(struct net_device *dev)
242 if (dev->tx_timeout) {
243 if (dev->watchdog_timeo <= 0)
244 dev->watchdog_timeo = 5*HZ;
245 if (!mod_timer(&dev->watchdog_timer,
246 round_jiffies(jiffies + dev->watchdog_timeo)))
251 static void dev_watchdog_up(struct net_device *dev)
253 __netdev_watchdog_up(dev);
256 static void dev_watchdog_down(struct net_device *dev)
258 netif_tx_lock_bh(dev);
259 if (del_timer(&dev->watchdog_timer))
261 netif_tx_unlock_bh(dev);
265 * netif_carrier_on - set carrier
266 * @dev: network device
268 * Device has detected that carrier.
270 void netif_carrier_on(struct net_device *dev)
272 if (test_and_clear_bit(__LINK_STATE_NOCARRIER, &dev->state)) {
273 linkwatch_fire_event(dev);
274 if (netif_running(dev))
275 __netdev_watchdog_up(dev);
278 EXPORT_SYMBOL(netif_carrier_on);
281 * netif_carrier_off - clear carrier
282 * @dev: network device
284 * Device has detected loss of carrier.
286 void netif_carrier_off(struct net_device *dev)
288 if (!test_and_set_bit(__LINK_STATE_NOCARRIER, &dev->state))
289 linkwatch_fire_event(dev);
291 EXPORT_SYMBOL(netif_carrier_off);
293 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
294 under all circumstances. It is difficult to invent anything faster or
298 static int noop_enqueue(struct sk_buff *skb, struct Qdisc * qdisc)
304 static struct sk_buff *noop_dequeue(struct Qdisc * qdisc)
309 static int noop_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
312 printk(KERN_DEBUG "%s deferred output. It is buggy.\n",
318 struct Qdisc_ops noop_qdisc_ops __read_mostly = {
321 .enqueue = noop_enqueue,
322 .dequeue = noop_dequeue,
323 .requeue = noop_requeue,
324 .owner = THIS_MODULE,
327 static struct netdev_queue noop_netdev_queue = {
328 .qdisc = &noop_qdisc,
329 .qdisc_sleeping = &noop_qdisc,
332 struct Qdisc noop_qdisc = {
333 .enqueue = noop_enqueue,
334 .dequeue = noop_dequeue,
335 .flags = TCQ_F_BUILTIN,
336 .ops = &noop_qdisc_ops,
337 .list = LIST_HEAD_INIT(noop_qdisc.list),
338 .requeue.lock = __SPIN_LOCK_UNLOCKED(noop_qdisc.q.lock),
339 .q.lock = __SPIN_LOCK_UNLOCKED(noop_qdisc.q.lock),
340 .dev_queue = &noop_netdev_queue,
342 EXPORT_SYMBOL(noop_qdisc);
344 static struct Qdisc_ops noqueue_qdisc_ops __read_mostly = {
347 .enqueue = noop_enqueue,
348 .dequeue = noop_dequeue,
349 .requeue = noop_requeue,
350 .owner = THIS_MODULE,
353 static struct Qdisc noqueue_qdisc;
354 static struct netdev_queue noqueue_netdev_queue = {
355 .qdisc = &noqueue_qdisc,
356 .qdisc_sleeping = &noqueue_qdisc,
359 static struct Qdisc noqueue_qdisc = {
361 .dequeue = noop_dequeue,
362 .flags = TCQ_F_BUILTIN,
363 .ops = &noqueue_qdisc_ops,
364 .list = LIST_HEAD_INIT(noqueue_qdisc.list),
365 .requeue.lock = __SPIN_LOCK_UNLOCKED(noqueue_qdisc.q.lock),
366 .q.lock = __SPIN_LOCK_UNLOCKED(noqueue_qdisc.q.lock),
367 .dev_queue = &noqueue_netdev_queue,
371 static const u8 prio2band[TC_PRIO_MAX+1] =
372 { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
374 /* 3-band FIFO queue: old style, but should be a bit faster than
375 generic prio+fifo combination.
378 #define PFIFO_FAST_BANDS 3
380 static inline struct sk_buff_head *prio2list(struct sk_buff *skb,
383 struct sk_buff_head *list = qdisc_priv(qdisc);
384 return list + prio2band[skb->priority & TC_PRIO_MAX];
387 static int pfifo_fast_enqueue(struct sk_buff *skb, struct Qdisc* qdisc)
389 struct sk_buff_head *list = prio2list(skb, qdisc);
391 if (skb_queue_len(list) < qdisc_dev(qdisc)->tx_queue_len) {
393 return __qdisc_enqueue_tail(skb, qdisc, list);
396 return qdisc_drop(skb, qdisc);
399 static struct sk_buff *pfifo_fast_dequeue(struct Qdisc* qdisc)
402 struct sk_buff_head *list = qdisc_priv(qdisc);
404 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++) {
405 if (!skb_queue_empty(list + prio)) {
407 return __qdisc_dequeue_head(qdisc, list + prio);
414 static int pfifo_fast_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
417 return __qdisc_requeue(skb, qdisc, prio2list(skb, qdisc));
420 static void pfifo_fast_reset(struct Qdisc* qdisc)
423 struct sk_buff_head *list = qdisc_priv(qdisc);
425 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
426 __qdisc_reset_queue(qdisc, list + prio);
428 qdisc->qstats.backlog = 0;
432 static int pfifo_fast_dump(struct Qdisc *qdisc, struct sk_buff *skb)
434 struct tc_prio_qopt opt = { .bands = PFIFO_FAST_BANDS };
436 memcpy(&opt.priomap, prio2band, TC_PRIO_MAX+1);
437 NLA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
444 static int pfifo_fast_init(struct Qdisc *qdisc, struct nlattr *opt)
447 struct sk_buff_head *list = qdisc_priv(qdisc);
449 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
450 skb_queue_head_init(list + prio);
455 static struct Qdisc_ops pfifo_fast_ops __read_mostly = {
457 .priv_size = PFIFO_FAST_BANDS * sizeof(struct sk_buff_head),
458 .enqueue = pfifo_fast_enqueue,
459 .dequeue = pfifo_fast_dequeue,
460 .requeue = pfifo_fast_requeue,
461 .init = pfifo_fast_init,
462 .reset = pfifo_fast_reset,
463 .dump = pfifo_fast_dump,
464 .owner = THIS_MODULE,
467 struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
468 struct Qdisc_ops *ops)
475 /* ensure that the Qdisc and the private data are 32-byte aligned */
476 size = QDISC_ALIGN(sizeof(*sch));
477 size += ops->priv_size + (QDISC_ALIGNTO - 1);
479 p = kzalloc(size, GFP_KERNEL);
482 sch = (struct Qdisc *) QDISC_ALIGN((unsigned long) p);
483 sch->padded = (char *) sch - (char *) p;
485 INIT_LIST_HEAD(&sch->list);
486 skb_queue_head_init(&sch->requeue);
487 skb_queue_head_init(&sch->q);
489 sch->enqueue = ops->enqueue;
490 sch->dequeue = ops->dequeue;
491 sch->dev_queue = dev_queue;
492 dev_hold(qdisc_dev(sch));
493 atomic_set(&sch->refcnt, 1);
500 struct Qdisc * qdisc_create_dflt(struct net_device *dev,
501 struct netdev_queue *dev_queue,
502 struct Qdisc_ops *ops,
503 unsigned int parentid)
507 sch = qdisc_alloc(dev_queue, ops);
510 sch->parent = parentid;
512 if (!ops->init || ops->init(sch, NULL) == 0)
519 EXPORT_SYMBOL(qdisc_create_dflt);
521 /* Under qdisc_lock(qdisc) and BH! */
523 void qdisc_reset(struct Qdisc *qdisc)
525 const struct Qdisc_ops *ops = qdisc->ops;
530 EXPORT_SYMBOL(qdisc_reset);
532 void qdisc_destroy(struct Qdisc *qdisc)
534 const struct Qdisc_ops *ops = qdisc->ops;
536 if (qdisc->flags & TCQ_F_BUILTIN ||
537 !atomic_dec_and_test(&qdisc->refcnt))
540 #ifdef CONFIG_NET_SCHED
541 qdisc_list_del(qdisc);
543 qdisc_put_stab(qdisc->stab);
545 gen_kill_estimator(&qdisc->bstats, &qdisc->rate_est);
551 module_put(ops->owner);
552 dev_put(qdisc_dev(qdisc));
554 kfree_skb(qdisc->gso_skb);
555 __skb_queue_purge(&qdisc->requeue);
557 kfree((char *) qdisc - qdisc->padded);
559 EXPORT_SYMBOL(qdisc_destroy);
561 static bool dev_all_qdisc_sleeping_noop(struct net_device *dev)
565 for (i = 0; i < dev->num_tx_queues; i++) {
566 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
568 if (txq->qdisc_sleeping != &noop_qdisc)
574 static void attach_one_default_qdisc(struct net_device *dev,
575 struct netdev_queue *dev_queue,
580 if (dev->tx_queue_len) {
581 qdisc = qdisc_create_dflt(dev, dev_queue,
582 &pfifo_fast_ops, TC_H_ROOT);
584 printk(KERN_INFO "%s: activation failed\n", dev->name);
588 qdisc = &noqueue_qdisc;
590 dev_queue->qdisc_sleeping = qdisc;
593 static void transition_one_qdisc(struct net_device *dev,
594 struct netdev_queue *dev_queue,
595 void *_need_watchdog)
597 struct Qdisc *new_qdisc = dev_queue->qdisc_sleeping;
598 int *need_watchdog_p = _need_watchdog;
600 if (!(new_qdisc->flags & TCQ_F_BUILTIN))
601 clear_bit(__QDISC_STATE_DEACTIVATED, &new_qdisc->state);
603 rcu_assign_pointer(dev_queue->qdisc, new_qdisc);
604 if (need_watchdog_p && new_qdisc != &noqueue_qdisc)
605 *need_watchdog_p = 1;
608 void dev_activate(struct net_device *dev)
612 /* No queueing discipline is attached to device;
613 create default one i.e. pfifo_fast for devices,
614 which need queueing and noqueue_qdisc for
618 if (dev_all_qdisc_sleeping_noop(dev))
619 netdev_for_each_tx_queue(dev, attach_one_default_qdisc, NULL);
621 if (!netif_carrier_ok(dev))
622 /* Delay activation until next carrier-on event */
626 netdev_for_each_tx_queue(dev, transition_one_qdisc, &need_watchdog);
627 transition_one_qdisc(dev, &dev->rx_queue, NULL);
630 dev->trans_start = jiffies;
631 dev_watchdog_up(dev);
635 static void dev_deactivate_queue(struct net_device *dev,
636 struct netdev_queue *dev_queue,
637 void *_qdisc_default)
639 struct Qdisc *qdisc_default = _qdisc_default;
642 qdisc = dev_queue->qdisc;
644 spin_lock_bh(qdisc_lock(qdisc));
646 if (!(qdisc->flags & TCQ_F_BUILTIN))
647 set_bit(__QDISC_STATE_DEACTIVATED, &qdisc->state);
649 rcu_assign_pointer(dev_queue->qdisc, qdisc_default);
652 spin_unlock_bh(qdisc_lock(qdisc));
656 static bool some_qdisc_is_busy(struct net_device *dev)
660 for (i = 0; i < dev->num_tx_queues; i++) {
661 struct netdev_queue *dev_queue;
662 spinlock_t *root_lock;
666 dev_queue = netdev_get_tx_queue(dev, i);
667 q = dev_queue->qdisc_sleeping;
668 root_lock = qdisc_lock(q);
670 spin_lock_bh(root_lock);
672 val = (test_bit(__QDISC_STATE_RUNNING, &q->state) ||
673 test_bit(__QDISC_STATE_SCHED, &q->state));
675 spin_unlock_bh(root_lock);
683 void dev_deactivate(struct net_device *dev)
685 netdev_for_each_tx_queue(dev, dev_deactivate_queue, &noop_qdisc);
686 dev_deactivate_queue(dev, &dev->rx_queue, &noop_qdisc);
688 dev_watchdog_down(dev);
690 /* Wait for outstanding qdisc-less dev_queue_xmit calls. */
693 /* Wait for outstanding qdisc_run calls. */
694 while (some_qdisc_is_busy(dev))
698 static void dev_init_scheduler_queue(struct net_device *dev,
699 struct netdev_queue *dev_queue,
702 struct Qdisc *qdisc = _qdisc;
704 dev_queue->qdisc = qdisc;
705 dev_queue->qdisc_sleeping = qdisc;
708 void dev_init_scheduler(struct net_device *dev)
710 netdev_for_each_tx_queue(dev, dev_init_scheduler_queue, &noop_qdisc);
711 dev_init_scheduler_queue(dev, &dev->rx_queue, &noop_qdisc);
713 setup_timer(&dev->watchdog_timer, dev_watchdog, (unsigned long)dev);
716 static void shutdown_scheduler_queue(struct net_device *dev,
717 struct netdev_queue *dev_queue,
718 void *_qdisc_default)
720 struct Qdisc *qdisc = dev_queue->qdisc_sleeping;
721 struct Qdisc *qdisc_default = _qdisc_default;
724 rcu_assign_pointer(dev_queue->qdisc, qdisc_default);
725 dev_queue->qdisc_sleeping = qdisc_default;
727 qdisc_destroy(qdisc);
731 void dev_shutdown(struct net_device *dev)
733 netdev_for_each_tx_queue(dev, shutdown_scheduler_queue, &noop_qdisc);
734 shutdown_scheduler_queue(dev, &dev->rx_queue, &noop_qdisc);
735 WARN_ON(timer_pending(&dev->watchdog_timer));