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 printk(KERN_INFO
"NETDEV WATCHDOG: %s (%s): transmit timed out\n",
219 dev
->name
, netdev_drivername(dev
, drivername
, 64));
220 dev
->tx_timeout(dev
);
223 if (!mod_timer(&dev
->watchdog_timer
,
224 round_jiffies(jiffies
+
225 dev
->watchdog_timeo
)))
229 netif_tx_unlock(dev
);
234 void __netdev_watchdog_up(struct net_device
*dev
)
236 if (dev
->tx_timeout
) {
237 if (dev
->watchdog_timeo
<= 0)
238 dev
->watchdog_timeo
= 5*HZ
;
239 if (!mod_timer(&dev
->watchdog_timer
,
240 round_jiffies(jiffies
+ dev
->watchdog_timeo
)))
245 static void dev_watchdog_up(struct net_device
*dev
)
247 __netdev_watchdog_up(dev
);
250 static void dev_watchdog_down(struct net_device
*dev
)
252 netif_tx_lock_bh(dev
);
253 if (del_timer(&dev
->watchdog_timer
))
255 netif_tx_unlock_bh(dev
);
259 * netif_carrier_on - set carrier
260 * @dev: network device
262 * Device has detected that carrier.
264 void netif_carrier_on(struct net_device
*dev
)
266 if (test_and_clear_bit(__LINK_STATE_NOCARRIER
, &dev
->state
)) {
267 linkwatch_fire_event(dev
);
268 if (netif_running(dev
))
269 __netdev_watchdog_up(dev
);
272 EXPORT_SYMBOL(netif_carrier_on
);
275 * netif_carrier_off - clear carrier
276 * @dev: network device
278 * Device has detected loss of carrier.
280 void netif_carrier_off(struct net_device
*dev
)
282 if (!test_and_set_bit(__LINK_STATE_NOCARRIER
, &dev
->state
))
283 linkwatch_fire_event(dev
);
285 EXPORT_SYMBOL(netif_carrier_off
);
287 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
288 under all circumstances. It is difficult to invent anything faster or
292 static int noop_enqueue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
298 static struct sk_buff
*noop_dequeue(struct Qdisc
* qdisc
)
303 static int noop_requeue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
306 printk(KERN_DEBUG
"%s deferred output. It is buggy.\n",
312 struct Qdisc_ops noop_qdisc_ops __read_mostly
= {
315 .enqueue
= noop_enqueue
,
316 .dequeue
= noop_dequeue
,
317 .requeue
= noop_requeue
,
318 .owner
= THIS_MODULE
,
321 static struct netdev_queue noop_netdev_queue
= {
322 .qdisc
= &noop_qdisc
,
325 struct Qdisc noop_qdisc
= {
326 .enqueue
= noop_enqueue
,
327 .dequeue
= noop_dequeue
,
328 .flags
= TCQ_F_BUILTIN
,
329 .ops
= &noop_qdisc_ops
,
330 .list
= LIST_HEAD_INIT(noop_qdisc
.list
),
331 .q
.lock
= __SPIN_LOCK_UNLOCKED(noop_qdisc
.q
.lock
),
332 .dev_queue
= &noop_netdev_queue
,
334 EXPORT_SYMBOL(noop_qdisc
);
336 static struct Qdisc_ops noqueue_qdisc_ops __read_mostly
= {
339 .enqueue
= noop_enqueue
,
340 .dequeue
= noop_dequeue
,
341 .requeue
= noop_requeue
,
342 .owner
= THIS_MODULE
,
345 static struct Qdisc noqueue_qdisc
;
346 static struct netdev_queue noqueue_netdev_queue
= {
347 .qdisc
= &noqueue_qdisc
,
350 static struct Qdisc noqueue_qdisc
= {
352 .dequeue
= noop_dequeue
,
353 .flags
= TCQ_F_BUILTIN
,
354 .ops
= &noqueue_qdisc_ops
,
355 .list
= LIST_HEAD_INIT(noqueue_qdisc
.list
),
356 .q
.lock
= __SPIN_LOCK_UNLOCKED(noqueue_qdisc
.q
.lock
),
357 .dev_queue
= &noqueue_netdev_queue
,
361 static const u8 prio2band
[TC_PRIO_MAX
+1] =
362 { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
364 /* 3-band FIFO queue: old style, but should be a bit faster than
365 generic prio+fifo combination.
368 #define PFIFO_FAST_BANDS 3
370 static inline struct sk_buff_head
*prio2list(struct sk_buff
*skb
,
373 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
374 return list
+ prio2band
[skb
->priority
& TC_PRIO_MAX
];
377 static int pfifo_fast_enqueue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
379 struct sk_buff_head
*list
= prio2list(skb
, qdisc
);
381 if (skb_queue_len(list
) < qdisc_dev(qdisc
)->tx_queue_len
) {
383 return __qdisc_enqueue_tail(skb
, qdisc
, list
);
386 return qdisc_drop(skb
, qdisc
);
389 static struct sk_buff
*pfifo_fast_dequeue(struct Qdisc
* qdisc
)
392 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
394 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++) {
395 if (!skb_queue_empty(list
+ prio
)) {
397 return __qdisc_dequeue_head(qdisc
, list
+ prio
);
404 static int pfifo_fast_requeue(struct sk_buff
*skb
, struct Qdisc
* qdisc
)
407 return __qdisc_requeue(skb
, qdisc
, prio2list(skb
, qdisc
));
410 static void pfifo_fast_reset(struct Qdisc
* qdisc
)
413 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
415 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++)
416 __qdisc_reset_queue(qdisc
, list
+ prio
);
418 qdisc
->qstats
.backlog
= 0;
422 static int pfifo_fast_dump(struct Qdisc
*qdisc
, struct sk_buff
*skb
)
424 struct tc_prio_qopt opt
= { .bands
= PFIFO_FAST_BANDS
};
426 memcpy(&opt
.priomap
, prio2band
, TC_PRIO_MAX
+1);
427 NLA_PUT(skb
, TCA_OPTIONS
, sizeof(opt
), &opt
);
434 static int pfifo_fast_init(struct Qdisc
*qdisc
, struct nlattr
*opt
)
437 struct sk_buff_head
*list
= qdisc_priv(qdisc
);
439 for (prio
= 0; prio
< PFIFO_FAST_BANDS
; prio
++)
440 skb_queue_head_init(list
+ prio
);
445 static struct Qdisc_ops pfifo_fast_ops __read_mostly
= {
447 .priv_size
= PFIFO_FAST_BANDS
* sizeof(struct sk_buff_head
),
448 .enqueue
= pfifo_fast_enqueue
,
449 .dequeue
= pfifo_fast_dequeue
,
450 .requeue
= pfifo_fast_requeue
,
451 .init
= pfifo_fast_init
,
452 .reset
= pfifo_fast_reset
,
453 .dump
= pfifo_fast_dump
,
454 .owner
= THIS_MODULE
,
457 struct Qdisc
*qdisc_alloc(struct netdev_queue
*dev_queue
,
458 struct Qdisc_ops
*ops
)
465 /* ensure that the Qdisc and the private data are 32-byte aligned */
466 size
= QDISC_ALIGN(sizeof(*sch
));
467 size
+= ops
->priv_size
+ (QDISC_ALIGNTO
- 1);
469 p
= kzalloc(size
, GFP_KERNEL
);
472 sch
= (struct Qdisc
*) QDISC_ALIGN((unsigned long) p
);
473 sch
->padded
= (char *) sch
- (char *) p
;
475 INIT_LIST_HEAD(&sch
->list
);
476 skb_queue_head_init(&sch
->q
);
478 sch
->enqueue
= ops
->enqueue
;
479 sch
->dequeue
= ops
->dequeue
;
480 sch
->dev_queue
= dev_queue
;
481 dev_hold(qdisc_dev(sch
));
482 atomic_set(&sch
->refcnt
, 1);
489 struct Qdisc
* qdisc_create_dflt(struct net_device
*dev
,
490 struct netdev_queue
*dev_queue
,
491 struct Qdisc_ops
*ops
,
492 unsigned int parentid
)
496 sch
= qdisc_alloc(dev_queue
, ops
);
499 sch
->parent
= parentid
;
501 if (!ops
->init
|| ops
->init(sch
, NULL
) == 0)
508 EXPORT_SYMBOL(qdisc_create_dflt
);
510 /* Under qdisc_lock(qdisc) and BH! */
512 void qdisc_reset(struct Qdisc
*qdisc
)
514 const struct Qdisc_ops
*ops
= qdisc
->ops
;
519 EXPORT_SYMBOL(qdisc_reset
);
521 /* this is the rcu callback function to clean up a qdisc when there
522 * are no further references to it */
524 static void __qdisc_destroy(struct rcu_head
*head
)
526 struct Qdisc
*qdisc
= container_of(head
, struct Qdisc
, q_rcu
);
527 const struct Qdisc_ops
*ops
= qdisc
->ops
;
529 #ifdef CONFIG_NET_SCHED
530 qdisc_put_stab(qdisc
->stab
);
532 gen_kill_estimator(&qdisc
->bstats
, &qdisc
->rate_est
);
538 module_put(ops
->owner
);
539 dev_put(qdisc_dev(qdisc
));
541 kfree_skb(qdisc
->gso_skb
);
543 kfree((char *) qdisc
- qdisc
->padded
);
546 /* Under qdisc_lock(qdisc) and BH! */
548 void qdisc_destroy(struct Qdisc
*qdisc
)
550 if (qdisc
->flags
& TCQ_F_BUILTIN
||
551 !atomic_dec_and_test(&qdisc
->refcnt
))
555 list_del(&qdisc
->list
);
557 call_rcu(&qdisc
->q_rcu
, __qdisc_destroy
);
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 rcu_assign_pointer(dev_queue
->qdisc
, new_qdisc
);
601 if (need_watchdog_p
&& new_qdisc
!= &noqueue_qdisc
)
602 *need_watchdog_p
= 1;
605 void dev_activate(struct net_device
*dev
)
609 /* No queueing discipline is attached to device;
610 create default one i.e. pfifo_fast for devices,
611 which need queueing and noqueue_qdisc for
615 if (dev_all_qdisc_sleeping_noop(dev
))
616 netdev_for_each_tx_queue(dev
, attach_one_default_qdisc
, NULL
);
618 if (!netif_carrier_ok(dev
))
619 /* Delay activation until next carrier-on event */
623 netdev_for_each_tx_queue(dev
, transition_one_qdisc
, &need_watchdog
);
624 transition_one_qdisc(dev
, &dev
->rx_queue
, NULL
);
627 dev
->trans_start
= jiffies
;
628 dev_watchdog_up(dev
);
632 static void dev_deactivate_queue(struct net_device
*dev
,
633 struct netdev_queue
*dev_queue
,
634 void *_qdisc_default
)
636 struct Qdisc
*qdisc_default
= _qdisc_default
;
639 qdisc
= dev_queue
->qdisc
;
641 spin_lock_bh(qdisc_lock(qdisc
));
643 dev_queue
->qdisc
= qdisc_default
;
646 spin_unlock_bh(qdisc_lock(qdisc
));
650 static bool some_qdisc_is_busy(struct net_device
*dev
, int lock
)
654 for (i
= 0; i
< dev
->num_tx_queues
; i
++) {
655 struct netdev_queue
*dev_queue
;
656 spinlock_t
*root_lock
;
660 dev_queue
= netdev_get_tx_queue(dev
, i
);
661 q
= dev_queue
->qdisc_sleeping
;
662 root_lock
= qdisc_lock(q
);
665 spin_lock_bh(root_lock
);
667 val
= (test_bit(__QDISC_STATE_RUNNING
, &q
->state
) ||
668 test_bit(__QDISC_STATE_SCHED
, &q
->state
));
671 spin_unlock_bh(root_lock
);
679 void dev_deactivate(struct net_device
*dev
)
683 netdev_for_each_tx_queue(dev
, dev_deactivate_queue
, &noop_qdisc
);
684 dev_deactivate_queue(dev
, &dev
->rx_queue
, &noop_qdisc
);
686 dev_watchdog_down(dev
);
688 /* Wait for outstanding qdisc-less dev_queue_xmit calls. */
691 /* Wait for outstanding qdisc_run calls. */
693 while (some_qdisc_is_busy(dev
, 0))
697 * Double-check inside queue lock to ensure that all effects
698 * of the queue run are visible when we return.
700 running
= some_qdisc_is_busy(dev
, 1);
703 * The running flag should never be set at this point because
704 * we've already set dev->qdisc to noop_qdisc *inside* the same
705 * pair of spin locks. That is, if any qdisc_run starts after
706 * our initial test it should see the noop_qdisc and then
707 * clear the RUNNING bit before dropping the queue lock. So
708 * if it is set here then we've found a bug.
710 } while (WARN_ON_ONCE(running
));
713 static void dev_init_scheduler_queue(struct net_device
*dev
,
714 struct netdev_queue
*dev_queue
,
717 struct Qdisc
*qdisc
= _qdisc
;
719 dev_queue
->qdisc
= qdisc
;
720 dev_queue
->qdisc_sleeping
= qdisc
;
723 void dev_init_scheduler(struct net_device
*dev
)
725 netdev_for_each_tx_queue(dev
, dev_init_scheduler_queue
, &noop_qdisc
);
726 dev_init_scheduler_queue(dev
, &dev
->rx_queue
, &noop_qdisc
);
728 setup_timer(&dev
->watchdog_timer
, dev_watchdog
, (unsigned long)dev
);
731 static void shutdown_scheduler_queue(struct net_device
*dev
,
732 struct netdev_queue
*dev_queue
,
733 void *_qdisc_default
)
735 struct Qdisc
*qdisc
= dev_queue
->qdisc_sleeping
;
736 struct Qdisc
*qdisc_default
= _qdisc_default
;
739 spinlock_t
*root_lock
= qdisc_lock(qdisc
);
741 dev_queue
->qdisc
= qdisc_default
;
742 dev_queue
->qdisc_sleeping
= qdisc_default
;
744 spin_lock_bh(root_lock
);
745 qdisc_destroy(qdisc
);
746 spin_unlock_bh(root_lock
);
750 void dev_shutdown(struct net_device
*dev
)
752 netdev_for_each_tx_queue(dev
, shutdown_scheduler_queue
, &noop_qdisc
);
753 shutdown_scheduler_queue(dev
, &dev
->rx_queue
, &noop_qdisc
);
754 WARN_ON(timer_pending(&dev
->watchdog_timer
));