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 <asm/uaccess.h>
15 #include <asm/system.h>
16 #include <linux/bitops.h>
17 #include <linux/module.h>
18 #include <linux/types.h>
19 #include <linux/kernel.h>
20 #include <linux/sched.h>
21 #include <linux/string.h>
23 #include <linux/socket.h>
24 #include <linux/sockios.h>
26 #include <linux/errno.h>
27 #include <linux/interrupt.h>
28 #include <linux/netdevice.h>
29 #include <linux/skbuff.h>
30 #include <linux/rtnetlink.h>
31 #include <linux/init.h>
32 #include <linux/rcupdate.h>
33 #include <linux/list.h>
35 #include <net/pkt_sched.h>
37 /* Main transmission queue. */
39 /* Modifications to data participating in scheduling must be protected with
40 * dev->queue_lock spinlock.
42 * The idea is the following:
43 * - enqueue, dequeue are serialized via top level device
44 * spinlock dev->queue_lock.
45 * - ingress filtering is serialized via top level device
46 * spinlock dev->ingress_lock.
47 * - updates to tree and tree walking are only done under the rtnl mutex.
50 void qdisc_lock_tree(struct net_device
*dev
)
52 spin_lock_bh(&dev
->queue_lock
);
53 spin_lock(&dev
->ingress_lock
);
56 void qdisc_unlock_tree(struct net_device
*dev
)
58 spin_unlock(&dev
->ingress_lock
);
59 spin_unlock_bh(&dev
->queue_lock
);
63 dev->queue_lock serializes queue accesses for this device
64 AND dev->qdisc pointer itself.
66 netif_tx_lock serializes accesses to device driver.
68 dev->queue_lock and netif_tx_lock are mutually exclusive,
69 if one is grabbed, another must be free.
74 Note, that this procedure can be called by a watchdog timer, so that
75 we do not check dev->tbusy flag here.
77 Returns: 0 - queue is empty.
78 >0 - queue is not empty, but throttled.
79 <0 - queue is not empty. Device is throttled, if dev->tbusy != 0.
81 NOTE: Called under dev->queue_lock with locally disabled BH.
84 static inline int qdisc_restart(struct net_device
*dev
)
86 struct Qdisc
*q
= dev
->qdisc
;
90 if (((skb
= dev
->gso_skb
)) || ((skb
= q
->dequeue(q
)))) {
91 unsigned nolock
= (dev
->features
& NETIF_F_LLTX
);
96 * When the driver has LLTX set it does its own locking
97 * in start_xmit. No need to add additional overhead by
98 * locking again. These checks are worth it because
99 * even uncongested locks can be quite expensive.
100 * The driver can do trylock like here too, in case
101 * of lock congestion it should return -1 and the packet
105 if (!netif_tx_trylock(dev
)) {
107 /* So, someone grabbed the driver. */
109 /* It may be transient configuration error,
110 when hard_start_xmit() recurses. We detect
111 it by checking xmit owner and drop the
112 packet when deadloop is detected.
114 if (dev
->xmit_lock_owner
== smp_processor_id()) {
117 printk(KERN_DEBUG
"Dead loop on netdevice %s, fix it urgently!\n", dev
->name
);
120 __get_cpu_var(netdev_rx_stat
).cpu_collision
++;
126 /* And release queue */
127 spin_unlock(&dev
->queue_lock
);
129 if (!netif_queue_stopped(dev
)) {
132 ret
= dev_hard_start_xmit(skb
, dev
);
133 if (ret
== NETDEV_TX_OK
) {
135 netif_tx_unlock(dev
);
137 spin_lock(&dev
->queue_lock
);
140 if (ret
== NETDEV_TX_LOCKED
&& nolock
) {
141 spin_lock(&dev
->queue_lock
);
146 /* NETDEV_TX_BUSY - we need to requeue */
147 /* Release the driver */
149 netif_tx_unlock(dev
);
151 spin_lock(&dev
->queue_lock
);
155 /* Device kicked us out :(
156 This is possible in three cases:
159 1. fastroute is enabled
160 2. device cannot determine busy state
161 before start of transmission (f.e. dialout)
162 3. device is buggy (ppp)
169 q
->ops
->requeue(skb
, q
);
173 BUG_ON((int) q
->q
.qlen
< 0);
177 void __qdisc_run(struct net_device
*dev
)
179 if (unlikely(dev
->qdisc
== &noop_qdisc
))
182 while (qdisc_restart(dev
) < 0 && !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
, jiffies
+ dev
->watchdog_timeo
))
231 static void dev_watchdog_up(struct net_device
*dev
)
233 __netdev_watchdog_up(dev
);
236 static void dev_watchdog_down(struct net_device
*dev
)
238 netif_tx_lock_bh(dev
);
239 if (del_timer(&dev
->watchdog_timer
))
241 netif_tx_unlock_bh(dev
);
244 void netif_carrier_on(struct net_device
*dev
)
246 if (test_and_clear_bit(__LINK_STATE_NOCARRIER
, &dev
->state
))
247 linkwatch_fire_event(dev
);
248 if (netif_running(dev
))
249 __netdev_watchdog_up(dev
);
252 void netif_carrier_off(struct net_device
*dev
)
254 if (!test_and_set_bit(__LINK_STATE_NOCARRIER
, &dev
->state
))
255 linkwatch_fire_event(dev
);
258 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
259 under all circumstances. It is difficult to invent anything faster or
263 static int noop_enqueue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
269 static struct sk_buff
*noop_dequeue(struct Qdisc
* qdisc
)
274 static int noop_requeue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
277 printk(KERN_DEBUG
"%s deferred output. It is buggy.\n",
283 struct Qdisc_ops noop_qdisc_ops
= {
286 .enqueue
= noop_enqueue
,
287 .dequeue
= noop_dequeue
,
288 .requeue
= noop_requeue
,
289 .owner
= THIS_MODULE
,
292 struct Qdisc noop_qdisc
= {
293 .enqueue
= noop_enqueue
,
294 .dequeue
= noop_dequeue
,
295 .flags
= TCQ_F_BUILTIN
,
296 .ops
= &noop_qdisc_ops
,
297 .list
= LIST_HEAD_INIT(noop_qdisc
.list
),
300 static struct Qdisc_ops noqueue_qdisc_ops
= {
303 .enqueue
= noop_enqueue
,
304 .dequeue
= noop_dequeue
,
305 .requeue
= noop_requeue
,
306 .owner
= THIS_MODULE
,
309 static struct Qdisc noqueue_qdisc
= {
311 .dequeue
= noop_dequeue
,
312 .flags
= TCQ_F_BUILTIN
,
313 .ops
= &noqueue_qdisc_ops
,
314 .list
= LIST_HEAD_INIT(noqueue_qdisc
.list
),
318 static const u8 prio2band
[TC_PRIO_MAX
+1] =
319 { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
321 /* 3-band FIFO queue: old style, but should be a bit faster than
322 generic prio+fifo combination.
325 #define PFIFO_FAST_BANDS 3
327 static inline struct sk_buff_head
*prio2list(struct sk_buff
*skb
,
330 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
331 return list
+ prio2band
[skb
->priority
& TC_PRIO_MAX
];
334 static int pfifo_fast_enqueue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
336 struct sk_buff_head
*list
= prio2list(skb
, qdisc
);
338 if (skb_queue_len(list
) < qdisc
->dev
->tx_queue_len
) {
340 return __qdisc_enqueue_tail(skb
, qdisc
, list
);
343 return qdisc_drop(skb
, qdisc
);
346 static struct sk_buff
*pfifo_fast_dequeue(struct Qdisc
* qdisc
)
349 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
351 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++) {
352 if (!skb_queue_empty(list
+ prio
)) {
354 return __qdisc_dequeue_head(qdisc
, list
+ prio
);
361 static int pfifo_fast_requeue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
364 return __qdisc_requeue(skb
, qdisc
, prio2list(skb
, qdisc
));
367 static void pfifo_fast_reset(struct Qdisc
* qdisc
)
370 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
372 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++)
373 __qdisc_reset_queue(qdisc
, list
+ prio
);
375 qdisc
->qstats
.backlog
= 0;
379 static int pfifo_fast_dump(struct Qdisc
*qdisc
, struct sk_buff
*skb
)
381 struct tc_prio_qopt opt
= { .bands
= PFIFO_FAST_BANDS
};
383 memcpy(&opt
.priomap
, prio2band
, TC_PRIO_MAX
+1);
384 RTA_PUT(skb
, TCA_OPTIONS
, sizeof(opt
), &opt
);
391 static int pfifo_fast_init(struct Qdisc
*qdisc
, struct rtattr
*opt
)
394 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
396 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++)
397 skb_queue_head_init(list
+ prio
);
402 static struct Qdisc_ops pfifo_fast_ops
= {
404 .priv_size
= PFIFO_FAST_BANDS
* sizeof(struct sk_buff_head
),
405 .enqueue
= pfifo_fast_enqueue
,
406 .dequeue
= pfifo_fast_dequeue
,
407 .requeue
= pfifo_fast_requeue
,
408 .init
= pfifo_fast_init
,
409 .reset
= pfifo_fast_reset
,
410 .dump
= pfifo_fast_dump
,
411 .owner
= THIS_MODULE
,
414 struct Qdisc
*qdisc_alloc(struct net_device
*dev
, struct Qdisc_ops
*ops
)
421 /* ensure that the Qdisc and the private data are 32-byte aligned */
422 size
= QDISC_ALIGN(sizeof(*sch
));
423 size
+= ops
->priv_size
+ (QDISC_ALIGNTO
- 1);
425 p
= kzalloc(size
, GFP_KERNEL
);
428 sch
= (struct Qdisc
*) QDISC_ALIGN((unsigned long) p
);
429 sch
->padded
= (char *) sch
- (char *) p
;
431 INIT_LIST_HEAD(&sch
->list
);
432 skb_queue_head_init(&sch
->q
);
434 sch
->enqueue
= ops
->enqueue
;
435 sch
->dequeue
= ops
->dequeue
;
438 atomic_set(&sch
->refcnt
, 1);
442 return ERR_PTR(-err
);
445 struct Qdisc
* qdisc_create_dflt(struct net_device
*dev
, struct Qdisc_ops
*ops
,
446 unsigned int parentid
)
450 sch
= qdisc_alloc(dev
, ops
);
453 sch
->stats_lock
= &dev
->queue_lock
;
454 sch
->parent
= parentid
;
456 if (!ops
->init
|| ops
->init(sch
, NULL
) == 0)
464 /* Under dev->queue_lock and BH! */
466 void qdisc_reset(struct Qdisc
*qdisc
)
468 struct Qdisc_ops
*ops
= qdisc
->ops
;
474 /* this is the rcu callback function to clean up a qdisc when there
475 * are no further references to it */
477 static void __qdisc_destroy(struct rcu_head
*head
)
479 struct Qdisc
*qdisc
= container_of(head
, struct Qdisc
, q_rcu
);
480 kfree((char *) qdisc
- qdisc
->padded
);
483 /* Under dev->queue_lock and BH! */
485 void qdisc_destroy(struct Qdisc
*qdisc
)
487 struct Qdisc_ops
*ops
= qdisc
->ops
;
489 if (qdisc
->flags
& TCQ_F_BUILTIN
||
490 !atomic_dec_and_test(&qdisc
->refcnt
))
493 list_del(&qdisc
->list
);
494 #ifdef CONFIG_NET_ESTIMATOR
495 gen_kill_estimator(&qdisc
->bstats
, &qdisc
->rate_est
);
502 module_put(ops
->owner
);
504 call_rcu(&qdisc
->q_rcu
, __qdisc_destroy
);
507 void dev_activate(struct net_device
*dev
)
509 /* No queueing discipline is attached to device;
510 create default one i.e. pfifo_fast for devices,
511 which need queueing and noqueue_qdisc for
515 if (dev
->qdisc_sleeping
== &noop_qdisc
) {
517 if (dev
->tx_queue_len
) {
518 qdisc
= qdisc_create_dflt(dev
, &pfifo_fast_ops
,
521 printk(KERN_INFO
"%s: activation failed\n", dev
->name
);
524 list_add_tail(&qdisc
->list
, &dev
->qdisc_list
);
526 qdisc
= &noqueue_qdisc
;
528 dev
->qdisc_sleeping
= qdisc
;
531 if (!netif_carrier_ok(dev
))
532 /* Delay activation until next carrier-on event */
535 spin_lock_bh(&dev
->queue_lock
);
536 rcu_assign_pointer(dev
->qdisc
, dev
->qdisc_sleeping
);
537 if (dev
->qdisc
!= &noqueue_qdisc
) {
538 dev
->trans_start
= jiffies
;
539 dev_watchdog_up(dev
);
541 spin_unlock_bh(&dev
->queue_lock
);
544 void dev_deactivate(struct net_device
*dev
)
548 spin_lock_bh(&dev
->queue_lock
);
550 dev
->qdisc
= &noop_qdisc
;
554 spin_unlock_bh(&dev
->queue_lock
);
556 dev_watchdog_down(dev
);
558 /* Wait for outstanding dev_queue_xmit calls. */
561 /* Wait for outstanding qdisc_run calls. */
562 while (test_bit(__LINK_STATE_QDISC_RUNNING
, &dev
->state
))
566 kfree_skb(dev
->gso_skb
);
571 void dev_init_scheduler(struct net_device
*dev
)
573 qdisc_lock_tree(dev
);
574 dev
->qdisc
= &noop_qdisc
;
575 dev
->qdisc_sleeping
= &noop_qdisc
;
576 INIT_LIST_HEAD(&dev
->qdisc_list
);
577 qdisc_unlock_tree(dev
);
579 dev_watchdog_init(dev
);
582 void dev_shutdown(struct net_device
*dev
)
586 qdisc_lock_tree(dev
);
587 qdisc
= dev
->qdisc_sleeping
;
588 dev
->qdisc
= &noop_qdisc
;
589 dev
->qdisc_sleeping
= &noop_qdisc
;
590 qdisc_destroy(qdisc
);
591 #if defined(CONFIG_NET_SCH_INGRESS) || defined(CONFIG_NET_SCH_INGRESS_MODULE)
592 if ((qdisc
= dev
->qdisc_ingress
) != NULL
) {
593 dev
->qdisc_ingress
= NULL
;
594 qdisc_destroy(qdisc
);
597 BUG_TRAP(!timer_pending(&dev
->watchdog_timer
));
598 qdisc_unlock_tree(dev
);
601 EXPORT_SYMBOL(netif_carrier_on
);
602 EXPORT_SYMBOL(netif_carrier_off
);
603 EXPORT_SYMBOL(noop_qdisc
);
604 EXPORT_SYMBOL(qdisc_create_dflt
);
605 EXPORT_SYMBOL(qdisc_destroy
);
606 EXPORT_SYMBOL(qdisc_reset
);
607 EXPORT_SYMBOL(qdisc_lock_tree
);
608 EXPORT_SYMBOL(qdisc_unlock_tree
);