net: remove CVS keywords
[safe/jmp/linux-2.6] / net / sched / sch_htb.c
1 /*
2  * net/sched/sch_htb.c  Hierarchical token bucket, feed tree version
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:     Martin Devera, <devik@cdi.cz>
10  *
11  * Credits (in time order) for older HTB versions:
12  *              Stef Coene <stef.coene@docum.org>
13  *                      HTB support at LARTC mailing list
14  *              Ondrej Kraus, <krauso@barr.cz>
15  *                      found missing INIT_QDISC(htb)
16  *              Vladimir Smelhaus, Aamer Akhter, Bert Hubert
17  *                      helped a lot to locate nasty class stall bug
18  *              Andi Kleen, Jamal Hadi, Bert Hubert
19  *                      code review and helpful comments on shaping
20  *              Tomasz Wrona, <tw@eter.tym.pl>
21  *                      created test case so that I was able to fix nasty bug
22  *              Wilfried Weissmann
23  *                      spotted bug in dequeue code and helped with fix
24  *              Jiri Fojtasek
25  *                      fixed requeue routine
26  *              and many others. thanks.
27  */
28 #include <linux/module.h>
29 #include <linux/types.h>
30 #include <linux/kernel.h>
31 #include <linux/string.h>
32 #include <linux/errno.h>
33 #include <linux/skbuff.h>
34 #include <linux/list.h>
35 #include <linux/compiler.h>
36 #include <linux/rbtree.h>
37 #include <net/netlink.h>
38 #include <net/pkt_sched.h>
39
40 /* HTB algorithm.
41     Author: devik@cdi.cz
42     ========================================================================
43     HTB is like TBF with multiple classes. It is also similar to CBQ because
44     it allows to assign priority to each class in hierarchy.
45     In fact it is another implementation of Floyd's formal sharing.
46
47     Levels:
48     Each class is assigned level. Leaf has ALWAYS level 0 and root
49     classes have level TC_HTB_MAXDEPTH-1. Interior nodes has level
50     one less than their parent.
51 */
52
53 #define HTB_HSIZE 16            /* classid hash size */
54 #define HTB_HYSTERESIS 1        /* whether to use mode hysteresis for speedup */
55 #define HTB_VER 0x30011         /* major must be matched with number suplied by TC as version */
56
57 #if HTB_VER >> 16 != TC_HTB_PROTOVER
58 #error "Mismatched sch_htb.c and pkt_sch.h"
59 #endif
60
61 /* used internaly to keep status of single class */
62 enum htb_cmode {
63         HTB_CANT_SEND,          /* class can't send and can't borrow */
64         HTB_MAY_BORROW,         /* class can't send but may borrow */
65         HTB_CAN_SEND            /* class can send */
66 };
67
68 /* interior & leaf nodes; props specific to leaves are marked L: */
69 struct htb_class {
70         /* general class parameters */
71         u32 classid;
72         struct gnet_stats_basic bstats;
73         struct gnet_stats_queue qstats;
74         struct gnet_stats_rate_est rate_est;
75         struct tc_htb_xstats xstats;    /* our special stats */
76         int refcnt;             /* usage count of this class */
77
78         /* topology */
79         int level;              /* our level (see above) */
80         struct htb_class *parent;       /* parent class */
81         struct hlist_node hlist;        /* classid hash list item */
82         struct list_head sibling;       /* sibling list item */
83         struct list_head children;      /* children list */
84
85         union {
86                 struct htb_class_leaf {
87                         struct Qdisc *q;
88                         int prio;
89                         int aprio;
90                         int quantum;
91                         int deficit[TC_HTB_MAXDEPTH];
92                         struct list_head drop_list;
93                 } leaf;
94                 struct htb_class_inner {
95                         struct rb_root feed[TC_HTB_NUMPRIO];    /* feed trees */
96                         struct rb_node *ptr[TC_HTB_NUMPRIO];    /* current class ptr */
97                         /* When class changes from state 1->2 and disconnects from
98                            parent's feed then we lost ptr value and start from the
99                            first child again. Here we store classid of the
100                            last valid ptr (used when ptr is NULL). */
101                         u32 last_ptr_id[TC_HTB_NUMPRIO];
102                 } inner;
103         } un;
104         struct rb_node node[TC_HTB_NUMPRIO];    /* node for self or feed tree */
105         struct rb_node pq_node; /* node for event queue */
106         psched_time_t pq_key;
107
108         int prio_activity;      /* for which prios are we active */
109         enum htb_cmode cmode;   /* current mode of the class */
110
111         /* class attached filters */
112         struct tcf_proto *filter_list;
113         int filter_cnt;
114
115         int warned;             /* only one warning about non work conserving .. */
116
117         /* token bucket parameters */
118         struct qdisc_rate_table *rate;  /* rate table of the class itself */
119         struct qdisc_rate_table *ceil;  /* ceiling rate (limits borrows too) */
120         long buffer, cbuffer;   /* token bucket depth/rate */
121         psched_tdiff_t mbuffer; /* max wait time */
122         long tokens, ctokens;   /* current number of tokens */
123         psched_time_t t_c;      /* checkpoint time */
124
125         int prio;               /* For parent to leaf return possible here */
126         int quantum;            /* we do backup. Finally full replacement  */
127                                 /* of un.leaf originals should be done. */
128 };
129
130 static inline long L2T(struct htb_class *cl, struct qdisc_rate_table *rate,
131                            int size)
132 {
133         long result = qdisc_l2t(rate, size);
134         return result;
135 }
136
137 struct htb_sched {
138         struct list_head root;  /* root classes list */
139         struct hlist_head hash[HTB_HSIZE];      /* hashed by classid */
140         struct list_head drops[TC_HTB_NUMPRIO];/* active leaves (for drops) */
141
142         /* self list - roots of self generating tree */
143         struct rb_root row[TC_HTB_MAXDEPTH][TC_HTB_NUMPRIO];
144         int row_mask[TC_HTB_MAXDEPTH];
145         struct rb_node *ptr[TC_HTB_MAXDEPTH][TC_HTB_NUMPRIO];
146         u32 last_ptr_id[TC_HTB_MAXDEPTH][TC_HTB_NUMPRIO];
147
148         /* self wait list - roots of wait PQs per row */
149         struct rb_root wait_pq[TC_HTB_MAXDEPTH];
150
151         /* time of nearest event per level (row) */
152         psched_time_t near_ev_cache[TC_HTB_MAXDEPTH];
153
154         /* whether we hit non-work conserving class during this dequeue; we use */
155         int nwc_hit;            /* this to disable mindelay complaint in dequeue */
156
157         int defcls;             /* class where unclassified flows go to */
158
159         /* filters for qdisc itself */
160         struct tcf_proto *filter_list;
161         int filter_cnt;
162
163         int rate2quantum;       /* quant = rate / rate2quantum */
164         psched_time_t now;      /* cached dequeue time */
165         struct qdisc_watchdog watchdog;
166
167         /* non shaped skbs; let them go directly thru */
168         struct sk_buff_head direct_queue;
169         int direct_qlen;        /* max qlen of above */
170
171         long direct_pkts;
172 };
173
174 /* compute hash of size HTB_HSIZE for given handle */
175 static inline int htb_hash(u32 h)
176 {
177 #if HTB_HSIZE != 16
178 #error "Declare new hash for your HTB_HSIZE"
179 #endif
180         h ^= h >> 8;            /* stolen from cbq_hash */
181         h ^= h >> 4;
182         return h & 0xf;
183 }
184
185 /* find class in global hash table using given handle */
186 static inline struct htb_class *htb_find(u32 handle, struct Qdisc *sch)
187 {
188         struct htb_sched *q = qdisc_priv(sch);
189         struct hlist_node *p;
190         struct htb_class *cl;
191
192         if (TC_H_MAJ(handle) != sch->handle)
193                 return NULL;
194
195         hlist_for_each_entry(cl, p, q->hash + htb_hash(handle), hlist) {
196                 if (cl->classid == handle)
197                         return cl;
198         }
199         return NULL;
200 }
201
202 /**
203  * htb_classify - classify a packet into class
204  *
205  * It returns NULL if the packet should be dropped or -1 if the packet
206  * should be passed directly thru. In all other cases leaf class is returned.
207  * We allow direct class selection by classid in priority. The we examine
208  * filters in qdisc and in inner nodes (if higher filter points to the inner
209  * node). If we end up with classid MAJOR:0 we enqueue the skb into special
210  * internal fifo (direct). These packets then go directly thru. If we still
211  * have no valid leaf we try to use MAJOR:default leaf. It still unsuccessfull
212  * then finish and return direct queue.
213  */
214 #define HTB_DIRECT (struct htb_class*)-1
215
216 static struct htb_class *htb_classify(struct sk_buff *skb, struct Qdisc *sch,
217                                       int *qerr)
218 {
219         struct htb_sched *q = qdisc_priv(sch);
220         struct htb_class *cl;
221         struct tcf_result res;
222         struct tcf_proto *tcf;
223         int result;
224
225         /* allow to select class by setting skb->priority to valid classid;
226            note that nfmark can be used too by attaching filter fw with no
227            rules in it */
228         if (skb->priority == sch->handle)
229                 return HTB_DIRECT;      /* X:0 (direct flow) selected */
230         if ((cl = htb_find(skb->priority, sch)) != NULL && cl->level == 0)
231                 return cl;
232
233         *qerr = NET_XMIT_BYPASS;
234         tcf = q->filter_list;
235         while (tcf && (result = tc_classify(skb, tcf, &res)) >= 0) {
236 #ifdef CONFIG_NET_CLS_ACT
237                 switch (result) {
238                 case TC_ACT_QUEUED:
239                 case TC_ACT_STOLEN:
240                         *qerr = NET_XMIT_SUCCESS;
241                 case TC_ACT_SHOT:
242                         return NULL;
243                 }
244 #endif
245                 if ((cl = (void *)res.class) == NULL) {
246                         if (res.classid == sch->handle)
247                                 return HTB_DIRECT;      /* X:0 (direct flow) */
248                         if ((cl = htb_find(res.classid, sch)) == NULL)
249                                 break;  /* filter selected invalid classid */
250                 }
251                 if (!cl->level)
252                         return cl;      /* we hit leaf; return it */
253
254                 /* we have got inner class; apply inner filter chain */
255                 tcf = cl->filter_list;
256         }
257         /* classification failed; try to use default class */
258         cl = htb_find(TC_H_MAKE(TC_H_MAJ(sch->handle), q->defcls), sch);
259         if (!cl || cl->level)
260                 return HTB_DIRECT;      /* bad default .. this is safe bet */
261         return cl;
262 }
263
264 /**
265  * htb_add_to_id_tree - adds class to the round robin list
266  *
267  * Routine adds class to the list (actually tree) sorted by classid.
268  * Make sure that class is not already on such list for given prio.
269  */
270 static void htb_add_to_id_tree(struct rb_root *root,
271                                struct htb_class *cl, int prio)
272 {
273         struct rb_node **p = &root->rb_node, *parent = NULL;
274
275         while (*p) {
276                 struct htb_class *c;
277                 parent = *p;
278                 c = rb_entry(parent, struct htb_class, node[prio]);
279
280                 if (cl->classid > c->classid)
281                         p = &parent->rb_right;
282                 else
283                         p = &parent->rb_left;
284         }
285         rb_link_node(&cl->node[prio], parent, p);
286         rb_insert_color(&cl->node[prio], root);
287 }
288
289 /**
290  * htb_add_to_wait_tree - adds class to the event queue with delay
291  *
292  * The class is added to priority event queue to indicate that class will
293  * change its mode in cl->pq_key microseconds. Make sure that class is not
294  * already in the queue.
295  */
296 static void htb_add_to_wait_tree(struct htb_sched *q,
297                                  struct htb_class *cl, long delay)
298 {
299         struct rb_node **p = &q->wait_pq[cl->level].rb_node, *parent = NULL;
300
301         cl->pq_key = q->now + delay;
302         if (cl->pq_key == q->now)
303                 cl->pq_key++;
304
305         /* update the nearest event cache */
306         if (q->near_ev_cache[cl->level] > cl->pq_key)
307                 q->near_ev_cache[cl->level] = cl->pq_key;
308
309         while (*p) {
310                 struct htb_class *c;
311                 parent = *p;
312                 c = rb_entry(parent, struct htb_class, pq_node);
313                 if (cl->pq_key >= c->pq_key)
314                         p = &parent->rb_right;
315                 else
316                         p = &parent->rb_left;
317         }
318         rb_link_node(&cl->pq_node, parent, p);
319         rb_insert_color(&cl->pq_node, &q->wait_pq[cl->level]);
320 }
321
322 /**
323  * htb_next_rb_node - finds next node in binary tree
324  *
325  * When we are past last key we return NULL.
326  * Average complexity is 2 steps per call.
327  */
328 static inline void htb_next_rb_node(struct rb_node **n)
329 {
330         *n = rb_next(*n);
331 }
332
333 /**
334  * htb_add_class_to_row - add class to its row
335  *
336  * The class is added to row at priorities marked in mask.
337  * It does nothing if mask == 0.
338  */
339 static inline void htb_add_class_to_row(struct htb_sched *q,
340                                         struct htb_class *cl, int mask)
341 {
342         q->row_mask[cl->level] |= mask;
343         while (mask) {
344                 int prio = ffz(~mask);
345                 mask &= ~(1 << prio);
346                 htb_add_to_id_tree(q->row[cl->level] + prio, cl, prio);
347         }
348 }
349
350 /* If this triggers, it is a bug in this code, but it need not be fatal */
351 static void htb_safe_rb_erase(struct rb_node *rb, struct rb_root *root)
352 {
353         if (RB_EMPTY_NODE(rb)) {
354                 WARN_ON(1);
355         } else {
356                 rb_erase(rb, root);
357                 RB_CLEAR_NODE(rb);
358         }
359 }
360
361
362 /**
363  * htb_remove_class_from_row - removes class from its row
364  *
365  * The class is removed from row at priorities marked in mask.
366  * It does nothing if mask == 0.
367  */
368 static inline void htb_remove_class_from_row(struct htb_sched *q,
369                                                  struct htb_class *cl, int mask)
370 {
371         int m = 0;
372
373         while (mask) {
374                 int prio = ffz(~mask);
375
376                 mask &= ~(1 << prio);
377                 if (q->ptr[cl->level][prio] == cl->node + prio)
378                         htb_next_rb_node(q->ptr[cl->level] + prio);
379
380                 htb_safe_rb_erase(cl->node + prio, q->row[cl->level] + prio);
381                 if (!q->row[cl->level][prio].rb_node)
382                         m |= 1 << prio;
383         }
384         q->row_mask[cl->level] &= ~m;
385 }
386
387 /**
388  * htb_activate_prios - creates active classe's feed chain
389  *
390  * The class is connected to ancestors and/or appropriate rows
391  * for priorities it is participating on. cl->cmode must be new
392  * (activated) mode. It does nothing if cl->prio_activity == 0.
393  */
394 static void htb_activate_prios(struct htb_sched *q, struct htb_class *cl)
395 {
396         struct htb_class *p = cl->parent;
397         long m, mask = cl->prio_activity;
398
399         while (cl->cmode == HTB_MAY_BORROW && p && mask) {
400                 m = mask;
401                 while (m) {
402                         int prio = ffz(~m);
403                         m &= ~(1 << prio);
404
405                         if (p->un.inner.feed[prio].rb_node)
406                                 /* parent already has its feed in use so that
407                                    reset bit in mask as parent is already ok */
408                                 mask &= ~(1 << prio);
409
410                         htb_add_to_id_tree(p->un.inner.feed + prio, cl, prio);
411                 }
412                 p->prio_activity |= mask;
413                 cl = p;
414                 p = cl->parent;
415
416         }
417         if (cl->cmode == HTB_CAN_SEND && mask)
418                 htb_add_class_to_row(q, cl, mask);
419 }
420
421 /**
422  * htb_deactivate_prios - remove class from feed chain
423  *
424  * cl->cmode must represent old mode (before deactivation). It does
425  * nothing if cl->prio_activity == 0. Class is removed from all feed
426  * chains and rows.
427  */
428 static void htb_deactivate_prios(struct htb_sched *q, struct htb_class *cl)
429 {
430         struct htb_class *p = cl->parent;
431         long m, mask = cl->prio_activity;
432
433         while (cl->cmode == HTB_MAY_BORROW && p && mask) {
434                 m = mask;
435                 mask = 0;
436                 while (m) {
437                         int prio = ffz(~m);
438                         m &= ~(1 << prio);
439
440                         if (p->un.inner.ptr[prio] == cl->node + prio) {
441                                 /* we are removing child which is pointed to from
442                                    parent feed - forget the pointer but remember
443                                    classid */
444                                 p->un.inner.last_ptr_id[prio] = cl->classid;
445                                 p->un.inner.ptr[prio] = NULL;
446                         }
447
448                         htb_safe_rb_erase(cl->node + prio, p->un.inner.feed + prio);
449
450                         if (!p->un.inner.feed[prio].rb_node)
451                                 mask |= 1 << prio;
452                 }
453
454                 p->prio_activity &= ~mask;
455                 cl = p;
456                 p = cl->parent;
457
458         }
459         if (cl->cmode == HTB_CAN_SEND && mask)
460                 htb_remove_class_from_row(q, cl, mask);
461 }
462
463 #if HTB_HYSTERESIS
464 static inline long htb_lowater(const struct htb_class *cl)
465 {
466         return cl->cmode != HTB_CANT_SEND ? -cl->cbuffer : 0;
467 }
468 static inline long htb_hiwater(const struct htb_class *cl)
469 {
470         return cl->cmode == HTB_CAN_SEND ? -cl->buffer : 0;
471 }
472 #else
473 #define htb_lowater(cl) (0)
474 #define htb_hiwater(cl) (0)
475 #endif
476
477 /**
478  * htb_class_mode - computes and returns current class mode
479  *
480  * It computes cl's mode at time cl->t_c+diff and returns it. If mode
481  * is not HTB_CAN_SEND then cl->pq_key is updated to time difference
482  * from now to time when cl will change its state.
483  * Also it is worth to note that class mode doesn't change simply
484  * at cl->{c,}tokens == 0 but there can rather be hysteresis of
485  * 0 .. -cl->{c,}buffer range. It is meant to limit number of
486  * mode transitions per time unit. The speed gain is about 1/6.
487  */
488 static inline enum htb_cmode
489 htb_class_mode(struct htb_class *cl, long *diff)
490 {
491         long toks;
492
493         if ((toks = (cl->ctokens + *diff)) < htb_lowater(cl)) {
494                 *diff = -toks;
495                 return HTB_CANT_SEND;
496         }
497
498         if ((toks = (cl->tokens + *diff)) >= htb_hiwater(cl))
499                 return HTB_CAN_SEND;
500
501         *diff = -toks;
502         return HTB_MAY_BORROW;
503 }
504
505 /**
506  * htb_change_class_mode - changes classe's mode
507  *
508  * This should be the only way how to change classe's mode under normal
509  * cirsumstances. Routine will update feed lists linkage, change mode
510  * and add class to the wait event queue if appropriate. New mode should
511  * be different from old one and cl->pq_key has to be valid if changing
512  * to mode other than HTB_CAN_SEND (see htb_add_to_wait_tree).
513  */
514 static void
515 htb_change_class_mode(struct htb_sched *q, struct htb_class *cl, long *diff)
516 {
517         enum htb_cmode new_mode = htb_class_mode(cl, diff);
518
519         if (new_mode == cl->cmode)
520                 return;
521
522         if (cl->prio_activity) {        /* not necessary: speed optimization */
523                 if (cl->cmode != HTB_CANT_SEND)
524                         htb_deactivate_prios(q, cl);
525                 cl->cmode = new_mode;
526                 if (new_mode != HTB_CANT_SEND)
527                         htb_activate_prios(q, cl);
528         } else
529                 cl->cmode = new_mode;
530 }
531
532 /**
533  * htb_activate - inserts leaf cl into appropriate active feeds
534  *
535  * Routine learns (new) priority of leaf and activates feed chain
536  * for the prio. It can be called on already active leaf safely.
537  * It also adds leaf into droplist.
538  */
539 static inline void htb_activate(struct htb_sched *q, struct htb_class *cl)
540 {
541         BUG_TRAP(!cl->level && cl->un.leaf.q && cl->un.leaf.q->q.qlen);
542
543         if (!cl->prio_activity) {
544                 cl->prio_activity = 1 << (cl->un.leaf.aprio = cl->un.leaf.prio);
545                 htb_activate_prios(q, cl);
546                 list_add_tail(&cl->un.leaf.drop_list,
547                               q->drops + cl->un.leaf.aprio);
548         }
549 }
550
551 /**
552  * htb_deactivate - remove leaf cl from active feeds
553  *
554  * Make sure that leaf is active. In the other words it can't be called
555  * with non-active leaf. It also removes class from the drop list.
556  */
557 static inline void htb_deactivate(struct htb_sched *q, struct htb_class *cl)
558 {
559         BUG_TRAP(cl->prio_activity);
560
561         htb_deactivate_prios(q, cl);
562         cl->prio_activity = 0;
563         list_del_init(&cl->un.leaf.drop_list);
564 }
565
566 static int htb_enqueue(struct sk_buff *skb, struct Qdisc *sch)
567 {
568         int ret;
569         struct htb_sched *q = qdisc_priv(sch);
570         struct htb_class *cl = htb_classify(skb, sch, &ret);
571
572         if (cl == HTB_DIRECT) {
573                 /* enqueue to helper queue */
574                 if (q->direct_queue.qlen < q->direct_qlen) {
575                         __skb_queue_tail(&q->direct_queue, skb);
576                         q->direct_pkts++;
577                 } else {
578                         kfree_skb(skb);
579                         sch->qstats.drops++;
580                         return NET_XMIT_DROP;
581                 }
582 #ifdef CONFIG_NET_CLS_ACT
583         } else if (!cl) {
584                 if (ret == NET_XMIT_BYPASS)
585                         sch->qstats.drops++;
586                 kfree_skb(skb);
587                 return ret;
588 #endif
589         } else if (cl->un.leaf.q->enqueue(skb, cl->un.leaf.q) !=
590                    NET_XMIT_SUCCESS) {
591                 sch->qstats.drops++;
592                 cl->qstats.drops++;
593                 return NET_XMIT_DROP;
594         } else {
595                 cl->bstats.packets +=
596                         skb_is_gso(skb)?skb_shinfo(skb)->gso_segs:1;
597                 cl->bstats.bytes += skb->len;
598                 htb_activate(q, cl);
599         }
600
601         sch->q.qlen++;
602         sch->bstats.packets += skb_is_gso(skb)?skb_shinfo(skb)->gso_segs:1;
603         sch->bstats.bytes += skb->len;
604         return NET_XMIT_SUCCESS;
605 }
606
607 /* TODO: requeuing packet charges it to policers again !! */
608 static int htb_requeue(struct sk_buff *skb, struct Qdisc *sch)
609 {
610         int ret;
611         struct htb_sched *q = qdisc_priv(sch);
612         struct htb_class *cl = htb_classify(skb, sch, &ret);
613         struct sk_buff *tskb;
614
615         if (cl == HTB_DIRECT) {
616                 /* enqueue to helper queue */
617                 if (q->direct_queue.qlen < q->direct_qlen) {
618                         __skb_queue_head(&q->direct_queue, skb);
619                 } else {
620                         __skb_queue_head(&q->direct_queue, skb);
621                         tskb = __skb_dequeue_tail(&q->direct_queue);
622                         kfree_skb(tskb);
623                         sch->qstats.drops++;
624                         return NET_XMIT_CN;
625                 }
626 #ifdef CONFIG_NET_CLS_ACT
627         } else if (!cl) {
628                 if (ret == NET_XMIT_BYPASS)
629                         sch->qstats.drops++;
630                 kfree_skb(skb);
631                 return ret;
632 #endif
633         } else if (cl->un.leaf.q->ops->requeue(skb, cl->un.leaf.q) !=
634                    NET_XMIT_SUCCESS) {
635                 sch->qstats.drops++;
636                 cl->qstats.drops++;
637                 return NET_XMIT_DROP;
638         } else
639                 htb_activate(q, cl);
640
641         sch->q.qlen++;
642         sch->qstats.requeues++;
643         return NET_XMIT_SUCCESS;
644 }
645
646 /**
647  * htb_charge_class - charges amount "bytes" to leaf and ancestors
648  *
649  * Routine assumes that packet "bytes" long was dequeued from leaf cl
650  * borrowing from "level". It accounts bytes to ceil leaky bucket for
651  * leaf and all ancestors and to rate bucket for ancestors at levels
652  * "level" and higher. It also handles possible change of mode resulting
653  * from the update. Note that mode can also increase here (MAY_BORROW to
654  * CAN_SEND) because we can use more precise clock that event queue here.
655  * In such case we remove class from event queue first.
656  */
657 static void htb_charge_class(struct htb_sched *q, struct htb_class *cl,
658                              int level, struct sk_buff *skb)
659 {
660         int bytes = skb->len;
661         long toks, diff;
662         enum htb_cmode old_mode;
663
664 #define HTB_ACCNT(T,B,R) toks = diff + cl->T; \
665         if (toks > cl->B) toks = cl->B; \
666         toks -= L2T(cl, cl->R, bytes); \
667         if (toks <= -cl->mbuffer) toks = 1-cl->mbuffer; \
668         cl->T = toks
669
670         while (cl) {
671                 diff = psched_tdiff_bounded(q->now, cl->t_c, cl->mbuffer);
672                 if (cl->level >= level) {
673                         if (cl->level == level)
674                                 cl->xstats.lends++;
675                         HTB_ACCNT(tokens, buffer, rate);
676                 } else {
677                         cl->xstats.borrows++;
678                         cl->tokens += diff;     /* we moved t_c; update tokens */
679                 }
680                 HTB_ACCNT(ctokens, cbuffer, ceil);
681                 cl->t_c = q->now;
682
683                 old_mode = cl->cmode;
684                 diff = 0;
685                 htb_change_class_mode(q, cl, &diff);
686                 if (old_mode != cl->cmode) {
687                         if (old_mode != HTB_CAN_SEND)
688                                 htb_safe_rb_erase(&cl->pq_node, q->wait_pq + cl->level);
689                         if (cl->cmode != HTB_CAN_SEND)
690                                 htb_add_to_wait_tree(q, cl, diff);
691                 }
692
693                 /* update byte stats except for leaves which are already updated */
694                 if (cl->level) {
695                         cl->bstats.bytes += bytes;
696                         cl->bstats.packets += skb_is_gso(skb)?
697                                         skb_shinfo(skb)->gso_segs:1;
698                 }
699                 cl = cl->parent;
700         }
701 }
702
703 /**
704  * htb_do_events - make mode changes to classes at the level
705  *
706  * Scans event queue for pending events and applies them. Returns time of
707  * next pending event (0 for no event in pq).
708  * Note: Applied are events whose have cl->pq_key <= q->now.
709  */
710 static psched_time_t htb_do_events(struct htb_sched *q, int level)
711 {
712         /* don't run for longer than 2 jiffies; 2 is used instead of
713            1 to simplify things when jiffy is going to be incremented
714            too soon */
715         unsigned long stop_at = jiffies + 2;
716         while (time_before(jiffies, stop_at)) {
717                 struct htb_class *cl;
718                 long diff;
719                 struct rb_node *p = rb_first(&q->wait_pq[level]);
720
721                 if (!p)
722                         return 0;
723
724                 cl = rb_entry(p, struct htb_class, pq_node);
725                 if (cl->pq_key > q->now)
726                         return cl->pq_key;
727
728                 htb_safe_rb_erase(p, q->wait_pq + level);
729                 diff = psched_tdiff_bounded(q->now, cl->t_c, cl->mbuffer);
730                 htb_change_class_mode(q, cl, &diff);
731                 if (cl->cmode != HTB_CAN_SEND)
732                         htb_add_to_wait_tree(q, cl, diff);
733         }
734         /* too much load - let's continue on next jiffie */
735         return q->now + PSCHED_TICKS_PER_SEC / HZ;
736 }
737
738 /* Returns class->node+prio from id-tree where classe's id is >= id. NULL
739    is no such one exists. */
740 static struct rb_node *htb_id_find_next_upper(int prio, struct rb_node *n,
741                                               u32 id)
742 {
743         struct rb_node *r = NULL;
744         while (n) {
745                 struct htb_class *cl =
746                     rb_entry(n, struct htb_class, node[prio]);
747                 if (id == cl->classid)
748                         return n;
749
750                 if (id > cl->classid) {
751                         n = n->rb_right;
752                 } else {
753                         r = n;
754                         n = n->rb_left;
755                 }
756         }
757         return r;
758 }
759
760 /**
761  * htb_lookup_leaf - returns next leaf class in DRR order
762  *
763  * Find leaf where current feed pointers points to.
764  */
765 static struct htb_class *htb_lookup_leaf(struct rb_root *tree, int prio,
766                                          struct rb_node **pptr, u32 * pid)
767 {
768         int i;
769         struct {
770                 struct rb_node *root;
771                 struct rb_node **pptr;
772                 u32 *pid;
773         } stk[TC_HTB_MAXDEPTH], *sp = stk;
774
775         BUG_TRAP(tree->rb_node);
776         sp->root = tree->rb_node;
777         sp->pptr = pptr;
778         sp->pid = pid;
779
780         for (i = 0; i < 65535; i++) {
781                 if (!*sp->pptr && *sp->pid) {
782                         /* ptr was invalidated but id is valid - try to recover
783                            the original or next ptr */
784                         *sp->pptr =
785                             htb_id_find_next_upper(prio, sp->root, *sp->pid);
786                 }
787                 *sp->pid = 0;   /* ptr is valid now so that remove this hint as it
788                                    can become out of date quickly */
789                 if (!*sp->pptr) {       /* we are at right end; rewind & go up */
790                         *sp->pptr = sp->root;
791                         while ((*sp->pptr)->rb_left)
792                                 *sp->pptr = (*sp->pptr)->rb_left;
793                         if (sp > stk) {
794                                 sp--;
795                                 BUG_TRAP(*sp->pptr);
796                                 if (!*sp->pptr)
797                                         return NULL;
798                                 htb_next_rb_node(sp->pptr);
799                         }
800                 } else {
801                         struct htb_class *cl;
802                         cl = rb_entry(*sp->pptr, struct htb_class, node[prio]);
803                         if (!cl->level)
804                                 return cl;
805                         (++sp)->root = cl->un.inner.feed[prio].rb_node;
806                         sp->pptr = cl->un.inner.ptr + prio;
807                         sp->pid = cl->un.inner.last_ptr_id + prio;
808                 }
809         }
810         BUG_TRAP(0);
811         return NULL;
812 }
813
814 /* dequeues packet at given priority and level; call only if
815    you are sure that there is active class at prio/level */
816 static struct sk_buff *htb_dequeue_tree(struct htb_sched *q, int prio,
817                                         int level)
818 {
819         struct sk_buff *skb = NULL;
820         struct htb_class *cl, *start;
821         /* look initial class up in the row */
822         start = cl = htb_lookup_leaf(q->row[level] + prio, prio,
823                                      q->ptr[level] + prio,
824                                      q->last_ptr_id[level] + prio);
825
826         do {
827 next:
828                 BUG_TRAP(cl);
829                 if (!cl)
830                         return NULL;
831
832                 /* class can be empty - it is unlikely but can be true if leaf
833                    qdisc drops packets in enqueue routine or if someone used
834                    graft operation on the leaf since last dequeue;
835                    simply deactivate and skip such class */
836                 if (unlikely(cl->un.leaf.q->q.qlen == 0)) {
837                         struct htb_class *next;
838                         htb_deactivate(q, cl);
839
840                         /* row/level might become empty */
841                         if ((q->row_mask[level] & (1 << prio)) == 0)
842                                 return NULL;
843
844                         next = htb_lookup_leaf(q->row[level] + prio,
845                                                prio, q->ptr[level] + prio,
846                                                q->last_ptr_id[level] + prio);
847
848                         if (cl == start)        /* fix start if we just deleted it */
849                                 start = next;
850                         cl = next;
851                         goto next;
852                 }
853
854                 skb = cl->un.leaf.q->dequeue(cl->un.leaf.q);
855                 if (likely(skb != NULL))
856                         break;
857                 if (!cl->warned) {
858                         printk(KERN_WARNING
859                                "htb: class %X isn't work conserving ?!\n",
860                                cl->classid);
861                         cl->warned = 1;
862                 }
863                 q->nwc_hit++;
864                 htb_next_rb_node((level ? cl->parent->un.inner.ptr : q->
865                                   ptr[0]) + prio);
866                 cl = htb_lookup_leaf(q->row[level] + prio, prio,
867                                      q->ptr[level] + prio,
868                                      q->last_ptr_id[level] + prio);
869
870         } while (cl != start);
871
872         if (likely(skb != NULL)) {
873                 if ((cl->un.leaf.deficit[level] -= skb->len) < 0) {
874                         cl->un.leaf.deficit[level] += cl->un.leaf.quantum;
875                         htb_next_rb_node((level ? cl->parent->un.inner.ptr : q->
876                                           ptr[0]) + prio);
877                 }
878                 /* this used to be after charge_class but this constelation
879                    gives us slightly better performance */
880                 if (!cl->un.leaf.q->q.qlen)
881                         htb_deactivate(q, cl);
882                 htb_charge_class(q, cl, level, skb);
883         }
884         return skb;
885 }
886
887 static struct sk_buff *htb_dequeue(struct Qdisc *sch)
888 {
889         struct sk_buff *skb = NULL;
890         struct htb_sched *q = qdisc_priv(sch);
891         int level;
892         psched_time_t next_event;
893
894         /* try to dequeue direct packets as high prio (!) to minimize cpu work */
895         skb = __skb_dequeue(&q->direct_queue);
896         if (skb != NULL) {
897                 sch->flags &= ~TCQ_F_THROTTLED;
898                 sch->q.qlen--;
899                 return skb;
900         }
901
902         if (!sch->q.qlen)
903                 goto fin;
904         q->now = psched_get_time();
905
906         next_event = q->now + 5 * PSCHED_TICKS_PER_SEC;
907         q->nwc_hit = 0;
908         for (level = 0; level < TC_HTB_MAXDEPTH; level++) {
909                 /* common case optimization - skip event handler quickly */
910                 int m;
911                 psched_time_t event;
912
913                 if (q->now >= q->near_ev_cache[level]) {
914                         event = htb_do_events(q, level);
915                         if (!event)
916                                 event = q->now + PSCHED_TICKS_PER_SEC;
917                         q->near_ev_cache[level] = event;
918                 } else
919                         event = q->near_ev_cache[level];
920
921                 if (event && next_event > event)
922                         next_event = event;
923
924                 m = ~q->row_mask[level];
925                 while (m != (int)(-1)) {
926                         int prio = ffz(m);
927                         m |= 1 << prio;
928                         skb = htb_dequeue_tree(q, prio, level);
929                         if (likely(skb != NULL)) {
930                                 sch->q.qlen--;
931                                 sch->flags &= ~TCQ_F_THROTTLED;
932                                 goto fin;
933                         }
934                 }
935         }
936         sch->qstats.overlimits++;
937         qdisc_watchdog_schedule(&q->watchdog, next_event);
938 fin:
939         return skb;
940 }
941
942 /* try to drop from each class (by prio) until one succeed */
943 static unsigned int htb_drop(struct Qdisc *sch)
944 {
945         struct htb_sched *q = qdisc_priv(sch);
946         int prio;
947
948         for (prio = TC_HTB_NUMPRIO - 1; prio >= 0; prio--) {
949                 struct list_head *p;
950                 list_for_each(p, q->drops + prio) {
951                         struct htb_class *cl = list_entry(p, struct htb_class,
952                                                           un.leaf.drop_list);
953                         unsigned int len;
954                         if (cl->un.leaf.q->ops->drop &&
955                             (len = cl->un.leaf.q->ops->drop(cl->un.leaf.q))) {
956                                 sch->q.qlen--;
957                                 if (!cl->un.leaf.q->q.qlen)
958                                         htb_deactivate(q, cl);
959                                 return len;
960                         }
961                 }
962         }
963         return 0;
964 }
965
966 /* reset all classes */
967 /* always caled under BH & queue lock */
968 static void htb_reset(struct Qdisc *sch)
969 {
970         struct htb_sched *q = qdisc_priv(sch);
971         int i;
972
973         for (i = 0; i < HTB_HSIZE; i++) {
974                 struct hlist_node *p;
975                 struct htb_class *cl;
976
977                 hlist_for_each_entry(cl, p, q->hash + i, hlist) {
978                         if (cl->level)
979                                 memset(&cl->un.inner, 0, sizeof(cl->un.inner));
980                         else {
981                                 if (cl->un.leaf.q)
982                                         qdisc_reset(cl->un.leaf.q);
983                                 INIT_LIST_HEAD(&cl->un.leaf.drop_list);
984                         }
985                         cl->prio_activity = 0;
986                         cl->cmode = HTB_CAN_SEND;
987
988                 }
989         }
990         qdisc_watchdog_cancel(&q->watchdog);
991         __skb_queue_purge(&q->direct_queue);
992         sch->q.qlen = 0;
993         memset(q->row, 0, sizeof(q->row));
994         memset(q->row_mask, 0, sizeof(q->row_mask));
995         memset(q->wait_pq, 0, sizeof(q->wait_pq));
996         memset(q->ptr, 0, sizeof(q->ptr));
997         for (i = 0; i < TC_HTB_NUMPRIO; i++)
998                 INIT_LIST_HEAD(q->drops + i);
999 }
1000
1001 static const struct nla_policy htb_policy[TCA_HTB_MAX + 1] = {
1002         [TCA_HTB_PARMS] = { .len = sizeof(struct tc_htb_opt) },
1003         [TCA_HTB_INIT]  = { .len = sizeof(struct tc_htb_glob) },
1004         [TCA_HTB_CTAB]  = { .type = NLA_BINARY, .len = TC_RTAB_SIZE },
1005         [TCA_HTB_RTAB]  = { .type = NLA_BINARY, .len = TC_RTAB_SIZE },
1006 };
1007
1008 static int htb_init(struct Qdisc *sch, struct nlattr *opt)
1009 {
1010         struct htb_sched *q = qdisc_priv(sch);
1011         struct nlattr *tb[TCA_HTB_INIT + 1];
1012         struct tc_htb_glob *gopt;
1013         int err;
1014         int i;
1015
1016         if (!opt)
1017                 return -EINVAL;
1018
1019         err = nla_parse_nested(tb, TCA_HTB_INIT, opt, htb_policy);
1020         if (err < 0)
1021                 return err;
1022
1023         if (tb[TCA_HTB_INIT] == NULL) {
1024                 printk(KERN_ERR "HTB: hey probably you have bad tc tool ?\n");
1025                 return -EINVAL;
1026         }
1027         gopt = nla_data(tb[TCA_HTB_INIT]);
1028         if (gopt->version != HTB_VER >> 16) {
1029                 printk(KERN_ERR
1030                        "HTB: need tc/htb version %d (minor is %d), you have %d\n",
1031                        HTB_VER >> 16, HTB_VER & 0xffff, gopt->version);
1032                 return -EINVAL;
1033         }
1034
1035         INIT_LIST_HEAD(&q->root);
1036         for (i = 0; i < HTB_HSIZE; i++)
1037                 INIT_HLIST_HEAD(q->hash + i);
1038         for (i = 0; i < TC_HTB_NUMPRIO; i++)
1039                 INIT_LIST_HEAD(q->drops + i);
1040
1041         qdisc_watchdog_init(&q->watchdog, sch);
1042         skb_queue_head_init(&q->direct_queue);
1043
1044         q->direct_qlen = sch->dev->tx_queue_len;
1045         if (q->direct_qlen < 2) /* some devices have zero tx_queue_len */
1046                 q->direct_qlen = 2;
1047
1048         if ((q->rate2quantum = gopt->rate2quantum) < 1)
1049                 q->rate2quantum = 1;
1050         q->defcls = gopt->defcls;
1051
1052         return 0;
1053 }
1054
1055 static int htb_dump(struct Qdisc *sch, struct sk_buff *skb)
1056 {
1057         struct htb_sched *q = qdisc_priv(sch);
1058         struct nlattr *nest;
1059         struct tc_htb_glob gopt;
1060
1061         spin_lock_bh(&sch->dev->queue_lock);
1062
1063         gopt.direct_pkts = q->direct_pkts;
1064         gopt.version = HTB_VER;
1065         gopt.rate2quantum = q->rate2quantum;
1066         gopt.defcls = q->defcls;
1067         gopt.debug = 0;
1068
1069         nest = nla_nest_start(skb, TCA_OPTIONS);
1070         if (nest == NULL)
1071                 goto nla_put_failure;
1072         NLA_PUT(skb, TCA_HTB_INIT, sizeof(gopt), &gopt);
1073         nla_nest_end(skb, nest);
1074
1075         spin_unlock_bh(&sch->dev->queue_lock);
1076         return skb->len;
1077
1078 nla_put_failure:
1079         spin_unlock_bh(&sch->dev->queue_lock);
1080         nla_nest_cancel(skb, nest);
1081         return -1;
1082 }
1083
1084 static int htb_dump_class(struct Qdisc *sch, unsigned long arg,
1085                           struct sk_buff *skb, struct tcmsg *tcm)
1086 {
1087         struct htb_class *cl = (struct htb_class *)arg;
1088         struct nlattr *nest;
1089         struct tc_htb_opt opt;
1090
1091         spin_lock_bh(&sch->dev->queue_lock);
1092         tcm->tcm_parent = cl->parent ? cl->parent->classid : TC_H_ROOT;
1093         tcm->tcm_handle = cl->classid;
1094         if (!cl->level && cl->un.leaf.q)
1095                 tcm->tcm_info = cl->un.leaf.q->handle;
1096
1097         nest = nla_nest_start(skb, TCA_OPTIONS);
1098         if (nest == NULL)
1099                 goto nla_put_failure;
1100
1101         memset(&opt, 0, sizeof(opt));
1102
1103         opt.rate = cl->rate->rate;
1104         opt.buffer = cl->buffer;
1105         opt.ceil = cl->ceil->rate;
1106         opt.cbuffer = cl->cbuffer;
1107         opt.quantum = cl->un.leaf.quantum;
1108         opt.prio = cl->un.leaf.prio;
1109         opt.level = cl->level;
1110         NLA_PUT(skb, TCA_HTB_PARMS, sizeof(opt), &opt);
1111
1112         nla_nest_end(skb, nest);
1113         spin_unlock_bh(&sch->dev->queue_lock);
1114         return skb->len;
1115
1116 nla_put_failure:
1117         spin_unlock_bh(&sch->dev->queue_lock);
1118         nla_nest_cancel(skb, nest);
1119         return -1;
1120 }
1121
1122 static int
1123 htb_dump_class_stats(struct Qdisc *sch, unsigned long arg, struct gnet_dump *d)
1124 {
1125         struct htb_class *cl = (struct htb_class *)arg;
1126
1127         if (!cl->level && cl->un.leaf.q)
1128                 cl->qstats.qlen = cl->un.leaf.q->q.qlen;
1129         cl->xstats.tokens = cl->tokens;
1130         cl->xstats.ctokens = cl->ctokens;
1131
1132         if (gnet_stats_copy_basic(d, &cl->bstats) < 0 ||
1133             gnet_stats_copy_rate_est(d, &cl->rate_est) < 0 ||
1134             gnet_stats_copy_queue(d, &cl->qstats) < 0)
1135                 return -1;
1136
1137         return gnet_stats_copy_app(d, &cl->xstats, sizeof(cl->xstats));
1138 }
1139
1140 static int htb_graft(struct Qdisc *sch, unsigned long arg, struct Qdisc *new,
1141                      struct Qdisc **old)
1142 {
1143         struct htb_class *cl = (struct htb_class *)arg;
1144
1145         if (cl && !cl->level) {
1146                 if (new == NULL &&
1147                     (new = qdisc_create_dflt(sch->dev, &pfifo_qdisc_ops,
1148                                              cl->classid))
1149                     == NULL)
1150                         return -ENOBUFS;
1151                 sch_tree_lock(sch);
1152                 if ((*old = xchg(&cl->un.leaf.q, new)) != NULL) {
1153                         qdisc_tree_decrease_qlen(*old, (*old)->q.qlen);
1154                         qdisc_reset(*old);
1155                 }
1156                 sch_tree_unlock(sch);
1157                 return 0;
1158         }
1159         return -ENOENT;
1160 }
1161
1162 static struct Qdisc *htb_leaf(struct Qdisc *sch, unsigned long arg)
1163 {
1164         struct htb_class *cl = (struct htb_class *)arg;
1165         return (cl && !cl->level) ? cl->un.leaf.q : NULL;
1166 }
1167
1168 static void htb_qlen_notify(struct Qdisc *sch, unsigned long arg)
1169 {
1170         struct htb_class *cl = (struct htb_class *)arg;
1171
1172         if (cl->un.leaf.q->q.qlen == 0)
1173                 htb_deactivate(qdisc_priv(sch), cl);
1174 }
1175
1176 static unsigned long htb_get(struct Qdisc *sch, u32 classid)
1177 {
1178         struct htb_class *cl = htb_find(classid, sch);
1179         if (cl)
1180                 cl->refcnt++;
1181         return (unsigned long)cl;
1182 }
1183
1184 static inline int htb_parent_last_child(struct htb_class *cl)
1185 {
1186         if (!cl->parent)
1187                 /* the root class */
1188                 return 0;
1189
1190         if (!(cl->parent->children.next == &cl->sibling &&
1191                 cl->parent->children.prev == &cl->sibling))
1192                 /* not the last child */
1193                 return 0;
1194
1195         return 1;
1196 }
1197
1198 static void htb_parent_to_leaf(struct htb_sched *q, struct htb_class *cl,
1199                                struct Qdisc *new_q)
1200 {
1201         struct htb_class *parent = cl->parent;
1202
1203         BUG_TRAP(!cl->level && cl->un.leaf.q && !cl->prio_activity);
1204
1205         if (parent->cmode != HTB_CAN_SEND)
1206                 htb_safe_rb_erase(&parent->pq_node, q->wait_pq + parent->level);
1207
1208         parent->level = 0;
1209         memset(&parent->un.inner, 0, sizeof(parent->un.inner));
1210         INIT_LIST_HEAD(&parent->un.leaf.drop_list);
1211         parent->un.leaf.q = new_q ? new_q : &noop_qdisc;
1212         parent->un.leaf.quantum = parent->quantum;
1213         parent->un.leaf.prio = parent->prio;
1214         parent->tokens = parent->buffer;
1215         parent->ctokens = parent->cbuffer;
1216         parent->t_c = psched_get_time();
1217         parent->cmode = HTB_CAN_SEND;
1218 }
1219
1220 static void htb_destroy_class(struct Qdisc *sch, struct htb_class *cl)
1221 {
1222         struct htb_sched *q = qdisc_priv(sch);
1223
1224         if (!cl->level) {
1225                 BUG_TRAP(cl->un.leaf.q);
1226                 qdisc_destroy(cl->un.leaf.q);
1227         }
1228         gen_kill_estimator(&cl->bstats, &cl->rate_est);
1229         qdisc_put_rtab(cl->rate);
1230         qdisc_put_rtab(cl->ceil);
1231
1232         tcf_destroy_chain(cl->filter_list);
1233
1234         while (!list_empty(&cl->children))
1235                 htb_destroy_class(sch, list_entry(cl->children.next,
1236                                                   struct htb_class, sibling));
1237
1238         /* note: this delete may happen twice (see htb_delete) */
1239         hlist_del_init(&cl->hlist);
1240         list_del(&cl->sibling);
1241
1242         if (cl->prio_activity)
1243                 htb_deactivate(q, cl);
1244
1245         if (cl->cmode != HTB_CAN_SEND)
1246                 htb_safe_rb_erase(&cl->pq_node, q->wait_pq + cl->level);
1247
1248         kfree(cl);
1249 }
1250
1251 /* always caled under BH & queue lock */
1252 static void htb_destroy(struct Qdisc *sch)
1253 {
1254         struct htb_sched *q = qdisc_priv(sch);
1255
1256         qdisc_watchdog_cancel(&q->watchdog);
1257         /* This line used to be after htb_destroy_class call below
1258            and surprisingly it worked in 2.4. But it must precede it
1259            because filter need its target class alive to be able to call
1260            unbind_filter on it (without Oops). */
1261         tcf_destroy_chain(q->filter_list);
1262
1263         while (!list_empty(&q->root))
1264                 htb_destroy_class(sch, list_entry(q->root.next,
1265                                                   struct htb_class, sibling));
1266
1267         __skb_queue_purge(&q->direct_queue);
1268 }
1269
1270 static int htb_delete(struct Qdisc *sch, unsigned long arg)
1271 {
1272         struct htb_sched *q = qdisc_priv(sch);
1273         struct htb_class *cl = (struct htb_class *)arg;
1274         unsigned int qlen;
1275         struct Qdisc *new_q = NULL;
1276         int last_child = 0;
1277
1278         // TODO: why don't allow to delete subtree ? references ? does
1279         // tc subsys quarantee us that in htb_destroy it holds no class
1280         // refs so that we can remove children safely there ?
1281         if (!list_empty(&cl->children) || cl->filter_cnt)
1282                 return -EBUSY;
1283
1284         if (!cl->level && htb_parent_last_child(cl)) {
1285                 new_q = qdisc_create_dflt(sch->dev, &pfifo_qdisc_ops,
1286                                                 cl->parent->classid);
1287                 last_child = 1;
1288         }
1289
1290         sch_tree_lock(sch);
1291
1292         if (!cl->level) {
1293                 qlen = cl->un.leaf.q->q.qlen;
1294                 qdisc_reset(cl->un.leaf.q);
1295                 qdisc_tree_decrease_qlen(cl->un.leaf.q, qlen);
1296         }
1297
1298         /* delete from hash and active; remainder in destroy_class */
1299         hlist_del_init(&cl->hlist);
1300
1301         if (cl->prio_activity)
1302                 htb_deactivate(q, cl);
1303
1304         if (last_child)
1305                 htb_parent_to_leaf(q, cl, new_q);
1306
1307         if (--cl->refcnt == 0)
1308                 htb_destroy_class(sch, cl);
1309
1310         sch_tree_unlock(sch);
1311         return 0;
1312 }
1313
1314 static void htb_put(struct Qdisc *sch, unsigned long arg)
1315 {
1316         struct htb_class *cl = (struct htb_class *)arg;
1317
1318         if (--cl->refcnt == 0)
1319                 htb_destroy_class(sch, cl);
1320 }
1321
1322 static int htb_change_class(struct Qdisc *sch, u32 classid,
1323                             u32 parentid, struct nlattr **tca,
1324                             unsigned long *arg)
1325 {
1326         int err = -EINVAL;
1327         struct htb_sched *q = qdisc_priv(sch);
1328         struct htb_class *cl = (struct htb_class *)*arg, *parent;
1329         struct nlattr *opt = tca[TCA_OPTIONS];
1330         struct qdisc_rate_table *rtab = NULL, *ctab = NULL;
1331         struct nlattr *tb[TCA_HTB_RTAB + 1];
1332         struct tc_htb_opt *hopt;
1333
1334         /* extract all subattrs from opt attr */
1335         if (!opt)
1336                 goto failure;
1337
1338         err = nla_parse_nested(tb, TCA_HTB_RTAB, opt, htb_policy);
1339         if (err < 0)
1340                 goto failure;
1341
1342         err = -EINVAL;
1343         if (tb[TCA_HTB_PARMS] == NULL)
1344                 goto failure;
1345
1346         parent = parentid == TC_H_ROOT ? NULL : htb_find(parentid, sch);
1347
1348         hopt = nla_data(tb[TCA_HTB_PARMS]);
1349
1350         rtab = qdisc_get_rtab(&hopt->rate, tb[TCA_HTB_RTAB]);
1351         ctab = qdisc_get_rtab(&hopt->ceil, tb[TCA_HTB_CTAB]);
1352         if (!rtab || !ctab)
1353                 goto failure;
1354
1355         if (!cl) {              /* new class */
1356                 struct Qdisc *new_q;
1357                 int prio;
1358                 struct {
1359                         struct nlattr           nla;
1360                         struct gnet_estimator   opt;
1361                 } est = {
1362                         .nla = {
1363                                 .nla_len        = nla_attr_size(sizeof(est.opt)),
1364                                 .nla_type       = TCA_RATE,
1365                         },
1366                         .opt = {
1367                                 /* 4s interval, 16s averaging constant */
1368                                 .interval       = 2,
1369                                 .ewma_log       = 2,
1370                         },
1371                 };
1372
1373                 /* check for valid classid */
1374                 if (!classid || TC_H_MAJ(classid ^ sch->handle)
1375                     || htb_find(classid, sch))
1376                         goto failure;
1377
1378                 /* check maximal depth */
1379                 if (parent && parent->parent && parent->parent->level < 2) {
1380                         printk(KERN_ERR "htb: tree is too deep\n");
1381                         goto failure;
1382                 }
1383                 err = -ENOBUFS;
1384                 if ((cl = kzalloc(sizeof(*cl), GFP_KERNEL)) == NULL)
1385                         goto failure;
1386
1387                 gen_new_estimator(&cl->bstats, &cl->rate_est,
1388                                   &sch->dev->queue_lock,
1389                                   tca[TCA_RATE] ? : &est.nla);
1390                 cl->refcnt = 1;
1391                 INIT_LIST_HEAD(&cl->sibling);
1392                 INIT_HLIST_NODE(&cl->hlist);
1393                 INIT_LIST_HEAD(&cl->children);
1394                 INIT_LIST_HEAD(&cl->un.leaf.drop_list);
1395                 RB_CLEAR_NODE(&cl->pq_node);
1396
1397                 for (prio = 0; prio < TC_HTB_NUMPRIO; prio++)
1398                         RB_CLEAR_NODE(&cl->node[prio]);
1399
1400                 /* create leaf qdisc early because it uses kmalloc(GFP_KERNEL)
1401                    so that can't be used inside of sch_tree_lock
1402                    -- thanks to Karlis Peisenieks */
1403                 new_q = qdisc_create_dflt(sch->dev, &pfifo_qdisc_ops, classid);
1404                 sch_tree_lock(sch);
1405                 if (parent && !parent->level) {
1406                         unsigned int qlen = parent->un.leaf.q->q.qlen;
1407
1408                         /* turn parent into inner node */
1409                         qdisc_reset(parent->un.leaf.q);
1410                         qdisc_tree_decrease_qlen(parent->un.leaf.q, qlen);
1411                         qdisc_destroy(parent->un.leaf.q);
1412                         if (parent->prio_activity)
1413                                 htb_deactivate(q, parent);
1414
1415                         /* remove from evt list because of level change */
1416                         if (parent->cmode != HTB_CAN_SEND) {
1417                                 htb_safe_rb_erase(&parent->pq_node, q->wait_pq);
1418                                 parent->cmode = HTB_CAN_SEND;
1419                         }
1420                         parent->level = (parent->parent ? parent->parent->level
1421                                          : TC_HTB_MAXDEPTH) - 1;
1422                         memset(&parent->un.inner, 0, sizeof(parent->un.inner));
1423                 }
1424                 /* leaf (we) needs elementary qdisc */
1425                 cl->un.leaf.q = new_q ? new_q : &noop_qdisc;
1426
1427                 cl->classid = classid;
1428                 cl->parent = parent;
1429
1430                 /* set class to be in HTB_CAN_SEND state */
1431                 cl->tokens = hopt->buffer;
1432                 cl->ctokens = hopt->cbuffer;
1433                 cl->mbuffer = 60 * PSCHED_TICKS_PER_SEC;        /* 1min */
1434                 cl->t_c = psched_get_time();
1435                 cl->cmode = HTB_CAN_SEND;
1436
1437                 /* attach to the hash list and parent's family */
1438                 hlist_add_head(&cl->hlist, q->hash + htb_hash(classid));
1439                 list_add_tail(&cl->sibling,
1440                               parent ? &parent->children : &q->root);
1441         } else {
1442                 if (tca[TCA_RATE])
1443                         gen_replace_estimator(&cl->bstats, &cl->rate_est,
1444                                               &sch->dev->queue_lock,
1445                                               tca[TCA_RATE]);
1446                 sch_tree_lock(sch);
1447         }
1448
1449         /* it used to be a nasty bug here, we have to check that node
1450            is really leaf before changing cl->un.leaf ! */
1451         if (!cl->level) {
1452                 cl->un.leaf.quantum = rtab->rate.rate / q->rate2quantum;
1453                 if (!hopt->quantum && cl->un.leaf.quantum < 1000) {
1454                         printk(KERN_WARNING
1455                                "HTB: quantum of class %X is small. Consider r2q change.\n",
1456                                cl->classid);
1457                         cl->un.leaf.quantum = 1000;
1458                 }
1459                 if (!hopt->quantum && cl->un.leaf.quantum > 200000) {
1460                         printk(KERN_WARNING
1461                                "HTB: quantum of class %X is big. Consider r2q change.\n",
1462                                cl->classid);
1463                         cl->un.leaf.quantum = 200000;
1464                 }
1465                 if (hopt->quantum)
1466                         cl->un.leaf.quantum = hopt->quantum;
1467                 if ((cl->un.leaf.prio = hopt->prio) >= TC_HTB_NUMPRIO)
1468                         cl->un.leaf.prio = TC_HTB_NUMPRIO - 1;
1469
1470                 /* backup for htb_parent_to_leaf */
1471                 cl->quantum = cl->un.leaf.quantum;
1472                 cl->prio = cl->un.leaf.prio;
1473         }
1474
1475         cl->buffer = hopt->buffer;
1476         cl->cbuffer = hopt->cbuffer;
1477         if (cl->rate)
1478                 qdisc_put_rtab(cl->rate);
1479         cl->rate = rtab;
1480         if (cl->ceil)
1481                 qdisc_put_rtab(cl->ceil);
1482         cl->ceil = ctab;
1483         sch_tree_unlock(sch);
1484
1485         *arg = (unsigned long)cl;
1486         return 0;
1487
1488 failure:
1489         if (rtab)
1490                 qdisc_put_rtab(rtab);
1491         if (ctab)
1492                 qdisc_put_rtab(ctab);
1493         return err;
1494 }
1495
1496 static struct tcf_proto **htb_find_tcf(struct Qdisc *sch, unsigned long arg)
1497 {
1498         struct htb_sched *q = qdisc_priv(sch);
1499         struct htb_class *cl = (struct htb_class *)arg;
1500         struct tcf_proto **fl = cl ? &cl->filter_list : &q->filter_list;
1501
1502         return fl;
1503 }
1504
1505 static unsigned long htb_bind_filter(struct Qdisc *sch, unsigned long parent,
1506                                      u32 classid)
1507 {
1508         struct htb_sched *q = qdisc_priv(sch);
1509         struct htb_class *cl = htb_find(classid, sch);
1510
1511         /*if (cl && !cl->level) return 0;
1512            The line above used to be there to prevent attaching filters to
1513            leaves. But at least tc_index filter uses this just to get class
1514            for other reasons so that we have to allow for it.
1515            ----
1516            19.6.2002 As Werner explained it is ok - bind filter is just
1517            another way to "lock" the class - unlike "get" this lock can
1518            be broken by class during destroy IIUC.
1519          */
1520         if (cl)
1521                 cl->filter_cnt++;
1522         else
1523                 q->filter_cnt++;
1524         return (unsigned long)cl;
1525 }
1526
1527 static void htb_unbind_filter(struct Qdisc *sch, unsigned long arg)
1528 {
1529         struct htb_sched *q = qdisc_priv(sch);
1530         struct htb_class *cl = (struct htb_class *)arg;
1531
1532         if (cl)
1533                 cl->filter_cnt--;
1534         else
1535                 q->filter_cnt--;
1536 }
1537
1538 static void htb_walk(struct Qdisc *sch, struct qdisc_walker *arg)
1539 {
1540         struct htb_sched *q = qdisc_priv(sch);
1541         int i;
1542
1543         if (arg->stop)
1544                 return;
1545
1546         for (i = 0; i < HTB_HSIZE; i++) {
1547                 struct hlist_node *p;
1548                 struct htb_class *cl;
1549
1550                 hlist_for_each_entry(cl, p, q->hash + i, hlist) {
1551                         if (arg->count < arg->skip) {
1552                                 arg->count++;
1553                                 continue;
1554                         }
1555                         if (arg->fn(sch, (unsigned long)cl, arg) < 0) {
1556                                 arg->stop = 1;
1557                                 return;
1558                         }
1559                         arg->count++;
1560                 }
1561         }
1562 }
1563
1564 static const struct Qdisc_class_ops htb_class_ops = {
1565         .graft          =       htb_graft,
1566         .leaf           =       htb_leaf,
1567         .qlen_notify    =       htb_qlen_notify,
1568         .get            =       htb_get,
1569         .put            =       htb_put,
1570         .change         =       htb_change_class,
1571         .delete         =       htb_delete,
1572         .walk           =       htb_walk,
1573         .tcf_chain      =       htb_find_tcf,
1574         .bind_tcf       =       htb_bind_filter,
1575         .unbind_tcf     =       htb_unbind_filter,
1576         .dump           =       htb_dump_class,
1577         .dump_stats     =       htb_dump_class_stats,
1578 };
1579
1580 static struct Qdisc_ops htb_qdisc_ops __read_mostly = {
1581         .next           =       NULL,
1582         .cl_ops         =       &htb_class_ops,
1583         .id             =       "htb",
1584         .priv_size      =       sizeof(struct htb_sched),
1585         .enqueue        =       htb_enqueue,
1586         .dequeue        =       htb_dequeue,
1587         .requeue        =       htb_requeue,
1588         .drop           =       htb_drop,
1589         .init           =       htb_init,
1590         .reset          =       htb_reset,
1591         .destroy        =       htb_destroy,
1592         .change         =       NULL /* htb_change */,
1593         .dump           =       htb_dump,
1594         .owner          =       THIS_MODULE,
1595 };
1596
1597 static int __init htb_module_init(void)
1598 {
1599         return register_qdisc(&htb_qdisc_ops);
1600 }
1601 static void __exit htb_module_exit(void)
1602 {
1603         unregister_qdisc(&htb_qdisc_ops);
1604 }
1605
1606 module_init(htb_module_init)
1607 module_exit(htb_module_exit)
1608 MODULE_LICENSE("GPL");