2 * net/sched/cls_tcindex.c Packet classifier for skb->tc_index
4 * Written 1998,1999 by Werner Almesberger, EPFL ICA
7 #include <linux/module.h>
8 #include <linux/types.h>
9 #include <linux/kernel.h>
10 #include <linux/skbuff.h>
11 #include <linux/errno.h>
12 #include <linux/netdevice.h>
14 #include <net/act_api.h>
15 #include <net/pkt_cls.h>
16 #include <net/route.h>
20 * Not quite sure if we need all the xchgs Alexey uses when accessing things.
21 * Can always add them later ... :)
25 * Passing parameters to the root seems to be done more awkwardly than really
26 * necessary. At least, u32 doesn't seem to use such dirty hacks. To be
30 #define PERFECT_HASH_THRESHOLD 64 /* use perfect hash if not bigger */
31 #define DEFAULT_HASH_SIZE 64 /* optimized for diffserv */
35 #define DPRINTK(format,args...) printk(KERN_DEBUG format,##args)
37 #define DPRINTK(format,args...)
41 #define D2PRINTK(format,args...) printk(KERN_DEBUG format,##args)
43 #define D2PRINTK(format,args...)
47 #define PRIV(tp) ((struct tcindex_data *) (tp)->root)
50 struct tcindex_filter_result {
52 struct tcf_result res;
55 struct tcindex_filter {
57 struct tcindex_filter_result result;
58 struct tcindex_filter *next;
63 struct tcindex_filter_result *perfect; /* perfect hash; NULL if none */
64 struct tcindex_filter **h; /* imperfect hash; only used if !perfect;
66 u16 mask; /* AND key with mask */
67 int shift; /* shift ANDed key to the right */
68 int hash; /* hash table size; 0 if undefined */
69 int alloc_hash; /* allocated size */
70 int fall_through; /* 0: only classify if explicit match */
73 static struct tcf_ext_map tcindex_ext_map = {
74 .police = TCA_TCINDEX_POLICE,
75 .action = TCA_TCINDEX_ACT
79 tcindex_filter_is_set(struct tcindex_filter_result *r)
81 return tcf_exts_is_predicative(&r->exts) || r->res.classid;
84 static struct tcindex_filter_result *
85 tcindex_lookup(struct tcindex_data *p, u16 key)
87 struct tcindex_filter *f;
90 return tcindex_filter_is_set(p->perfect + key) ?
91 p->perfect + key : NULL;
93 for (f = p->h[key % p->hash]; f; f = f->next)
102 static int tcindex_classify(struct sk_buff *skb, struct tcf_proto *tp,
103 struct tcf_result *res)
105 struct tcindex_data *p = PRIV(tp);
106 struct tcindex_filter_result *f;
107 int key = (skb->tc_index & p->mask) >> p->shift;
109 D2PRINTK("tcindex_classify(skb %p,tp %p,res %p),p %p\n",skb,tp,res,p);
111 f = tcindex_lookup(p, key);
113 if (!p->fall_through)
115 res->classid = TC_H_MAKE(TC_H_MAJ(tp->q->handle), key);
117 D2PRINTK("alg 0x%x\n",res->classid);
121 D2PRINTK("map 0x%x\n",res->classid);
123 return tcf_exts_exec(skb, &f->exts, res);
127 static unsigned long tcindex_get(struct tcf_proto *tp, u32 handle)
129 struct tcindex_data *p = PRIV(tp);
130 struct tcindex_filter_result *r;
132 DPRINTK("tcindex_get(tp %p,handle 0x%08x)\n",tp,handle);
133 if (p->perfect && handle >= p->alloc_hash)
135 r = tcindex_lookup(p, handle);
136 return r && tcindex_filter_is_set(r) ? (unsigned long) r : 0UL;
140 static void tcindex_put(struct tcf_proto *tp, unsigned long f)
142 DPRINTK("tcindex_put(tp %p,f 0x%lx)\n",tp,f);
146 static int tcindex_init(struct tcf_proto *tp)
148 struct tcindex_data *p;
150 DPRINTK("tcindex_init(tp %p)\n",tp);
151 p = kmalloc(sizeof(struct tcindex_data),GFP_KERNEL);
155 memset(p, 0, sizeof(*p));
157 p->hash = DEFAULT_HASH_SIZE;
166 __tcindex_delete(struct tcf_proto *tp, unsigned long arg, int lock)
168 struct tcindex_data *p = PRIV(tp);
169 struct tcindex_filter_result *r = (struct tcindex_filter_result *) arg;
170 struct tcindex_filter *f = NULL;
172 DPRINTK("tcindex_delete(tp %p,arg 0x%lx),p %p,f %p\n",tp,arg,p,f);
178 struct tcindex_filter **walk = NULL;
180 for (i = 0; i < p->hash; i++)
181 for (walk = p->h+i; *walk; walk = &(*walk)->next)
182 if (&(*walk)->result == r)
194 tcf_unbind_filter(tp, &r->res);
195 tcf_exts_destroy(tp, &r->exts);
200 static int tcindex_delete(struct tcf_proto *tp, unsigned long arg)
202 return __tcindex_delete(tp, arg, 1);
206 valid_perfect_hash(struct tcindex_data *p)
208 return p->hash > (p->mask >> p->shift);
212 tcindex_set_parms(struct tcf_proto *tp, unsigned long base, u32 handle,
213 struct tcindex_data *p, struct tcindex_filter_result *r,
214 struct rtattr **tb, struct rtattr *est)
217 struct tcindex_filter_result new_filter_result, *old_r = r;
218 struct tcindex_filter_result cr;
219 struct tcindex_data cp;
220 struct tcindex_filter *f = NULL; /* make gcc behave */
223 err = tcf_exts_validate(tp, tb, est, &e, &tcindex_ext_map);
227 memcpy(&cp, p, sizeof(cp));
228 memset(&new_filter_result, 0, sizeof(new_filter_result));
231 memcpy(&cr, r, sizeof(cr));
233 memset(&cr, 0, sizeof(cr));
236 if (tb[TCA_TCINDEX_HASH-1]) {
237 if (RTA_PAYLOAD(tb[TCA_TCINDEX_HASH-1]) < sizeof(u32))
239 cp.hash = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_HASH-1]);
242 if (tb[TCA_TCINDEX_MASK-1]) {
243 if (RTA_PAYLOAD(tb[TCA_TCINDEX_MASK-1]) < sizeof(u16))
245 cp.mask = *(u16 *) RTA_DATA(tb[TCA_TCINDEX_MASK-1]);
248 if (tb[TCA_TCINDEX_SHIFT-1]) {
249 if (RTA_PAYLOAD(tb[TCA_TCINDEX_SHIFT-1]) < sizeof(u16))
251 cp.shift = *(u16 *) RTA_DATA(tb[TCA_TCINDEX_SHIFT-1]);
255 /* Hash already allocated, make sure that we still meet the
256 * requirements for the allocated hash.
259 if (!valid_perfect_hash(&cp) ||
260 cp.hash > cp.alloc_hash)
262 } else if (cp.h && cp.hash != cp.alloc_hash)
266 if (tb[TCA_TCINDEX_FALL_THROUGH-1]) {
267 if (RTA_PAYLOAD(tb[TCA_TCINDEX_FALL_THROUGH-1]) < sizeof(u32))
270 *(u32 *) RTA_DATA(tb[TCA_TCINDEX_FALL_THROUGH-1]);
274 /* Hash not specified, use perfect hash if the upper limit
275 * of the hashing index is below the threshold.
277 if ((cp.mask >> cp.shift) < PERFECT_HASH_THRESHOLD)
278 cp.hash = (cp.mask >> cp.shift)+1;
280 cp.hash = DEFAULT_HASH_SIZE;
283 if (!cp.perfect && !cp.h)
284 cp.alloc_hash = cp.hash;
286 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
287 * but then, we'd fail handles that may become valid after some future
288 * mask change. While this is extremely unlikely to ever matter,
289 * the check below is safer (and also more backwards-compatible).
291 if (cp.perfect || valid_perfect_hash(&cp))
292 if (handle >= cp.alloc_hash)
297 if (!cp.perfect && !cp.h) {
298 if (valid_perfect_hash(&cp)) {
299 cp.perfect = kmalloc(cp.hash * sizeof(*r), GFP_KERNEL);
302 memset(cp.perfect, 0, cp.hash * sizeof(*r));
305 cp.h = kmalloc(cp.hash * sizeof(f), GFP_KERNEL);
308 memset(cp.h, 0, cp.hash * sizeof(f));
314 r = cp.perfect + handle;
316 r = tcindex_lookup(&cp, handle) ? : &new_filter_result;
318 if (r == &new_filter_result) {
319 f = kmalloc(sizeof(*f), GFP_KERNEL);
322 memset(f, 0, sizeof(*f));
325 if (tb[TCA_TCINDEX_CLASSID-1]) {
326 cr.res.classid = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_CLASSID-1]);
327 tcf_bind_filter(tp, &cr.res, base);
330 tcf_exts_change(tp, &cr.exts, &e);
333 if (old_r && old_r != r)
334 memset(old_r, 0, sizeof(*old_r));
336 memcpy(p, &cp, sizeof(cp));
337 memcpy(r, &cr, sizeof(cr));
339 if (r == &new_filter_result) {
340 struct tcindex_filter **fp;
343 f->result = new_filter_result;
345 for (fp = p->h+(handle % p->hash); *fp; fp = &(*fp)->next)
356 else if (balloc == 2)
359 tcf_exts_destroy(tp, &e);
364 tcindex_change(struct tcf_proto *tp, unsigned long base, u32 handle,
365 struct rtattr **tca, unsigned long *arg)
367 struct rtattr *opt = tca[TCA_OPTIONS-1];
368 struct rtattr *tb[TCA_TCINDEX_MAX];
369 struct tcindex_data *p = PRIV(tp);
370 struct tcindex_filter_result *r = (struct tcindex_filter_result *) *arg;
372 DPRINTK("tcindex_change(tp %p,handle 0x%08x,tca %p,arg %p),opt %p,"
373 "p %p,r %p,*arg 0x%lx\n",
374 tp, handle, tca, arg, opt, p, r, arg ? *arg : 0L);
379 if (rtattr_parse_nested(tb, TCA_TCINDEX_MAX, opt) < 0)
382 return tcindex_set_parms(tp, base, handle, p, r, tb, tca[TCA_RATE-1]);
386 static void tcindex_walk(struct tcf_proto *tp, struct tcf_walker *walker)
388 struct tcindex_data *p = PRIV(tp);
389 struct tcindex_filter *f,*next;
392 DPRINTK("tcindex_walk(tp %p,walker %p),p %p\n",tp,walker,p);
394 for (i = 0; i < p->hash; i++) {
395 if (!p->perfect[i].res.class)
397 if (walker->count >= walker->skip) {
399 (unsigned long) (p->perfect+i), walker)
410 for (i = 0; i < p->hash; i++) {
411 for (f = p->h[i]; f; f = next) {
413 if (walker->count >= walker->skip) {
414 if (walker->fn(tp,(unsigned long) &f->result,
426 static int tcindex_destroy_element(struct tcf_proto *tp,
427 unsigned long arg, struct tcf_walker *walker)
429 return __tcindex_delete(tp, arg, 0);
433 static void tcindex_destroy(struct tcf_proto *tp)
435 struct tcindex_data *p = PRIV(tp);
436 struct tcf_walker walker;
438 DPRINTK("tcindex_destroy(tp %p),p %p\n",tp,p);
441 walker.fn = &tcindex_destroy_element;
442 tcindex_walk(tp,&walker);
450 static int tcindex_dump(struct tcf_proto *tp, unsigned long fh,
451 struct sk_buff *skb, struct tcmsg *t)
453 struct tcindex_data *p = PRIV(tp);
454 struct tcindex_filter_result *r = (struct tcindex_filter_result *) fh;
455 unsigned char *b = skb->tail;
458 DPRINTK("tcindex_dump(tp %p,fh 0x%lx,skb %p,t %p),p %p,r %p,b %p\n",
460 DPRINTK("p->perfect %p p->h %p\n",p->perfect,p->h);
461 rta = (struct rtattr *) b;
462 RTA_PUT(skb,TCA_OPTIONS,0,NULL);
464 t->tcm_handle = ~0; /* whatever ... */
465 RTA_PUT(skb,TCA_TCINDEX_HASH,sizeof(p->hash),&p->hash);
466 RTA_PUT(skb,TCA_TCINDEX_MASK,sizeof(p->mask),&p->mask);
467 RTA_PUT(skb,TCA_TCINDEX_SHIFT,sizeof(p->shift),&p->shift);
468 RTA_PUT(skb,TCA_TCINDEX_FALL_THROUGH,sizeof(p->fall_through),
470 rta->rta_len = skb->tail-b;
473 t->tcm_handle = r-p->perfect;
475 struct tcindex_filter *f;
479 for (i = 0; !t->tcm_handle && i < p->hash; i++) {
480 for (f = p->h[i]; !t->tcm_handle && f;
483 t->tcm_handle = f->key;
487 DPRINTK("handle = %d\n",t->tcm_handle);
489 RTA_PUT(skb, TCA_TCINDEX_CLASSID, 4, &r->res.classid);
491 if (tcf_exts_dump(skb, &r->exts, &tcindex_ext_map) < 0)
493 rta->rta_len = skb->tail-b;
495 if (tcf_exts_dump_stats(skb, &r->exts, &tcindex_ext_map) < 0)
502 skb_trim(skb, b - skb->data);
506 static struct tcf_proto_ops cls_tcindex_ops = {
509 .classify = tcindex_classify,
510 .init = tcindex_init,
511 .destroy = tcindex_destroy,
514 .change = tcindex_change,
515 .delete = tcindex_delete,
516 .walk = tcindex_walk,
517 .dump = tcindex_dump,
518 .owner = THIS_MODULE,
521 static int __init init_tcindex(void)
523 return register_tcf_proto_ops(&cls_tcindex_ops);
526 static void __exit exit_tcindex(void)
528 unregister_tcf_proto_ops(&cls_tcindex_ops);
531 module_init(init_tcindex)
532 module_exit(exit_tcindex)
533 MODULE_LICENSE("GPL");