Merge git://git.kernel.org/pub/scm/linux/kernel/git/paulus/powerpc
[linux-2.6] / net / sched / sch_generic.c
1 /*
2  * net/sched/sch_generic.c      Generic packet scheduler routines.
3  *
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.
8  *
9  * Authors:     Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
10  *              Jamal Hadi Salim, <hadi@cyberus.ca> 990601
11  *              - Ingress support
12  */
13
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>
28
29 /* Main transmission queue. */
30
31 /* Modifications to data participating in scheduling must be protected with
32  * dev->queue_lock spinlock.
33  *
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.
40  */
41
42 void qdisc_lock_tree(struct net_device *dev)
43         __acquires(dev->queue_lock)
44         __acquires(dev->ingress_lock)
45 {
46         spin_lock_bh(&dev->queue_lock);
47         spin_lock(&dev->ingress_lock);
48 }
49 EXPORT_SYMBOL(qdisc_lock_tree);
50
51 void qdisc_unlock_tree(struct net_device *dev)
52         __releases(dev->ingress_lock)
53         __releases(dev->queue_lock)
54 {
55         spin_unlock(&dev->ingress_lock);
56         spin_unlock_bh(&dev->queue_lock);
57 }
58 EXPORT_SYMBOL(qdisc_unlock_tree);
59
60 static inline int qdisc_qlen(struct Qdisc *q)
61 {
62         return q->q.qlen;
63 }
64
65 static inline int dev_requeue_skb(struct sk_buff *skb, struct net_device *dev,
66                                   struct Qdisc *q)
67 {
68         if (unlikely(skb->next))
69                 dev->gso_skb = skb;
70         else
71                 q->ops->requeue(skb, q);
72
73         netif_schedule(dev);
74         return 0;
75 }
76
77 static inline struct sk_buff *dev_dequeue_skb(struct net_device *dev,
78                                               struct Qdisc *q)
79 {
80         struct sk_buff *skb;
81
82         if ((skb = dev->gso_skb))
83                 dev->gso_skb = NULL;
84         else
85                 skb = q->dequeue(q);
86
87         return skb;
88 }
89
90 static inline int handle_dev_cpu_collision(struct sk_buff *skb,
91                                            struct net_device *dev,
92                                            struct Qdisc *q)
93 {
94         int ret;
95
96         if (unlikely(dev->xmit_lock_owner == smp_processor_id())) {
97                 /*
98                  * Same CPU holding the lock. It may be a transient
99                  * configuration error, when hard_start_xmit() recurses. We
100                  * detect it by checking xmit owner and drop the packet when
101                  * deadloop is detected. Return OK to try the next skb.
102                  */
103                 kfree_skb(skb);
104                 if (net_ratelimit())
105                         printk(KERN_WARNING "Dead loop on netdevice %s, "
106                                "fix it urgently!\n", dev->name);
107                 ret = qdisc_qlen(q);
108         } else {
109                 /*
110                  * Another cpu is holding lock, requeue & delay xmits for
111                  * some time.
112                  */
113                 __get_cpu_var(netdev_rx_stat).cpu_collision++;
114                 ret = dev_requeue_skb(skb, dev, q);
115         }
116
117         return ret;
118 }
119
120 /*
121  * NOTE: Called under dev->queue_lock with locally disabled BH.
122  *
123  * __LINK_STATE_QDISC_RUNNING guarantees only one CPU can process this
124  * device at a time. dev->queue_lock serializes queue accesses for
125  * this device AND dev->qdisc pointer itself.
126  *
127  *  netif_tx_lock serializes accesses to device driver.
128  *
129  *  dev->queue_lock and netif_tx_lock are mutually exclusive,
130  *  if one is grabbed, another must be free.
131  *
132  * Note, that this procedure can be called by a watchdog timer
133  *
134  * Returns to the caller:
135  *                              0  - queue is empty or throttled.
136  *                              >0 - queue is not empty.
137  *
138  */
139 static inline int qdisc_restart(struct net_device *dev)
140 {
141         struct Qdisc *q = dev->qdisc;
142         struct sk_buff *skb;
143         int ret = NETDEV_TX_BUSY;
144
145         /* Dequeue packet */
146         if (unlikely((skb = dev_dequeue_skb(dev, q)) == NULL))
147                 return 0;
148
149
150         /* And release queue */
151         spin_unlock(&dev->queue_lock);
152
153         HARD_TX_LOCK(dev, smp_processor_id());
154         if (!netif_subqueue_stopped(dev, skb))
155                 ret = dev_hard_start_xmit(skb, dev);
156         HARD_TX_UNLOCK(dev);
157
158         spin_lock(&dev->queue_lock);
159         q = dev->qdisc;
160
161         switch (ret) {
162         case NETDEV_TX_OK:
163                 /* Driver sent out skb successfully */
164                 ret = qdisc_qlen(q);
165                 break;
166
167         case NETDEV_TX_LOCKED:
168                 /* Driver try lock failed */
169                 ret = handle_dev_cpu_collision(skb, dev, q);
170                 break;
171
172         default:
173                 /* Driver returned NETDEV_TX_BUSY - requeue skb */
174                 if (unlikely (ret != NETDEV_TX_BUSY && net_ratelimit()))
175                         printk(KERN_WARNING "BUG %s code %d qlen %d\n",
176                                dev->name, ret, q->q.qlen);
177
178                 ret = dev_requeue_skb(skb, dev, q);
179                 break;
180         }
181
182         return ret;
183 }
184
185 void __qdisc_run(struct net_device *dev)
186 {
187         unsigned long start_time = jiffies;
188
189         while (qdisc_restart(dev)) {
190                 if (netif_queue_stopped(dev))
191                         break;
192
193                 /*
194                  * Postpone processing if
195                  * 1. another process needs the CPU;
196                  * 2. we've been doing it for too long.
197                  */
198                 if (need_resched() || jiffies != start_time) {
199                         netif_schedule(dev);
200                         break;
201                 }
202         }
203
204         clear_bit(__LINK_STATE_QDISC_RUNNING, &dev->state);
205 }
206
207 static void dev_watchdog(unsigned long arg)
208 {
209         struct net_device *dev = (struct net_device *)arg;
210
211         netif_tx_lock(dev);
212         if (dev->qdisc != &noop_qdisc) {
213                 if (netif_device_present(dev) &&
214                     netif_running(dev) &&
215                     netif_carrier_ok(dev)) {
216                         if (netif_queue_stopped(dev) &&
217                             time_after(jiffies, dev->trans_start + dev->watchdog_timeo)) {
218
219                                 printk(KERN_INFO "NETDEV WATCHDOG: %s: transmit timed out\n",
220                                        dev->name);
221                                 dev->tx_timeout(dev);
222                         }
223                         if (!mod_timer(&dev->watchdog_timer, round_jiffies(jiffies + dev->watchdog_timeo)))
224                                 dev_hold(dev);
225                 }
226         }
227         netif_tx_unlock(dev);
228
229         dev_put(dev);
230 }
231
232 void __netdev_watchdog_up(struct net_device *dev)
233 {
234         if (dev->tx_timeout) {
235                 if (dev->watchdog_timeo <= 0)
236                         dev->watchdog_timeo = 5*HZ;
237                 if (!mod_timer(&dev->watchdog_timer,
238                                round_jiffies(jiffies + dev->watchdog_timeo)))
239                         dev_hold(dev);
240         }
241 }
242
243 static void dev_watchdog_up(struct net_device *dev)
244 {
245         __netdev_watchdog_up(dev);
246 }
247
248 static void dev_watchdog_down(struct net_device *dev)
249 {
250         netif_tx_lock_bh(dev);
251         if (del_timer(&dev->watchdog_timer))
252                 dev_put(dev);
253         netif_tx_unlock_bh(dev);
254 }
255
256 /**
257  *      netif_carrier_on - set carrier
258  *      @dev: network device
259  *
260  * Device has detected that carrier.
261  */
262 void netif_carrier_on(struct net_device *dev)
263 {
264         if (test_and_clear_bit(__LINK_STATE_NOCARRIER, &dev->state)) {
265                 linkwatch_fire_event(dev);
266                 if (netif_running(dev))
267                         __netdev_watchdog_up(dev);
268         }
269 }
270 EXPORT_SYMBOL(netif_carrier_on);
271
272 /**
273  *      netif_carrier_off - clear carrier
274  *      @dev: network device
275  *
276  * Device has detected loss of carrier.
277  */
278 void netif_carrier_off(struct net_device *dev)
279 {
280         if (!test_and_set_bit(__LINK_STATE_NOCARRIER, &dev->state))
281                 linkwatch_fire_event(dev);
282 }
283 EXPORT_SYMBOL(netif_carrier_off);
284
285 /* "NOOP" scheduler: the best scheduler, recommended for all interfaces
286    under all circumstances. It is difficult to invent anything faster or
287    cheaper.
288  */
289
290 static int noop_enqueue(struct sk_buff *skb, struct Qdisc * qdisc)
291 {
292         kfree_skb(skb);
293         return NET_XMIT_CN;
294 }
295
296 static struct sk_buff *noop_dequeue(struct Qdisc * qdisc)
297 {
298         return NULL;
299 }
300
301 static int noop_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
302 {
303         if (net_ratelimit())
304                 printk(KERN_DEBUG "%s deferred output. It is buggy.\n",
305                        skb->dev->name);
306         kfree_skb(skb);
307         return NET_XMIT_CN;
308 }
309
310 struct Qdisc_ops noop_qdisc_ops __read_mostly = {
311         .id             =       "noop",
312         .priv_size      =       0,
313         .enqueue        =       noop_enqueue,
314         .dequeue        =       noop_dequeue,
315         .requeue        =       noop_requeue,
316         .owner          =       THIS_MODULE,
317 };
318
319 struct Qdisc noop_qdisc = {
320         .enqueue        =       noop_enqueue,
321         .dequeue        =       noop_dequeue,
322         .flags          =       TCQ_F_BUILTIN,
323         .ops            =       &noop_qdisc_ops,
324         .list           =       LIST_HEAD_INIT(noop_qdisc.list),
325 };
326 EXPORT_SYMBOL(noop_qdisc);
327
328 static struct Qdisc_ops noqueue_qdisc_ops __read_mostly = {
329         .id             =       "noqueue",
330         .priv_size      =       0,
331         .enqueue        =       noop_enqueue,
332         .dequeue        =       noop_dequeue,
333         .requeue        =       noop_requeue,
334         .owner          =       THIS_MODULE,
335 };
336
337 static struct Qdisc noqueue_qdisc = {
338         .enqueue        =       NULL,
339         .dequeue        =       noop_dequeue,
340         .flags          =       TCQ_F_BUILTIN,
341         .ops            =       &noqueue_qdisc_ops,
342         .list           =       LIST_HEAD_INIT(noqueue_qdisc.list),
343 };
344
345
346 static const u8 prio2band[TC_PRIO_MAX+1] =
347         { 1, 2, 2, 2, 1, 2, 0, 0 , 1, 1, 1, 1, 1, 1, 1, 1 };
348
349 /* 3-band FIFO queue: old style, but should be a bit faster than
350    generic prio+fifo combination.
351  */
352
353 #define PFIFO_FAST_BANDS 3
354
355 static inline struct sk_buff_head *prio2list(struct sk_buff *skb,
356                                              struct Qdisc *qdisc)
357 {
358         struct sk_buff_head *list = qdisc_priv(qdisc);
359         return list + prio2band[skb->priority & TC_PRIO_MAX];
360 }
361
362 static int pfifo_fast_enqueue(struct sk_buff *skb, struct Qdisc* qdisc)
363 {
364         struct sk_buff_head *list = prio2list(skb, qdisc);
365
366         if (skb_queue_len(list) < qdisc->dev->tx_queue_len) {
367                 qdisc->q.qlen++;
368                 return __qdisc_enqueue_tail(skb, qdisc, list);
369         }
370
371         return qdisc_drop(skb, qdisc);
372 }
373
374 static struct sk_buff *pfifo_fast_dequeue(struct Qdisc* qdisc)
375 {
376         int prio;
377         struct sk_buff_head *list = qdisc_priv(qdisc);
378
379         for (prio = 0; prio < PFIFO_FAST_BANDS; prio++) {
380                 if (!skb_queue_empty(list + prio)) {
381                         qdisc->q.qlen--;
382                         return __qdisc_dequeue_head(qdisc, list + prio);
383                 }
384         }
385
386         return NULL;
387 }
388
389 static int pfifo_fast_requeue(struct sk_buff *skb, struct Qdisc* qdisc)
390 {
391         qdisc->q.qlen++;
392         return __qdisc_requeue(skb, qdisc, prio2list(skb, qdisc));
393 }
394
395 static void pfifo_fast_reset(struct Qdisc* qdisc)
396 {
397         int prio;
398         struct sk_buff_head *list = qdisc_priv(qdisc);
399
400         for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
401                 __qdisc_reset_queue(qdisc, list + prio);
402
403         qdisc->qstats.backlog = 0;
404         qdisc->q.qlen = 0;
405 }
406
407 static int pfifo_fast_dump(struct Qdisc *qdisc, struct sk_buff *skb)
408 {
409         struct tc_prio_qopt opt = { .bands = PFIFO_FAST_BANDS };
410
411         memcpy(&opt.priomap, prio2band, TC_PRIO_MAX+1);
412         NLA_PUT(skb, TCA_OPTIONS, sizeof(opt), &opt);
413         return skb->len;
414
415 nla_put_failure:
416         return -1;
417 }
418
419 static int pfifo_fast_init(struct Qdisc *qdisc, struct nlattr *opt)
420 {
421         int prio;
422         struct sk_buff_head *list = qdisc_priv(qdisc);
423
424         for (prio = 0; prio < PFIFO_FAST_BANDS; prio++)
425                 skb_queue_head_init(list + prio);
426
427         return 0;
428 }
429
430 static struct Qdisc_ops pfifo_fast_ops __read_mostly = {
431         .id             =       "pfifo_fast",
432         .priv_size      =       PFIFO_FAST_BANDS * sizeof(struct sk_buff_head),
433         .enqueue        =       pfifo_fast_enqueue,
434         .dequeue        =       pfifo_fast_dequeue,
435         .requeue        =       pfifo_fast_requeue,
436         .init           =       pfifo_fast_init,
437         .reset          =       pfifo_fast_reset,
438         .dump           =       pfifo_fast_dump,
439         .owner          =       THIS_MODULE,
440 };
441
442 struct Qdisc *qdisc_alloc(struct net_device *dev, struct Qdisc_ops *ops)
443 {
444         void *p;
445         struct Qdisc *sch;
446         unsigned int size;
447         int err = -ENOBUFS;
448
449         /* ensure that the Qdisc and the private data are 32-byte aligned */
450         size = QDISC_ALIGN(sizeof(*sch));
451         size += ops->priv_size + (QDISC_ALIGNTO - 1);
452
453         p = kzalloc(size, GFP_KERNEL);
454         if (!p)
455                 goto errout;
456         sch = (struct Qdisc *) QDISC_ALIGN((unsigned long) p);
457         sch->padded = (char *) sch - (char *) p;
458
459         INIT_LIST_HEAD(&sch->list);
460         skb_queue_head_init(&sch->q);
461         sch->ops = ops;
462         sch->enqueue = ops->enqueue;
463         sch->dequeue = ops->dequeue;
464         sch->dev = dev;
465         dev_hold(dev);
466         atomic_set(&sch->refcnt, 1);
467
468         return sch;
469 errout:
470         return ERR_PTR(-err);
471 }
472
473 struct Qdisc * qdisc_create_dflt(struct net_device *dev, struct Qdisc_ops *ops,
474                                  unsigned int parentid)
475 {
476         struct Qdisc *sch;
477
478         sch = qdisc_alloc(dev, ops);
479         if (IS_ERR(sch))
480                 goto errout;
481         sch->stats_lock = &dev->queue_lock;
482         sch->parent = parentid;
483
484         if (!ops->init || ops->init(sch, NULL) == 0)
485                 return sch;
486
487         qdisc_destroy(sch);
488 errout:
489         return NULL;
490 }
491 EXPORT_SYMBOL(qdisc_create_dflt);
492
493 /* Under dev->queue_lock and BH! */
494
495 void qdisc_reset(struct Qdisc *qdisc)
496 {
497         const struct Qdisc_ops *ops = qdisc->ops;
498
499         if (ops->reset)
500                 ops->reset(qdisc);
501 }
502 EXPORT_SYMBOL(qdisc_reset);
503
504 /* this is the rcu callback function to clean up a qdisc when there
505  * are no further references to it */
506
507 static void __qdisc_destroy(struct rcu_head *head)
508 {
509         struct Qdisc *qdisc = container_of(head, struct Qdisc, q_rcu);
510         kfree((char *) qdisc - qdisc->padded);
511 }
512
513 /* Under dev->queue_lock and BH! */
514
515 void qdisc_destroy(struct Qdisc *qdisc)
516 {
517         const struct Qdisc_ops  *ops = qdisc->ops;
518
519         if (qdisc->flags & TCQ_F_BUILTIN ||
520             !atomic_dec_and_test(&qdisc->refcnt))
521                 return;
522
523         list_del(&qdisc->list);
524         gen_kill_estimator(&qdisc->bstats, &qdisc->rate_est);
525         if (ops->reset)
526                 ops->reset(qdisc);
527         if (ops->destroy)
528                 ops->destroy(qdisc);
529
530         module_put(ops->owner);
531         dev_put(qdisc->dev);
532         call_rcu(&qdisc->q_rcu, __qdisc_destroy);
533 }
534 EXPORT_SYMBOL(qdisc_destroy);
535
536 void dev_activate(struct net_device *dev)
537 {
538         /* No queueing discipline is attached to device;
539            create default one i.e. pfifo_fast for devices,
540            which need queueing and noqueue_qdisc for
541            virtual interfaces
542          */
543
544         if (dev->qdisc_sleeping == &noop_qdisc) {
545                 struct Qdisc *qdisc;
546                 if (dev->tx_queue_len) {
547                         qdisc = qdisc_create_dflt(dev, &pfifo_fast_ops,
548                                                   TC_H_ROOT);
549                         if (qdisc == NULL) {
550                                 printk(KERN_INFO "%s: activation failed\n", dev->name);
551                                 return;
552                         }
553                         list_add_tail(&qdisc->list, &dev->qdisc_list);
554                 } else {
555                         qdisc =  &noqueue_qdisc;
556                 }
557                 dev->qdisc_sleeping = qdisc;
558         }
559
560         if (!netif_carrier_ok(dev))
561                 /* Delay activation until next carrier-on event */
562                 return;
563
564         spin_lock_bh(&dev->queue_lock);
565         rcu_assign_pointer(dev->qdisc, dev->qdisc_sleeping);
566         if (dev->qdisc != &noqueue_qdisc) {
567                 dev->trans_start = jiffies;
568                 dev_watchdog_up(dev);
569         }
570         spin_unlock_bh(&dev->queue_lock);
571 }
572
573 void dev_deactivate(struct net_device *dev)
574 {
575         struct Qdisc *qdisc;
576         struct sk_buff *skb;
577         int running;
578
579         spin_lock_bh(&dev->queue_lock);
580         qdisc = dev->qdisc;
581         dev->qdisc = &noop_qdisc;
582
583         qdisc_reset(qdisc);
584
585         skb = dev->gso_skb;
586         dev->gso_skb = NULL;
587         spin_unlock_bh(&dev->queue_lock);
588
589         kfree_skb(skb);
590
591         dev_watchdog_down(dev);
592
593         /* Wait for outstanding qdisc-less dev_queue_xmit calls. */
594         synchronize_rcu();
595
596         /* Wait for outstanding qdisc_run calls. */
597         do {
598                 while (test_bit(__LINK_STATE_QDISC_RUNNING, &dev->state))
599                         yield();
600
601                 /*
602                  * Double-check inside queue lock to ensure that all effects
603                  * of the queue run are visible when we return.
604                  */
605                 spin_lock_bh(&dev->queue_lock);
606                 running = test_bit(__LINK_STATE_QDISC_RUNNING, &dev->state);
607                 spin_unlock_bh(&dev->queue_lock);
608
609                 /*
610                  * The running flag should never be set at this point because
611                  * we've already set dev->qdisc to noop_qdisc *inside* the same
612                  * pair of spin locks.  That is, if any qdisc_run starts after
613                  * our initial test it should see the noop_qdisc and then
614                  * clear the RUNNING bit before dropping the queue lock.  So
615                  * if it is set here then we've found a bug.
616                  */
617         } while (WARN_ON_ONCE(running));
618 }
619
620 void dev_init_scheduler(struct net_device *dev)
621 {
622         qdisc_lock_tree(dev);
623         dev->qdisc = &noop_qdisc;
624         dev->qdisc_sleeping = &noop_qdisc;
625         INIT_LIST_HEAD(&dev->qdisc_list);
626         qdisc_unlock_tree(dev);
627
628         setup_timer(&dev->watchdog_timer, dev_watchdog, (unsigned long)dev);
629 }
630
631 void dev_shutdown(struct net_device *dev)
632 {
633         struct Qdisc *qdisc;
634
635         qdisc_lock_tree(dev);
636         qdisc = dev->qdisc_sleeping;
637         dev->qdisc = &noop_qdisc;
638         dev->qdisc_sleeping = &noop_qdisc;
639         qdisc_destroy(qdisc);
640 #if defined(CONFIG_NET_SCH_INGRESS) || defined(CONFIG_NET_SCH_INGRESS_MODULE)
641         if ((qdisc = dev->qdisc_ingress) != NULL) {
642                 dev->qdisc_ingress = NULL;
643                 qdisc_destroy(qdisc);
644         }
645 #endif
646         BUG_TRAP(!timer_pending(&dev->watchdog_timer));
647         qdisc_unlock_tree(dev);
648 }