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 = kzalloc(sizeof(struct tcindex_data),GFP_KERNEL);
156 p->hash = DEFAULT_HASH_SIZE;
165 __tcindex_delete(struct tcf_proto *tp, unsigned long arg, int lock)
167 struct tcindex_data *p = PRIV(tp);
168 struct tcindex_filter_result *r = (struct tcindex_filter_result *) arg;
169 struct tcindex_filter *f = NULL;
171 DPRINTK("tcindex_delete(tp %p,arg 0x%lx),p %p,f %p\n",tp,arg,p,f);
177 struct tcindex_filter **walk = NULL;
179 for (i = 0; i < p->hash; i++)
180 for (walk = p->h+i; *walk; walk = &(*walk)->next)
181 if (&(*walk)->result == r)
193 tcf_unbind_filter(tp, &r->res);
194 tcf_exts_destroy(tp, &r->exts);
199 static int tcindex_delete(struct tcf_proto *tp, unsigned long arg)
201 return __tcindex_delete(tp, arg, 1);
205 valid_perfect_hash(struct tcindex_data *p)
207 return p->hash > (p->mask >> p->shift);
211 tcindex_set_parms(struct tcf_proto *tp, unsigned long base, u32 handle,
212 struct tcindex_data *p, struct tcindex_filter_result *r,
213 struct rtattr **tb, struct rtattr *est)
216 struct tcindex_filter_result new_filter_result, *old_r = r;
217 struct tcindex_filter_result cr;
218 struct tcindex_data cp;
219 struct tcindex_filter *f = NULL; /* make gcc behave */
222 err = tcf_exts_validate(tp, tb, est, &e, &tcindex_ext_map);
226 memcpy(&cp, p, sizeof(cp));
227 memset(&new_filter_result, 0, sizeof(new_filter_result));
230 memcpy(&cr, r, sizeof(cr));
232 memset(&cr, 0, sizeof(cr));
235 if (tb[TCA_TCINDEX_HASH-1]) {
236 if (RTA_PAYLOAD(tb[TCA_TCINDEX_HASH-1]) < sizeof(u32))
238 cp.hash = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_HASH-1]);
241 if (tb[TCA_TCINDEX_MASK-1]) {
242 if (RTA_PAYLOAD(tb[TCA_TCINDEX_MASK-1]) < sizeof(u16))
244 cp.mask = *(u16 *) RTA_DATA(tb[TCA_TCINDEX_MASK-1]);
247 if (tb[TCA_TCINDEX_SHIFT-1]) {
248 if (RTA_PAYLOAD(tb[TCA_TCINDEX_SHIFT-1]) < sizeof(int))
250 cp.shift = *(int *) RTA_DATA(tb[TCA_TCINDEX_SHIFT-1]);
254 /* Hash already allocated, make sure that we still meet the
255 * requirements for the allocated hash.
258 if (!valid_perfect_hash(&cp) ||
259 cp.hash > cp.alloc_hash)
261 } else if (cp.h && cp.hash != cp.alloc_hash)
265 if (tb[TCA_TCINDEX_FALL_THROUGH-1]) {
266 if (RTA_PAYLOAD(tb[TCA_TCINDEX_FALL_THROUGH-1]) < sizeof(u32))
269 *(u32 *) RTA_DATA(tb[TCA_TCINDEX_FALL_THROUGH-1]);
273 /* Hash not specified, use perfect hash if the upper limit
274 * of the hashing index is below the threshold.
276 if ((cp.mask >> cp.shift) < PERFECT_HASH_THRESHOLD)
277 cp.hash = (cp.mask >> cp.shift)+1;
279 cp.hash = DEFAULT_HASH_SIZE;
282 if (!cp.perfect && !cp.h)
283 cp.alloc_hash = cp.hash;
285 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
286 * but then, we'd fail handles that may become valid after some future
287 * mask change. While this is extremely unlikely to ever matter,
288 * the check below is safer (and also more backwards-compatible).
290 if (cp.perfect || valid_perfect_hash(&cp))
291 if (handle >= cp.alloc_hash)
296 if (!cp.perfect && !cp.h) {
297 if (valid_perfect_hash(&cp)) {
298 cp.perfect = kcalloc(cp.hash, sizeof(*r), GFP_KERNEL);
303 cp.h = kcalloc(cp.hash, sizeof(f), GFP_KERNEL);
311 r = cp.perfect + handle;
313 r = tcindex_lookup(&cp, handle) ? : &new_filter_result;
315 if (r == &new_filter_result) {
316 f = kzalloc(sizeof(*f), GFP_KERNEL);
321 if (tb[TCA_TCINDEX_CLASSID-1]) {
322 cr.res.classid = *(u32 *) RTA_DATA(tb[TCA_TCINDEX_CLASSID-1]);
323 tcf_bind_filter(tp, &cr.res, base);
326 tcf_exts_change(tp, &cr.exts, &e);
329 if (old_r && old_r != r)
330 memset(old_r, 0, sizeof(*old_r));
332 memcpy(p, &cp, sizeof(cp));
333 memcpy(r, &cr, sizeof(cr));
335 if (r == &new_filter_result) {
336 struct tcindex_filter **fp;
339 f->result = new_filter_result;
341 for (fp = p->h+(handle % p->hash); *fp; fp = &(*fp)->next)
352 else if (balloc == 2)
355 tcf_exts_destroy(tp, &e);
360 tcindex_change(struct tcf_proto *tp, unsigned long base, u32 handle,
361 struct rtattr **tca, unsigned long *arg)
363 struct rtattr *opt = tca[TCA_OPTIONS-1];
364 struct rtattr *tb[TCA_TCINDEX_MAX];
365 struct tcindex_data *p = PRIV(tp);
366 struct tcindex_filter_result *r = (struct tcindex_filter_result *) *arg;
368 DPRINTK("tcindex_change(tp %p,handle 0x%08x,tca %p,arg %p),opt %p,"
369 "p %p,r %p,*arg 0x%lx\n",
370 tp, handle, tca, arg, opt, p, r, arg ? *arg : 0L);
375 if (rtattr_parse_nested(tb, TCA_TCINDEX_MAX, opt) < 0)
378 return tcindex_set_parms(tp, base, handle, p, r, tb, tca[TCA_RATE-1]);
382 static void tcindex_walk(struct tcf_proto *tp, struct tcf_walker *walker)
384 struct tcindex_data *p = PRIV(tp);
385 struct tcindex_filter *f,*next;
388 DPRINTK("tcindex_walk(tp %p,walker %p),p %p\n",tp,walker,p);
390 for (i = 0; i < p->hash; i++) {
391 if (!p->perfect[i].res.class)
393 if (walker->count >= walker->skip) {
395 (unsigned long) (p->perfect+i), walker)
406 for (i = 0; i < p->hash; i++) {
407 for (f = p->h[i]; f; f = next) {
409 if (walker->count >= walker->skip) {
410 if (walker->fn(tp,(unsigned long) &f->result,
422 static int tcindex_destroy_element(struct tcf_proto *tp,
423 unsigned long arg, struct tcf_walker *walker)
425 return __tcindex_delete(tp, arg, 0);
429 static void tcindex_destroy(struct tcf_proto *tp)
431 struct tcindex_data *p = PRIV(tp);
432 struct tcf_walker walker;
434 DPRINTK("tcindex_destroy(tp %p),p %p\n",tp,p);
437 walker.fn = &tcindex_destroy_element;
438 tcindex_walk(tp,&walker);
446 static int tcindex_dump(struct tcf_proto *tp, unsigned long fh,
447 struct sk_buff *skb, struct tcmsg *t)
449 struct tcindex_data *p = PRIV(tp);
450 struct tcindex_filter_result *r = (struct tcindex_filter_result *) fh;
451 unsigned char *b = skb->tail;
454 DPRINTK("tcindex_dump(tp %p,fh 0x%lx,skb %p,t %p),p %p,r %p,b %p\n",
456 DPRINTK("p->perfect %p p->h %p\n",p->perfect,p->h);
457 rta = (struct rtattr *) b;
458 RTA_PUT(skb,TCA_OPTIONS,0,NULL);
460 t->tcm_handle = ~0; /* whatever ... */
461 RTA_PUT(skb,TCA_TCINDEX_HASH,sizeof(p->hash),&p->hash);
462 RTA_PUT(skb,TCA_TCINDEX_MASK,sizeof(p->mask),&p->mask);
463 RTA_PUT(skb,TCA_TCINDEX_SHIFT,sizeof(p->shift),&p->shift);
464 RTA_PUT(skb,TCA_TCINDEX_FALL_THROUGH,sizeof(p->fall_through),
466 rta->rta_len = skb->tail-b;
469 t->tcm_handle = r-p->perfect;
471 struct tcindex_filter *f;
475 for (i = 0; !t->tcm_handle && i < p->hash; i++) {
476 for (f = p->h[i]; !t->tcm_handle && f;
479 t->tcm_handle = f->key;
483 DPRINTK("handle = %d\n",t->tcm_handle);
485 RTA_PUT(skb, TCA_TCINDEX_CLASSID, 4, &r->res.classid);
487 if (tcf_exts_dump(skb, &r->exts, &tcindex_ext_map) < 0)
489 rta->rta_len = skb->tail-b;
491 if (tcf_exts_dump_stats(skb, &r->exts, &tcindex_ext_map) < 0)
498 skb_trim(skb, b - skb->data);
502 static struct tcf_proto_ops cls_tcindex_ops = {
505 .classify = tcindex_classify,
506 .init = tcindex_init,
507 .destroy = tcindex_destroy,
510 .change = tcindex_change,
511 .delete = tcindex_delete,
512 .walk = tcindex_walk,
513 .dump = tcindex_dump,
514 .owner = THIS_MODULE,
517 static int __init init_tcindex(void)
519 return register_tcf_proto_ops(&cls_tcindex_ops);
522 static void __exit exit_tcindex(void)
524 unregister_tcf_proto_ops(&cls_tcindex_ops);
527 module_init(init_tcindex)
528 module_exit(exit_tcindex)
529 MODULE_LICENSE("GPL");