2 * net/sched/cls_tcindex.c Packet classifier for skb->tc_index
4 * Written 1998,1999 by Werner Almesberger, EPFL ICA
7 #include <linux/config.h>
8 #include <linux/module.h>
9 #include <linux/types.h>
10 #include <linux/kernel.h>
11 #include <linux/skbuff.h>
12 #include <linux/errno.h>
13 #include <linux/netdevice.h>
15 #include <net/act_api.h>
16 #include <net/pkt_cls.h>
17 #include <net/route.h>
21 * Not quite sure if we need all the xchgs Alexey uses when accessing things.
22 * Can always add them later ... :)
26 * Passing parameters to the root seems to be done more awkwardly than really
27 * necessary. At least, u32 doesn't seem to use such dirty hacks. To be
31 #define PERFECT_HASH_THRESHOLD 64 /* use perfect hash if not bigger */
32 #define DEFAULT_HASH_SIZE 64 /* optimized for diffserv */
36 #define DPRINTK(format,args...) printk(KERN_DEBUG format,##args)
38 #define DPRINTK(format,args...)
42 #define D2PRINTK(format,args...) printk(KERN_DEBUG format,##args)
44 #define D2PRINTK(format,args...)
48 #define PRIV(tp) ((struct tcindex_data *) (tp)->root)
51 struct tcindex_filter_result {
53 struct tcf_result res;
56 struct tcindex_filter {
58 struct tcindex_filter_result result;
59 struct tcindex_filter *next;
64 struct tcindex_filter_result *perfect; /* perfect hash; NULL if none */
65 struct tcindex_filter **h; /* imperfect hash; only used if !perfect;
67 u16 mask; /* AND key with mask */
68 int shift; /* shift ANDed key to the right */
69 int hash; /* hash table size; 0 if undefined */
70 int alloc_hash; /* allocated size */
71 int fall_through; /* 0: only classify if explicit match */
74 static struct tcf_ext_map tcindex_ext_map = {
75 .police = TCA_TCINDEX_POLICE,
76 .action = TCA_TCINDEX_ACT
80 tcindex_filter_is_set(struct tcindex_filter_result *r)
82 return tcf_exts_is_predicative(&r->exts) || r->res.classid;
85 static struct tcindex_filter_result *
86 tcindex_lookup(struct tcindex_data *p, u16 key)
88 struct tcindex_filter *f;
91 return tcindex_filter_is_set(p->perfect + key) ?
92 p->perfect + key : NULL;
94 for (f = p->h[key % p->hash]; f; f = f->next)
103 static int tcindex_classify(struct sk_buff *skb, struct tcf_proto *tp,
104 struct tcf_result *res)
106 struct tcindex_data *p = PRIV(tp);
107 struct tcindex_filter_result *f;
108 int key = (skb->tc_index & p->mask) >> p->shift;
110 D2PRINTK("tcindex_classify(skb %p,tp %p,res %p),p %p\n",skb,tp,res,p);
112 f = tcindex_lookup(p, key);
114 if (!p->fall_through)
116 res->classid = TC_H_MAKE(TC_H_MAJ(tp->q->handle), key);
118 D2PRINTK("alg 0x%x\n",res->classid);
122 D2PRINTK("map 0x%x\n",res->classid);
124 return tcf_exts_exec(skb, &f->exts, res);
128 static unsigned long tcindex_get(struct tcf_proto *tp, u32 handle)
130 struct tcindex_data *p = PRIV(tp);
131 struct tcindex_filter_result *r;
133 DPRINTK("tcindex_get(tp %p,handle 0x%08x)\n",tp,handle);
134 if (p->perfect && handle >= p->alloc_hash)
136 r = tcindex_lookup(p, handle);
137 return r && tcindex_filter_is_set(r) ? (unsigned long) r : 0UL;
141 static void tcindex_put(struct tcf_proto *tp, unsigned long f)
143 DPRINTK("tcindex_put(tp %p,f 0x%lx)\n",tp,f);
147 static int tcindex_init(struct tcf_proto *tp)
149 struct tcindex_data *p;
151 DPRINTK("tcindex_init(tp %p)\n",tp);
152 p = kmalloc(sizeof(struct tcindex_data),GFP_KERNEL);
156 memset(p, 0, sizeof(*p));
158 p->hash = DEFAULT_HASH_SIZE;
167 __tcindex_delete(struct tcf_proto *tp, unsigned long arg, int lock)
169 struct tcindex_data *p = PRIV(tp);
170 struct tcindex_filter_result *r = (struct tcindex_filter_result *) arg;
171 struct tcindex_filter *f = NULL;
173 DPRINTK("tcindex_delete(tp %p,arg 0x%lx),p %p,f %p\n",tp,arg,p,f);
179 struct tcindex_filter **walk = NULL;
181 for (i = 0; i < p->hash; i++)
182 for (walk = p->h+i; *walk; walk = &(*walk)->next)
183 if (&(*walk)->result == r)
195 tcf_unbind_filter(tp, &r->res);
196 tcf_exts_destroy(tp, &r->exts);
201 static int tcindex_delete(struct tcf_proto *tp, unsigned long arg)
203 return __tcindex_delete(tp, arg, 1);
207 valid_perfect_hash(struct tcindex_data *p)
209 return p->hash > (p->mask >> p->shift);
213 tcindex_set_parms(struct tcf_proto *tp, unsigned long base, u32 handle,
214 struct tcindex_data *p, struct tcindex_filter_result *r,
215 struct rtattr **tb, struct rtattr *est)
218 struct tcindex_filter_result new_filter_result, *old_r = r;
219 struct tcindex_filter_result cr;
220 struct tcindex_data cp;
221 struct tcindex_filter *f = NULL; /* make gcc behave */
224 err = tcf_exts_validate(tp, tb, est, &e, &tcindex_ext_map);
228 memcpy(&cp, p, sizeof(cp));
229 memset(&new_filter_result, 0, sizeof(new_filter_result));
232 memcpy(&cr, r, sizeof(cr));
234 memset(&cr, 0, sizeof(cr));
237 if (tb[TCA_TCINDEX_HASH-1]) {
238 if (RTA_PAYLOAD(tb[TCA_TCINDEX_HASH-1]) < sizeof(u32))
240 cp.hash = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_HASH-1]);
243 if (tb[TCA_TCINDEX_MASK-1]) {
244 if (RTA_PAYLOAD(tb[TCA_TCINDEX_MASK-1]) < sizeof(u16))
246 cp.mask = *(u16 *) RTA_DATA(tb[TCA_TCINDEX_MASK-1]);
249 if (tb[TCA_TCINDEX_SHIFT-1]) {
250 if (RTA_PAYLOAD(tb[TCA_TCINDEX_SHIFT-1]) < sizeof(u16))
252 cp.shift = *(u16 *) RTA_DATA(tb[TCA_TCINDEX_SHIFT-1]);
256 /* Hash already allocated, make sure that we still meet the
257 * requirements for the allocated hash.
260 if (!valid_perfect_hash(&cp) ||
261 cp.hash > cp.alloc_hash)
263 } else if (cp.h && cp.hash != cp.alloc_hash)
267 if (tb[TCA_TCINDEX_FALL_THROUGH-1]) {
268 if (RTA_PAYLOAD(tb[TCA_TCINDEX_FALL_THROUGH-1]) < sizeof(u32))
271 *(u32 *) RTA_DATA(tb[TCA_TCINDEX_FALL_THROUGH-1]);
275 /* Hash not specified, use perfect hash if the upper limit
276 * of the hashing index is below the threshold.
278 if ((cp.mask >> cp.shift) < PERFECT_HASH_THRESHOLD)
279 cp.hash = (cp.mask >> cp.shift)+1;
281 cp.hash = DEFAULT_HASH_SIZE;
284 if (!cp.perfect && !cp.h)
285 cp.alloc_hash = cp.hash;
287 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
288 * but then, we'd fail handles that may become valid after some future
289 * mask change. While this is extremely unlikely to ever matter,
290 * the check below is safer (and also more backwards-compatible).
292 if (cp.perfect || valid_perfect_hash(&cp))
293 if (handle >= cp.alloc_hash)
298 if (!cp.perfect && !cp.h) {
299 if (valid_perfect_hash(&cp)) {
300 cp.perfect = kmalloc(cp.hash * sizeof(*r), GFP_KERNEL);
303 memset(cp.perfect, 0, cp.hash * sizeof(*r));
306 cp.h = kmalloc(cp.hash * sizeof(f), GFP_KERNEL);
309 memset(cp.h, 0, cp.hash * sizeof(f));
315 r = cp.perfect + handle;
317 r = tcindex_lookup(&cp, handle) ? : &new_filter_result;
319 if (r == &new_filter_result) {
320 f = kmalloc(sizeof(*f), GFP_KERNEL);
323 memset(f, 0, sizeof(*f));
326 if (tb[TCA_TCINDEX_CLASSID-1]) {
327 cr.res.classid = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_CLASSID-1]);
328 tcf_bind_filter(tp, &cr.res, base);
331 tcf_exts_change(tp, &cr.exts, &e);
334 if (old_r && old_r != r)
335 memset(old_r, 0, sizeof(*old_r));
337 memcpy(p, &cp, sizeof(cp));
338 memcpy(r, &cr, sizeof(cr));
340 if (r == &new_filter_result) {
341 struct tcindex_filter **fp;
344 f->result = new_filter_result;
346 for (fp = p->h+(handle % p->hash); *fp; fp = &(*fp)->next)
357 else if (balloc == 2)
360 tcf_exts_destroy(tp, &e);
365 tcindex_change(struct tcf_proto *tp, unsigned long base, u32 handle,
366 struct rtattr **tca, unsigned long *arg)
368 struct rtattr *opt = tca[TCA_OPTIONS-1];
369 struct rtattr *tb[TCA_TCINDEX_MAX];
370 struct tcindex_data *p = PRIV(tp);
371 struct tcindex_filter_result *r = (struct tcindex_filter_result *) *arg;
373 DPRINTK("tcindex_change(tp %p,handle 0x%08x,tca %p,arg %p),opt %p,"
374 "p %p,r %p,*arg 0x%lx\n",
375 tp, handle, tca, arg, opt, p, r, arg ? *arg : 0L);
380 if (rtattr_parse_nested(tb, TCA_TCINDEX_MAX, opt) < 0)
383 return tcindex_set_parms(tp, base, handle, p, r, tb, tca[TCA_RATE-1]);
387 static void tcindex_walk(struct tcf_proto *tp, struct tcf_walker *walker)
389 struct tcindex_data *p = PRIV(tp);
390 struct tcindex_filter *f,*next;
393 DPRINTK("tcindex_walk(tp %p,walker %p),p %p\n",tp,walker,p);
395 for (i = 0; i < p->hash; i++) {
396 if (!p->perfect[i].res.class)
398 if (walker->count >= walker->skip) {
400 (unsigned long) (p->perfect+i), walker)
411 for (i = 0; i < p->hash; i++) {
412 for (f = p->h[i]; f; f = next) {
414 if (walker->count >= walker->skip) {
415 if (walker->fn(tp,(unsigned long) &f->result,
427 static int tcindex_destroy_element(struct tcf_proto *tp,
428 unsigned long arg, struct tcf_walker *walker)
430 return __tcindex_delete(tp, arg, 0);
434 static void tcindex_destroy(struct tcf_proto *tp)
436 struct tcindex_data *p = PRIV(tp);
437 struct tcf_walker walker;
439 DPRINTK("tcindex_destroy(tp %p),p %p\n",tp,p);
442 walker.fn = &tcindex_destroy_element;
443 tcindex_walk(tp,&walker);
451 static int tcindex_dump(struct tcf_proto *tp, unsigned long fh,
452 struct sk_buff *skb, struct tcmsg *t)
454 struct tcindex_data *p = PRIV(tp);
455 struct tcindex_filter_result *r = (struct tcindex_filter_result *) fh;
456 unsigned char *b = skb->tail;
459 DPRINTK("tcindex_dump(tp %p,fh 0x%lx,skb %p,t %p),p %p,r %p,b %p\n",
461 DPRINTK("p->perfect %p p->h %p\n",p->perfect,p->h);
462 rta = (struct rtattr *) b;
463 RTA_PUT(skb,TCA_OPTIONS,0,NULL);
465 t->tcm_handle = ~0; /* whatever ... */
466 RTA_PUT(skb,TCA_TCINDEX_HASH,sizeof(p->hash),&p->hash);
467 RTA_PUT(skb,TCA_TCINDEX_MASK,sizeof(p->mask),&p->mask);
468 RTA_PUT(skb,TCA_TCINDEX_SHIFT,sizeof(p->shift),&p->shift);
469 RTA_PUT(skb,TCA_TCINDEX_FALL_THROUGH,sizeof(p->fall_through),
471 rta->rta_len = skb->tail-b;
474 t->tcm_handle = r-p->perfect;
476 struct tcindex_filter *f;
480 for (i = 0; !t->tcm_handle && i < p->hash; i++) {
481 for (f = p->h[i]; !t->tcm_handle && f;
484 t->tcm_handle = f->key;
488 DPRINTK("handle = %d\n",t->tcm_handle);
490 RTA_PUT(skb, TCA_TCINDEX_CLASSID, 4, &r->res.classid);
492 if (tcf_exts_dump(skb, &r->exts, &tcindex_ext_map) < 0)
494 rta->rta_len = skb->tail-b;
496 if (tcf_exts_dump_stats(skb, &r->exts, &tcindex_ext_map) < 0)
503 skb_trim(skb, b - skb->data);
507 static struct tcf_proto_ops cls_tcindex_ops = {
510 .classify = tcindex_classify,
511 .init = tcindex_init,
512 .destroy = tcindex_destroy,
515 .change = tcindex_change,
516 .delete = tcindex_delete,
517 .walk = tcindex_walk,
518 .dump = tcindex_dump,
519 .owner = THIS_MODULE,
522 static int __init init_tcindex(void)
524 return register_tcf_proto_ops(&cls_tcindex_ops);
527 static void __exit exit_tcindex(void)
529 unregister_tcf_proto_ops(&cls_tcindex_ops);
532 module_init(init_tcindex)
533 module_exit(exit_tcindex)
534 MODULE_LICENSE("GPL");