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