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 * dev->queue_lock spinlock.
34 * The idea is the following:
35 * - enqueue, dequeue are serialized via top level device
36 * spinlock dev->queue_lock.
37 * - ingress filtering is serialized via top level device
38 * spinlock dev->ingress_lock.
39 * - updates to tree and tree walking are only done under the rtnl mutex.
42 void qdisc_lock_tree(struct net_device *dev)
44 spin_lock_bh(&dev->queue_lock);
45 spin_lock(&dev->ingress_lock);
48 void qdisc_unlock_tree(struct net_device *dev)
50 spin_unlock(&dev->ingress_lock);
51 spin_unlock_bh(&dev->queue_lock);
54 static inline int qdisc_qlen(struct Qdisc *q)
59 static inline int dev_requeue_skb(struct sk_buff *skb, struct net_device *dev,
62 if (unlikely(skb->next))
65 q->ops->requeue(skb, q);
71 static inline struct sk_buff *dev_dequeue_skb(struct net_device *dev,
76 if ((skb = dev->gso_skb))
84 static inline int handle_dev_cpu_collision(struct sk_buff *skb,
85 struct net_device *dev,
90 if (unlikely(dev->xmit_lock_owner == smp_processor_id())) {
92 * Same CPU holding the lock. It may be a transient
93 * configuration error, when hard_start_xmit() recurses. We
94 * detect it by checking xmit owner and drop the packet when
95 * deadloop is detected. Return OK to try the next skb.
99 printk(KERN_WARNING "Dead loop on netdevice %s, "
100 "fix it urgently!\n", dev->name);
104 * Another cpu is holding lock, requeue & delay xmits for
107 __get_cpu_var(netdev_rx_stat).cpu_collision++;
108 ret = dev_requeue_skb(skb, dev, q);
115 * NOTE: Called under dev->queue_lock with locally disabled BH.
117 * __LINK_STATE_QDISC_RUNNING guarantees only one CPU can process this
118 * device at a time. dev->queue_lock serializes queue accesses for
119 * this device AND dev->qdisc pointer itself.
121 * netif_tx_lock serializes accesses to device driver.
123 * dev->queue_lock and netif_tx_lock are mutually exclusive,
124 * if one is grabbed, another must be free.
126 * Note, that this procedure can be called by a watchdog timer
128 * Returns to the caller:
129 * 0 - queue is empty or throttled.
130 * >0 - queue is not empty.
133 static inline int qdisc_restart(struct net_device *dev)
135 struct Qdisc *q = dev->qdisc;
137 int ret = NETDEV_TX_BUSY;
140 if (unlikely((skb = dev_dequeue_skb(dev, q)) == NULL))
144 /* And release queue */
145 spin_unlock(&dev->queue_lock);
147 HARD_TX_LOCK(dev, smp_processor_id());
148 if (!netif_subqueue_stopped(dev, skb))
149 ret = dev_hard_start_xmit(skb, dev);
152 spin_lock(&dev->queue_lock);
157 /* Driver sent out skb successfully */
161 case NETDEV_TX_LOCKED:
162 /* Driver try lock failed */
163 ret = handle_dev_cpu_collision(skb, dev, q);
167 /* Driver returned NETDEV_TX_BUSY - requeue skb */
168 if (unlikely (ret != NETDEV_TX_BUSY && net_ratelimit()))
169 printk(KERN_WARNING "BUG %s code %d qlen %d\n",
170 dev->name, ret, q->q.qlen);
172 ret = dev_requeue_skb(skb, dev, q);
179 void __qdisc_run(struct net_device *dev)
182 if (!qdisc_restart(dev))
184 } while (!netif_queue_stopped(dev));
186 clear_bit(__LINK_STATE_QDISC_RUNNING, &dev->state);
189 static void dev_watchdog(unsigned long arg)
191 struct net_device *dev = (struct net_device *)arg;
194 if (dev->qdisc != &noop_qdisc) {
195 if (netif_device_present(dev) &&
196 netif_running(dev) &&
197 netif_carrier_ok(dev)) {
198 if (netif_queue_stopped(dev) &&
199 time_after(jiffies, dev->trans_start + dev->watchdog_timeo)) {
201 printk(KERN_INFO "NETDEV WATCHDOG: %s: transmit timed out\n",
203 dev->tx_timeout(dev);
205 if (!mod_timer(&dev->watchdog_timer, round_jiffies(jiffies + dev->watchdog_timeo)))
209 netif_tx_unlock(dev);
214 static void dev_watchdog_init(struct net_device *dev)
216 init_timer(&dev->watchdog_timer);
217 dev->watchdog_timer.data = (unsigned long)dev;
218 dev->watchdog_timer.function = dev_watchdog;
221 void __netdev_watchdog_up(struct net_device *dev)
223 if (dev->tx_timeout) {
224 if (dev->watchdog_timeo <= 0)
225 dev->watchdog_timeo = 5*HZ;
226 if (!mod_timer(&dev->watchdog_timer,
227 round_jiffies(jiffies + dev->watchdog_timeo)))
232 static void dev_watchdog_up(struct net_device *dev)
234 __netdev_watchdog_up(dev);
237 static void dev_watchdog_down(struct net_device *dev)
239 netif_tx_lock_bh(dev);
240 if (del_timer(&dev->watchdog_timer))
242 netif_tx_unlock_bh(dev);
246 * netif_carrier_on - set carrier
247 * @dev: network device
249 * Device has detected that carrier.
251 void netif_carrier_on(struct net_device *dev)
253 if (test_and_clear_bit(__LINK_STATE_NOCARRIER, &dev->state)) {
254 linkwatch_fire_event(dev);
255 if (netif_running(dev))
256 __netdev_watchdog_up(dev);
261 * netif_carrier_off - clear carrier
262 * @dev: network device
264 * Device has detected loss of carrier.
266 void netif_carrier_off(struct net_device *dev)
268 if (!test_and_set_bit(__LINK_STATE_NOCARRIER, &dev->state))
269 linkwatch_fire_event(dev);
272 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
273 under all circumstances. It is difficult to invent anything faster or
277 static int noop_enqueue(struct sk_buff *skb, struct Qdisc * qdisc)
283 static struct sk_buff *noop_dequeue(struct Qdisc * qdisc)
288 static int noop_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
291 printk(KERN_DEBUG "%s deferred output. It is buggy.\n",
297 struct Qdisc_ops noop_qdisc_ops = {
300 .enqueue = noop_enqueue,
301 .dequeue = noop_dequeue,
302 .requeue = noop_requeue,
303 .owner = THIS_MODULE,
306 struct Qdisc noop_qdisc = {
307 .enqueue = noop_enqueue,
308 .dequeue = noop_dequeue,
309 .flags = TCQ_F_BUILTIN,
310 .ops = &noop_qdisc_ops,
311 .list = LIST_HEAD_INIT(noop_qdisc.list),
314 static struct Qdisc_ops noqueue_qdisc_ops = {
317 .enqueue = noop_enqueue,
318 .dequeue = noop_dequeue,
319 .requeue = noop_requeue,
320 .owner = THIS_MODULE,
323 static struct Qdisc noqueue_qdisc = {
325 .dequeue = noop_dequeue,
326 .flags = TCQ_F_BUILTIN,
327 .ops = &noqueue_qdisc_ops,
328 .list = LIST_HEAD_INIT(noqueue_qdisc.list),
332 static const u8 prio2band[TC_PRIO_MAX+1] =
333 { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
335 /* 3-band FIFO queue: old style, but should be a bit faster than
336 generic prio+fifo combination.
339 #define PFIFO_FAST_BANDS 3
341 static inline struct sk_buff_head *prio2list(struct sk_buff *skb,
344 struct sk_buff_head *list = qdisc_priv(qdisc);
345 return list + prio2band[skb->priority & TC_PRIO_MAX];
348 static int pfifo_fast_enqueue(struct sk_buff *skb, struct Qdisc* qdisc)
350 struct sk_buff_head *list = prio2list(skb, qdisc);
352 if (skb_queue_len(list) < qdisc->dev->tx_queue_len) {
354 return __qdisc_enqueue_tail(skb, qdisc, list);
357 return qdisc_drop(skb, qdisc);
360 static struct sk_buff *pfifo_fast_dequeue(struct Qdisc* qdisc)
363 struct sk_buff_head *list = qdisc_priv(qdisc);
365 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++) {
366 if (!skb_queue_empty(list + prio)) {
368 return __qdisc_dequeue_head(qdisc, list + prio);
375 static int pfifo_fast_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
378 return __qdisc_requeue(skb, qdisc, prio2list(skb, qdisc));
381 static void pfifo_fast_reset(struct Qdisc* qdisc)
384 struct sk_buff_head *list = qdisc_priv(qdisc);
386 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
387 __qdisc_reset_queue(qdisc, list + prio);
389 qdisc->qstats.backlog = 0;
393 static int pfifo_fast_dump(struct Qdisc *qdisc, struct sk_buff *skb)
395 struct tc_prio_qopt opt = { .bands = PFIFO_FAST_BANDS };
397 memcpy(&opt.priomap, prio2band, TC_PRIO_MAX+1);
398 RTA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
405 static int pfifo_fast_init(struct Qdisc *qdisc, struct rtattr *opt)
408 struct sk_buff_head *list = qdisc_priv(qdisc);
410 for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
411 skb_queue_head_init(list + prio);
416 static struct Qdisc_ops pfifo_fast_ops = {
418 .priv_size = PFIFO_FAST_BANDS * sizeof(struct sk_buff_head),
419 .enqueue = pfifo_fast_enqueue,
420 .dequeue = pfifo_fast_dequeue,
421 .requeue = pfifo_fast_requeue,
422 .init = pfifo_fast_init,
423 .reset = pfifo_fast_reset,
424 .dump = pfifo_fast_dump,
425 .owner = THIS_MODULE,
428 struct Qdisc *qdisc_alloc(struct net_device *dev, struct Qdisc_ops *ops)
435 /* ensure that the Qdisc and the private data are 32-byte aligned */
436 size = QDISC_ALIGN(sizeof(*sch));
437 size += ops->priv_size + (QDISC_ALIGNTO - 1);
439 p = kzalloc(size, GFP_KERNEL);
442 sch = (struct Qdisc *) QDISC_ALIGN((unsigned long) p);
443 sch->padded = (char *) sch - (char *) p;
445 INIT_LIST_HEAD(&sch->list);
446 skb_queue_head_init(&sch->q);
448 sch->enqueue = ops->enqueue;
449 sch->dequeue = ops->dequeue;
452 atomic_set(&sch->refcnt, 1);
456 return ERR_PTR(-err);
459 struct Qdisc * qdisc_create_dflt(struct net_device *dev, struct Qdisc_ops *ops,
460 unsigned int parentid)
464 sch = qdisc_alloc(dev, ops);
467 sch->stats_lock = &dev->queue_lock;
468 sch->parent = parentid;
470 if (!ops->init || ops->init(sch, NULL) == 0)
478 /* Under dev->queue_lock and BH! */
480 void qdisc_reset(struct Qdisc *qdisc)
482 struct Qdisc_ops *ops = qdisc->ops;
488 /* this is the rcu callback function to clean up a qdisc when there
489 * are no further references to it */
491 static void __qdisc_destroy(struct rcu_head *head)
493 struct Qdisc *qdisc = container_of(head, struct Qdisc, q_rcu);
494 kfree((char *) qdisc - qdisc->padded);
497 /* Under dev->queue_lock and BH! */
499 void qdisc_destroy(struct Qdisc *qdisc)
501 struct Qdisc_ops *ops = qdisc->ops;
503 if (qdisc->flags & TCQ_F_BUILTIN ||
504 !atomic_dec_and_test(&qdisc->refcnt))
507 list_del(&qdisc->list);
508 gen_kill_estimator(&qdisc->bstats, &qdisc->rate_est);
514 module_put(ops->owner);
516 call_rcu(&qdisc->q_rcu, __qdisc_destroy);
519 void dev_activate(struct net_device *dev)
521 /* No queueing discipline is attached to device;
522 create default one i.e. pfifo_fast for devices,
523 which need queueing and noqueue_qdisc for
527 if (dev->qdisc_sleeping == &noop_qdisc) {
529 if (dev->tx_queue_len) {
530 qdisc = qdisc_create_dflt(dev, &pfifo_fast_ops,
533 printk(KERN_INFO "%s: activation failed\n", dev->name);
536 list_add_tail(&qdisc->list, &dev->qdisc_list);
538 qdisc = &noqueue_qdisc;
540 dev->qdisc_sleeping = qdisc;
543 if (!netif_carrier_ok(dev))
544 /* Delay activation until next carrier-on event */
547 spin_lock_bh(&dev->queue_lock);
548 rcu_assign_pointer(dev->qdisc, dev->qdisc_sleeping);
549 if (dev->qdisc != &noqueue_qdisc) {
550 dev->trans_start = jiffies;
551 dev_watchdog_up(dev);
553 spin_unlock_bh(&dev->queue_lock);
556 void dev_deactivate(struct net_device *dev)
562 spin_lock_bh(&dev->queue_lock);
564 dev->qdisc = &noop_qdisc;
570 spin_unlock_bh(&dev->queue_lock);
574 dev_watchdog_down(dev);
576 /* Wait for outstanding qdisc-less dev_queue_xmit calls. */
579 /* Wait for outstanding qdisc_run calls. */
581 while (test_bit(__LINK_STATE_QDISC_RUNNING, &dev->state))
585 * Double-check inside queue lock to ensure that all effects
586 * of the queue run are visible when we return.
588 spin_lock_bh(&dev->queue_lock);
589 running = test_bit(__LINK_STATE_QDISC_RUNNING, &dev->state);
590 spin_unlock_bh(&dev->queue_lock);
593 * The running flag should never be set at this point because
594 * we've already set dev->qdisc to noop_qdisc *inside* the same
595 * pair of spin locks. That is, if any qdisc_run starts after
596 * our initial test it should see the noop_qdisc and then
597 * clear the RUNNING bit before dropping the queue lock. So
598 * if it is set here then we've found a bug.
600 } while (WARN_ON_ONCE(running));
603 void dev_init_scheduler(struct net_device *dev)
605 qdisc_lock_tree(dev);
606 dev->qdisc = &noop_qdisc;
607 dev->qdisc_sleeping = &noop_qdisc;
608 INIT_LIST_HEAD(&dev->qdisc_list);
609 qdisc_unlock_tree(dev);
611 dev_watchdog_init(dev);
614 void dev_shutdown(struct net_device *dev)
618 qdisc_lock_tree(dev);
619 qdisc = dev->qdisc_sleeping;
620 dev->qdisc = &noop_qdisc;
621 dev->qdisc_sleeping = &noop_qdisc;
622 qdisc_destroy(qdisc);
623 #if defined(CONFIG_NET_SCH_INGRESS) || defined(CONFIG_NET_SCH_INGRESS_MODULE)
624 if ((qdisc = dev->qdisc_ingress) != NULL) {
625 dev->qdisc_ingress = NULL;
626 qdisc_destroy(qdisc);
629 BUG_TRAP(!timer_pending(&dev->watchdog_timer));
630 qdisc_unlock_tree(dev);
633 EXPORT_SYMBOL(netif_carrier_on);
634 EXPORT_SYMBOL(netif_carrier_off);
635 EXPORT_SYMBOL(noop_qdisc);
636 EXPORT_SYMBOL(qdisc_create_dflt);
637 EXPORT_SYMBOL(qdisc_destroy);
638 EXPORT_SYMBOL(qdisc_reset);
639 EXPORT_SYMBOL(qdisc_lock_tree);
640 EXPORT_SYMBOL(qdisc_unlock_tree);