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)
47 if (unlikely(skb->next))
50 q->ops->requeue(skb, q);
56 static inline struct sk_buff *dequeue_skb(struct Qdisc *q)
60 if ((skb = q->gso_skb))
68 static inline int handle_dev_cpu_collision(struct sk_buff *skb,
69 struct netdev_queue *dev_queue,
74 if (unlikely(dev_queue->xmit_lock_owner == smp_processor_id())) {
76 * Same CPU holding the lock. It may be a transient
77 * configuration error, when hard_start_xmit() recurses. We
78 * detect it by checking xmit owner and drop the packet when
79 * deadloop is detected. Return OK to try the next skb.
83 printk(KERN_WARNING "Dead loop on netdevice %s, "
84 "fix it urgently!\n", dev_queue->dev->name);
88 * Another cpu is holding lock, requeue & delay xmits for
91 __get_cpu_var(netdev_rx_stat).cpu_collision++;
92 ret = dev_requeue_skb(skb, q);
99 * NOTE: Called under qdisc_lock(q) with locally disabled BH.
101 * __QDISC_STATE_RUNNING guarantees only one CPU can process
102 * this qdisc at a time. qdisc_lock(q) serializes queue accesses for
105 * netif_tx_lock serializes accesses to device driver.
107 * qdisc_lock(q) and netif_tx_lock are mutually exclusive,
108 * if one is grabbed, another must be free.
110 * Note, that this procedure can be called by a watchdog timer
112 * Returns to the caller:
113 * 0 - queue is empty or throttled.
114 * >0 - queue is not empty.
117 static inline int qdisc_restart(struct Qdisc *q)
119 struct netdev_queue *txq;
120 int ret = NETDEV_TX_BUSY;
121 struct net_device *dev;
122 spinlock_t *root_lock;
126 if (unlikely((skb = dequeue_skb(q)) == NULL))
129 root_lock = qdisc_lock(q);
131 /* And release qdisc */
132 spin_unlock(root_lock);
135 txq = netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
137 HARD_TX_LOCK(dev, txq, smp_processor_id());
138 if (!netif_tx_queue_stopped(txq) &&
139 !netif_tx_queue_frozen(txq))
140 ret = dev_hard_start_xmit(skb, dev, txq);
141 HARD_TX_UNLOCK(dev, txq);
143 spin_lock(root_lock);
147 /* Driver sent out skb successfully */
151 case NETDEV_TX_LOCKED:
152 /* Driver try lock failed */
153 ret = handle_dev_cpu_collision(skb, txq, q);
157 /* Driver returned NETDEV_TX_BUSY - requeue skb */
158 if (unlikely (ret != NETDEV_TX_BUSY && net_ratelimit()))
159 printk(KERN_WARNING "BUG %s code %d qlen %d\n",
160 dev->name, ret, q->q.qlen);
162 ret = dev_requeue_skb(skb, q);
166 if (ret && (netif_tx_queue_stopped(txq) ||
167 netif_tx_queue_frozen(txq)))
173 void __qdisc_run(struct Qdisc *q)
175 unsigned long start_time = jiffies;
177 while (qdisc_restart(q)) {
179 * Postpone processing if
180 * 1. another process needs the CPU;
181 * 2. we've been doing it for too long.
183 if (need_resched() || jiffies != start_time) {
189 clear_bit(__QDISC_STATE_RUNNING, &q->state);
192 static void dev_watchdog(unsigned long arg)
194 struct net_device *dev = (struct net_device *)arg;
197 if (!qdisc_tx_is_noop(dev)) {
198 if (netif_device_present(dev) &&
199 netif_running(dev) &&
200 netif_carrier_ok(dev)) {
201 int some_queue_stopped = 0;
204 for (i = 0; i < dev->num_tx_queues; i++) {
205 struct netdev_queue *txq;
207 txq = netdev_get_tx_queue(dev, i);
208 if (netif_tx_queue_stopped(txq)) {
209 some_queue_stopped = 1;
214 if (some_queue_stopped &&
215 time_after(jiffies, (dev->trans_start +
216 dev->watchdog_timeo))) {
218 WARN_ONCE(1, KERN_INFO "NETDEV WATCHDOG: %s (%s): transmit timed out\n",
219 dev->name, netdev_drivername(dev, drivername, 64));
220 dev->tx_timeout(dev);
222 if (!mod_timer(&dev->watchdog_timer,
223 round_jiffies(jiffies +
224 dev->watchdog_timeo)))
228 netif_tx_unlock(dev);
233 void __netdev_watchdog_up(struct net_device *dev)
235 if (dev->tx_timeout) {
236 if (dev->watchdog_timeo <= 0)
237 dev->watchdog_timeo = 5*HZ;
238 if (!mod_timer(&dev->watchdog_timer,
239 round_jiffies(jiffies + dev->watchdog_timeo)))
244 static void dev_watchdog_up(struct net_device *dev)
246 __netdev_watchdog_up(dev);
249 static void dev_watchdog_down(struct net_device *dev)
251 netif_tx_lock_bh(dev);
252 if (del_timer(&dev->watchdog_timer))
254 netif_tx_unlock_bh(dev);
258 * netif_carrier_on - set carrier
259 * @dev: network device
261 * Device has detected that carrier.
263 void netif_carrier_on(struct net_device *dev)
265 if (test_and_clear_bit(__LINK_STATE_NOCARRIER, &dev->state)) {
266 linkwatch_fire_event(dev);
267 if (netif_running(dev))
268 __netdev_watchdog_up(dev);
271 EXPORT_SYMBOL(netif_carrier_on);
274 * netif_carrier_off - clear carrier
275 * @dev: network device
277 * Device has detected loss of carrier.
279 void netif_carrier_off(struct net_device *dev)
281 if (!test_and_set_bit(__LINK_STATE_NOCARRIER, &dev->state))
282 linkwatch_fire_event(dev);
284 EXPORT_SYMBOL(netif_carrier_off);
286 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
287 under all circumstances. It is difficult to invent anything faster or
291 static int noop_enqueue(struct sk_buff *skb, struct Qdisc * qdisc)
297 static struct sk_buff *noop_dequeue(struct Qdisc * qdisc)
302 static int noop_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
305 printk(KERN_DEBUG "%s deferred output. It is buggy.\n",
311 struct Qdisc_ops noop_qdisc_ops __read_mostly = {
314 .enqueue = noop_enqueue,
315 .dequeue = noop_dequeue,
316 .requeue = noop_requeue,
317 .owner = THIS_MODULE,
320 static struct netdev_queue noop_netdev_queue = {
321 .qdisc = &noop_qdisc,
324 struct Qdisc noop_qdisc = {
325 .enqueue = noop_enqueue,
326 .dequeue = noop_dequeue,
327 .flags = TCQ_F_BUILTIN,
328 .ops = &noop_qdisc_ops,
329 .list = LIST_HEAD_INIT(noop_qdisc.list),
330 .q.lock = __SPIN_LOCK_UNLOCKED(noop_qdisc.q.lock),
331 .dev_queue = &noop_netdev_queue,
333 EXPORT_SYMBOL(noop_qdisc);
335 static struct Qdisc_ops noqueue_qdisc_ops __read_mostly = {
338 .enqueue = noop_enqueue,
339 .dequeue = noop_dequeue,
340 .requeue = noop_requeue,
341 .owner = THIS_MODULE,
344 static struct Qdisc noqueue_qdisc;
345 static struct netdev_queue noqueue_netdev_queue = {
346 .qdisc = &noqueue_qdisc,
349 static struct Qdisc noqueue_qdisc = {
351 .dequeue = noop_dequeue,
352 .flags = TCQ_F_BUILTIN,
353 .ops = &noqueue_qdisc_ops,
354 .list = LIST_HEAD_INIT(noqueue_qdisc.list),
355 .q.lock = __SPIN_LOCK_UNLOCKED(noqueue_qdisc.q.lock),
356 .dev_queue = &noqueue_netdev_queue,
360 static const u8 prio2band[TC_PRIO_MAX+1] =
361 { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
363 /* 3-band FIFO queue: old style, but should be a bit faster than
364 generic prio+fifo combination.
367 #define PFIFO_FAST_BANDS 3
369 static inline struct sk_buff_head *prio2list(struct sk_buff *skb,
372 struct sk_buff_head *list = qdisc_priv(qdisc);
373 return list + prio2band[skb->priority & TC_PRIO_MAX];
376 static int pfifo_fast_enqueue(struct sk_buff *skb, struct Qdisc* qdisc)
378 struct sk_buff_head *list = prio2list(skb, qdisc);
380 if (skb_queue_len(list) < qdisc_dev(qdisc)->tx_queue_len) {
382 return __qdisc_enqueue_tail(skb, qdisc, list);
385 return qdisc_drop(skb, qdisc);
388 static struct sk_buff *pfifo_fast_dequeue(struct Qdisc* qdisc)
391 struct sk_buff_head *list = qdisc_priv(qdisc);
393 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++) {
394 if (!skb_queue_empty(list + prio)) {
396 return __qdisc_dequeue_head(qdisc, list + prio);
403 static int pfifo_fast_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
406 return __qdisc_requeue(skb, qdisc, prio2list(skb, qdisc));
409 static void pfifo_fast_reset(struct Qdisc* qdisc)
412 struct sk_buff_head *list = qdisc_priv(qdisc);
414 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
415 __qdisc_reset_queue(qdisc, list + prio);
417 qdisc->qstats.backlog = 0;
421 static int pfifo_fast_dump(struct Qdisc *qdisc, struct sk_buff *skb)
423 struct tc_prio_qopt opt = { .bands = PFIFO_FAST_BANDS };
425 memcpy(&opt.priomap, prio2band, TC_PRIO_MAX+1);
426 NLA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
433 static int pfifo_fast_init(struct Qdisc *qdisc, struct nlattr *opt)
436 struct sk_buff_head *list = qdisc_priv(qdisc);
438 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
439 skb_queue_head_init(list + prio);
444 static struct Qdisc_ops pfifo_fast_ops __read_mostly = {
446 .priv_size = PFIFO_FAST_BANDS * sizeof(struct sk_buff_head),
447 .enqueue = pfifo_fast_enqueue,
448 .dequeue = pfifo_fast_dequeue,
449 .requeue = pfifo_fast_requeue,
450 .init = pfifo_fast_init,
451 .reset = pfifo_fast_reset,
452 .dump = pfifo_fast_dump,
453 .owner = THIS_MODULE,
456 struct Qdisc *qdisc_alloc(struct netdev_queue *dev_queue,
457 struct Qdisc_ops *ops)
464 /* ensure that the Qdisc and the private data are 32-byte aligned */
465 size = QDISC_ALIGN(sizeof(*sch));
466 size += ops->priv_size + (QDISC_ALIGNTO - 1);
468 p = kzalloc(size, GFP_KERNEL);
471 sch = (struct Qdisc *) QDISC_ALIGN((unsigned long) p);
472 sch->padded = (char *) sch - (char *) p;
474 INIT_LIST_HEAD(&sch->list);
475 skb_queue_head_init(&sch->q);
477 sch->enqueue = ops->enqueue;
478 sch->dequeue = ops->dequeue;
479 sch->dev_queue = dev_queue;
480 dev_hold(qdisc_dev(sch));
481 atomic_set(&sch->refcnt, 1);
488 struct Qdisc * qdisc_create_dflt(struct net_device *dev,
489 struct netdev_queue *dev_queue,
490 struct Qdisc_ops *ops,
491 unsigned int parentid)
495 sch = qdisc_alloc(dev_queue, ops);
498 sch->parent = parentid;
500 if (!ops->init || ops->init(sch, NULL) == 0)
507 EXPORT_SYMBOL(qdisc_create_dflt);
509 /* Under qdisc_lock(qdisc) and BH! */
511 void qdisc_reset(struct Qdisc *qdisc)
513 const struct Qdisc_ops *ops = qdisc->ops;
518 EXPORT_SYMBOL(qdisc_reset);
520 void qdisc_destroy(struct Qdisc *qdisc)
522 const struct Qdisc_ops *ops = qdisc->ops;
524 if (qdisc->flags & TCQ_F_BUILTIN ||
525 !atomic_dec_and_test(&qdisc->refcnt))
528 #ifdef CONFIG_NET_SCHED
529 qdisc_list_del(qdisc);
531 qdisc_put_stab(qdisc->stab);
533 gen_kill_estimator(&qdisc->bstats, &qdisc->rate_est);
539 module_put(ops->owner);
540 dev_put(qdisc_dev(qdisc));
542 kfree_skb(qdisc->gso_skb);
544 kfree((char *) qdisc - qdisc->padded);
546 EXPORT_SYMBOL(qdisc_destroy);
548 static bool dev_all_qdisc_sleeping_noop(struct net_device *dev)
552 for (i = 0; i < dev->num_tx_queues; i++) {
553 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
555 if (txq->qdisc_sleeping != &noop_qdisc)
561 static void attach_one_default_qdisc(struct net_device *dev,
562 struct netdev_queue *dev_queue,
567 if (dev->tx_queue_len) {
568 qdisc = qdisc_create_dflt(dev, dev_queue,
569 &pfifo_fast_ops, TC_H_ROOT);
571 printk(KERN_INFO "%s: activation failed\n", dev->name);
575 qdisc = &noqueue_qdisc;
577 dev_queue->qdisc_sleeping = qdisc;
580 static void transition_one_qdisc(struct net_device *dev,
581 struct netdev_queue *dev_queue,
582 void *_need_watchdog)
584 struct Qdisc *new_qdisc = dev_queue->qdisc_sleeping;
585 int *need_watchdog_p = _need_watchdog;
587 if (!(new_qdisc->flags & TCQ_F_BUILTIN))
588 clear_bit(__QDISC_STATE_DEACTIVATED, &new_qdisc->state);
590 rcu_assign_pointer(dev_queue->qdisc, new_qdisc);
591 if (need_watchdog_p && new_qdisc != &noqueue_qdisc)
592 *need_watchdog_p = 1;
595 void dev_activate(struct net_device *dev)
599 /* No queueing discipline is attached to device;
600 create default one i.e. pfifo_fast for devices,
601 which need queueing and noqueue_qdisc for
605 if (dev_all_qdisc_sleeping_noop(dev))
606 netdev_for_each_tx_queue(dev, attach_one_default_qdisc, NULL);
608 if (!netif_carrier_ok(dev))
609 /* Delay activation until next carrier-on event */
613 netdev_for_each_tx_queue(dev, transition_one_qdisc, &need_watchdog);
614 transition_one_qdisc(dev, &dev->rx_queue, NULL);
617 dev->trans_start = jiffies;
618 dev_watchdog_up(dev);
622 static void dev_deactivate_queue(struct net_device *dev,
623 struct netdev_queue *dev_queue,
624 void *_qdisc_default)
626 struct Qdisc *qdisc_default = _qdisc_default;
629 qdisc = dev_queue->qdisc;
631 spin_lock_bh(qdisc_lock(qdisc));
633 if (!(qdisc->flags & TCQ_F_BUILTIN))
634 set_bit(__QDISC_STATE_DEACTIVATED, &qdisc->state);
636 rcu_assign_pointer(dev_queue->qdisc, qdisc_default);
639 spin_unlock_bh(qdisc_lock(qdisc));
643 static bool some_qdisc_is_busy(struct net_device *dev)
647 for (i = 0; i < dev->num_tx_queues; i++) {
648 struct netdev_queue *dev_queue;
649 spinlock_t *root_lock;
653 dev_queue = netdev_get_tx_queue(dev, i);
654 q = dev_queue->qdisc_sleeping;
655 root_lock = qdisc_lock(q);
657 spin_lock_bh(root_lock);
659 val = (test_bit(__QDISC_STATE_RUNNING, &q->state) ||
660 test_bit(__QDISC_STATE_SCHED, &q->state));
662 spin_unlock_bh(root_lock);
670 void dev_deactivate(struct net_device *dev)
672 netdev_for_each_tx_queue(dev, dev_deactivate_queue, &noop_qdisc);
673 dev_deactivate_queue(dev, &dev->rx_queue, &noop_qdisc);
675 dev_watchdog_down(dev);
677 /* Wait for outstanding qdisc-less dev_queue_xmit calls. */
680 /* Wait for outstanding qdisc_run calls. */
681 while (some_qdisc_is_busy(dev))
685 static void dev_init_scheduler_queue(struct net_device *dev,
686 struct netdev_queue *dev_queue,
689 struct Qdisc *qdisc = _qdisc;
691 dev_queue->qdisc = qdisc;
692 dev_queue->qdisc_sleeping = qdisc;
695 void dev_init_scheduler(struct net_device *dev)
697 netdev_for_each_tx_queue(dev, dev_init_scheduler_queue, &noop_qdisc);
698 dev_init_scheduler_queue(dev, &dev->rx_queue, &noop_qdisc);
700 setup_timer(&dev->watchdog_timer, dev_watchdog, (unsigned long)dev);
703 static void shutdown_scheduler_queue(struct net_device *dev,
704 struct netdev_queue *dev_queue,
705 void *_qdisc_default)
707 struct Qdisc *qdisc = dev_queue->qdisc_sleeping;
708 struct Qdisc *qdisc_default = _qdisc_default;
711 rcu_assign_pointer(dev_queue->qdisc, qdisc_default);
712 dev_queue->qdisc_sleeping = qdisc_default;
714 qdisc_destroy(qdisc);
718 void dev_shutdown(struct net_device *dev)
720 netdev_for_each_tx_queue(dev, shutdown_scheduler_queue, &noop_qdisc);
721 shutdown_scheduler_queue(dev, &dev->rx_queue, &noop_qdisc);
722 WARN_ON(timer_pending(&dev->watchdog_timer));