2 * net/sched/cls_u32.c Ugly (or Universal) 32bit key Packet Classifier.
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.
9 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
11 * The filters are packed to hash tables of key nodes
12 * with a set of 32bit key/mask pairs at every node.
13 * Nodes reference next level hash tables etc.
15 * This scheme is the best universal classifier I managed to
16 * invent; it is not super-fast, but it is not slow (provided you
17 * program it correctly), and general enough. And its relative
18 * speed grows as the number of rules becomes larger.
20 * It seems that it represents the best middle point between
21 * speed and manageability both by human and by machine.
23 * It is especially useful for link sharing combined with QoS;
24 * pure RSVP doesn't need such a general approach and can use
25 * much simpler (and faster) schemes, sort of cls_rsvp.c.
27 * JHS: We should remove the CONFIG_NET_CLS_IND from here
28 * eventually when the meta match extension is made available
30 * nfmark match added by Catalin(ux aka Dino) BOIE <catab at umbrella.ro>
33 #include <linux/module.h>
34 #include <linux/types.h>
35 #include <linux/kernel.h>
36 #include <linux/string.h>
37 #include <linux/errno.h>
38 #include <linux/rtnetlink.h>
39 #include <linux/skbuff.h>
40 #include <net/netlink.h>
41 #include <net/act_api.h>
42 #include <net/pkt_cls.h>
46 struct tc_u_knode
*next
;
48 struct tc_u_hnode
*ht_up
;
50 #ifdef CONFIG_NET_CLS_IND
54 struct tcf_result res
;
55 struct tc_u_hnode
*ht_down
;
56 #ifdef CONFIG_CLS_U32_PERF
57 struct tc_u32_pcnt
*pf
;
59 #ifdef CONFIG_CLS_U32_MARK
60 struct tc_u32_mark mark
;
62 struct tc_u32_sel sel
;
67 struct tc_u_hnode
*next
;
70 struct tc_u_common
*tp_c
;
73 struct tc_u_knode
*ht
[1];
78 struct tc_u_hnode
*hlist
;
84 static const struct tcf_ext_map u32_ext_map
= {
85 .action
= TCA_U32_ACT
,
86 .police
= TCA_U32_POLICE
89 static __inline__
unsigned u32_hash_fold(__be32 key
, struct tc_u32_sel
*sel
, u8 fshift
)
91 unsigned h
= ntohl(key
& sel
->hmask
)>>fshift
;
96 static int u32_classify(struct sk_buff
*skb
, struct tcf_proto
*tp
, struct tcf_result
*res
)
99 struct tc_u_knode
*knode
;
101 } stack
[TC_U32_MAXDEPTH
];
103 struct tc_u_hnode
*ht
= (struct tc_u_hnode
*)tp
->root
;
104 u8
*ptr
= skb_network_header(skb
);
105 struct tc_u_knode
*n
;
109 #ifdef CONFIG_CLS_U32_PERF
119 struct tc_u32_key
*key
= n
->sel
.keys
;
121 #ifdef CONFIG_CLS_U32_PERF
126 #ifdef CONFIG_CLS_U32_MARK
127 if ((skb
->mark
& n
->mark
.mask
) != n
->mark
.val
) {
135 for (i
= n
->sel
.nkeys
; i
>0; i
--, key
++) {
137 if ((*(__be32
*)(ptr
+key
->off
+(off2
&key
->offmask
))^key
->val
)&key
->mask
) {
141 #ifdef CONFIG_CLS_U32_PERF
146 if (n
->ht_down
== NULL
) {
148 if (n
->sel
.flags
&TC_U32_TERMINAL
) {
151 #ifdef CONFIG_NET_CLS_IND
152 if (!tcf_match_indev(skb
, n
->indev
)) {
157 #ifdef CONFIG_CLS_U32_PERF
160 r
= tcf_exts_exec(skb
, &n
->exts
, res
);
173 if (sdepth
>= TC_U32_MAXDEPTH
)
175 stack
[sdepth
].knode
= n
;
176 stack
[sdepth
].ptr
= ptr
;
182 sel
= ht
->divisor
&u32_hash_fold(*(__be32
*)(ptr
+n
->sel
.hoff
), &n
->sel
,n
->fshift
);
184 if (!(n
->sel
.flags
&(TC_U32_VAROFFSET
|TC_U32_OFFSET
|TC_U32_EAT
)))
187 if (n
->sel
.flags
&(TC_U32_OFFSET
|TC_U32_VAROFFSET
)) {
188 off2
= n
->sel
.off
+ 3;
189 if (n
->sel
.flags
&TC_U32_VAROFFSET
)
190 off2
+= ntohs(n
->sel
.offmask
& *(__be16
*)(ptr
+n
->sel
.offoff
)) >>n
->sel
.offshift
;
193 if (n
->sel
.flags
&TC_U32_EAT
) {
198 if (ptr
< skb_tail_pointer(skb
))
204 n
= stack
[sdepth
].knode
;
206 ptr
= stack
[sdepth
].ptr
;
213 printk("cls_u32: dead loop\n");
217 static __inline__
struct tc_u_hnode
*
218 u32_lookup_ht(struct tc_u_common
*tp_c
, u32 handle
)
220 struct tc_u_hnode
*ht
;
222 for (ht
= tp_c
->hlist
; ht
; ht
= ht
->next
)
223 if (ht
->handle
== handle
)
229 static __inline__
struct tc_u_knode
*
230 u32_lookup_key(struct tc_u_hnode
*ht
, u32 handle
)
233 struct tc_u_knode
*n
= NULL
;
235 sel
= TC_U32_HASH(handle
);
236 if (sel
> ht
->divisor
)
239 for (n
= ht
->ht
[sel
]; n
; n
= n
->next
)
240 if (n
->handle
== handle
)
247 static unsigned long u32_get(struct tcf_proto
*tp
, u32 handle
)
249 struct tc_u_hnode
*ht
;
250 struct tc_u_common
*tp_c
= tp
->data
;
252 if (TC_U32_HTID(handle
) == TC_U32_ROOT
)
255 ht
= u32_lookup_ht(tp_c
, TC_U32_HTID(handle
));
260 if (TC_U32_KEY(handle
) == 0)
261 return (unsigned long)ht
;
263 return (unsigned long)u32_lookup_key(ht
, handle
);
266 static void u32_put(struct tcf_proto
*tp
, unsigned long f
)
270 static u32
gen_new_htid(struct tc_u_common
*tp_c
)
275 if (++tp_c
->hgenerator
== 0x7FF)
276 tp_c
->hgenerator
= 1;
277 } while (--i
>0 && u32_lookup_ht(tp_c
, (tp_c
->hgenerator
|0x800)<<20));
279 return i
> 0 ? (tp_c
->hgenerator
|0x800)<<20 : 0;
282 static int u32_init(struct tcf_proto
*tp
)
284 struct tc_u_hnode
*root_ht
;
285 struct tc_u_common
*tp_c
;
287 tp_c
= tp
->q
->u32_node
;
289 root_ht
= kzalloc(sizeof(*root_ht
), GFP_KERNEL
);
293 root_ht
->divisor
= 0;
295 root_ht
->handle
= tp_c
? gen_new_htid(tp_c
) : 0x80000000;
296 root_ht
->prio
= tp
->prio
;
299 tp_c
= kzalloc(sizeof(*tp_c
), GFP_KERNEL
);
305 tp
->q
->u32_node
= tp_c
;
309 root_ht
->next
= tp_c
->hlist
;
310 tp_c
->hlist
= root_ht
;
311 root_ht
->tp_c
= tp_c
;
318 static int u32_destroy_key(struct tcf_proto
*tp
, struct tc_u_knode
*n
)
320 tcf_unbind_filter(tp
, &n
->res
);
321 tcf_exts_destroy(tp
, &n
->exts
);
323 n
->ht_down
->refcnt
--;
324 #ifdef CONFIG_CLS_U32_PERF
331 static int u32_delete_key(struct tcf_proto
*tp
, struct tc_u_knode
* key
)
333 struct tc_u_knode
**kp
;
334 struct tc_u_hnode
*ht
= key
->ht_up
;
337 for (kp
= &ht
->ht
[TC_U32_HASH(key
->handle
)]; *kp
; kp
= &(*kp
)->next
) {
343 u32_destroy_key(tp
, key
);
352 static void u32_clear_hnode(struct tcf_proto
*tp
, struct tc_u_hnode
*ht
)
354 struct tc_u_knode
*n
;
357 for (h
=0; h
<=ht
->divisor
; h
++) {
358 while ((n
= ht
->ht
[h
]) != NULL
) {
361 u32_destroy_key(tp
, n
);
366 static int u32_destroy_hnode(struct tcf_proto
*tp
, struct tc_u_hnode
*ht
)
368 struct tc_u_common
*tp_c
= tp
->data
;
369 struct tc_u_hnode
**hn
;
373 u32_clear_hnode(tp
, ht
);
375 for (hn
= &tp_c
->hlist
; *hn
; hn
= &(*hn
)->next
) {
387 static void u32_destroy(struct tcf_proto
*tp
)
389 struct tc_u_common
*tp_c
= tp
->data
;
390 struct tc_u_hnode
*root_ht
= xchg(&tp
->root
, NULL
);
392 WARN_ON(root_ht
== NULL
);
394 if (root_ht
&& --root_ht
->refcnt
== 0)
395 u32_destroy_hnode(tp
, root_ht
);
397 if (--tp_c
->refcnt
== 0) {
398 struct tc_u_hnode
*ht
;
400 tp
->q
->u32_node
= NULL
;
402 for (ht
= tp_c
->hlist
; ht
; ht
= ht
->next
) {
404 u32_clear_hnode(tp
, ht
);
407 while ((ht
= tp_c
->hlist
) != NULL
) {
408 tp_c
->hlist
= ht
->next
;
410 WARN_ON(ht
->refcnt
!= 0);
421 static int u32_delete(struct tcf_proto
*tp
, unsigned long arg
)
423 struct tc_u_hnode
*ht
= (struct tc_u_hnode
*)arg
;
428 if (TC_U32_KEY(ht
->handle
))
429 return u32_delete_key(tp
, (struct tc_u_knode
*)ht
);
434 if (ht
->refcnt
== 1) {
436 u32_destroy_hnode(tp
, ht
);
444 static u32
gen_new_kid(struct tc_u_hnode
*ht
, u32 handle
)
446 struct tc_u_knode
*n
;
449 for (n
=ht
->ht
[TC_U32_HASH(handle
)]; n
; n
= n
->next
)
450 if (i
< TC_U32_NODE(n
->handle
))
451 i
= TC_U32_NODE(n
->handle
);
454 return handle
|(i
>0xFFF ? 0xFFF : i
);
457 static const struct nla_policy u32_policy
[TCA_U32_MAX
+ 1] = {
458 [TCA_U32_CLASSID
] = { .type
= NLA_U32
},
459 [TCA_U32_HASH
] = { .type
= NLA_U32
},
460 [TCA_U32_LINK
] = { .type
= NLA_U32
},
461 [TCA_U32_DIVISOR
] = { .type
= NLA_U32
},
462 [TCA_U32_SEL
] = { .len
= sizeof(struct tc_u32_sel
) },
463 [TCA_U32_INDEV
] = { .type
= NLA_STRING
, .len
= IFNAMSIZ
},
464 [TCA_U32_MARK
] = { .len
= sizeof(struct tc_u32_mark
) },
467 static int u32_set_parms(struct tcf_proto
*tp
, unsigned long base
,
468 struct tc_u_hnode
*ht
,
469 struct tc_u_knode
*n
, struct nlattr
**tb
,
475 err
= tcf_exts_validate(tp
, tb
, est
, &e
, &u32_ext_map
);
480 if (tb
[TCA_U32_LINK
]) {
481 u32 handle
= nla_get_u32(tb
[TCA_U32_LINK
]);
482 struct tc_u_hnode
*ht_down
= NULL
;
484 if (TC_U32_KEY(handle
))
488 ht_down
= u32_lookup_ht(ht
->tp_c
, handle
);
496 ht_down
= xchg(&n
->ht_down
, ht_down
);
502 if (tb
[TCA_U32_CLASSID
]) {
503 n
->res
.classid
= nla_get_u32(tb
[TCA_U32_CLASSID
]);
504 tcf_bind_filter(tp
, &n
->res
, base
);
507 #ifdef CONFIG_NET_CLS_IND
508 if (tb
[TCA_U32_INDEV
]) {
509 err
= tcf_change_indev(tp
, n
->indev
, tb
[TCA_U32_INDEV
]);
514 tcf_exts_change(tp
, &n
->exts
, &e
);
518 tcf_exts_destroy(tp
, &e
);
522 static int u32_change(struct tcf_proto
*tp
, unsigned long base
, u32 handle
,
526 struct tc_u_common
*tp_c
= tp
->data
;
527 struct tc_u_hnode
*ht
;
528 struct tc_u_knode
*n
;
529 struct tc_u32_sel
*s
;
530 struct nlattr
*opt
= tca
[TCA_OPTIONS
];
531 struct nlattr
*tb
[TCA_U32_MAX
+ 1];
536 return handle
? -EINVAL
: 0;
538 err
= nla_parse_nested(tb
, TCA_U32_MAX
, opt
, u32_policy
);
542 if ((n
= (struct tc_u_knode
*)*arg
) != NULL
) {
543 if (TC_U32_KEY(n
->handle
) == 0)
546 return u32_set_parms(tp
, base
, n
->ht_up
, n
, tb
, tca
[TCA_RATE
]);
549 if (tb
[TCA_U32_DIVISOR
]) {
550 unsigned divisor
= nla_get_u32(tb
[TCA_U32_DIVISOR
]);
552 if (--divisor
> 0x100)
554 if (TC_U32_KEY(handle
))
557 handle
= gen_new_htid(tp
->data
);
561 ht
= kzalloc(sizeof(*ht
) + divisor
*sizeof(void*), GFP_KERNEL
);
566 ht
->divisor
= divisor
;
569 ht
->next
= tp_c
->hlist
;
571 *arg
= (unsigned long)ht
;
575 if (tb
[TCA_U32_HASH
]) {
576 htid
= nla_get_u32(tb
[TCA_U32_HASH
]);
577 if (TC_U32_HTID(htid
) == TC_U32_ROOT
) {
581 ht
= u32_lookup_ht(tp
->data
, TC_U32_HTID(htid
));
590 if (ht
->divisor
< TC_U32_HASH(htid
))
594 if (TC_U32_HTID(handle
) && TC_U32_HTID(handle
^htid
))
596 handle
= htid
| TC_U32_NODE(handle
);
598 handle
= gen_new_kid(ht
, htid
);
600 if (tb
[TCA_U32_SEL
] == NULL
)
603 s
= nla_data(tb
[TCA_U32_SEL
]);
605 n
= kzalloc(sizeof(*n
) + s
->nkeys
*sizeof(struct tc_u32_key
), GFP_KERNEL
);
609 #ifdef CONFIG_CLS_U32_PERF
610 n
->pf
= kzalloc(sizeof(struct tc_u32_pcnt
) + s
->nkeys
*sizeof(u64
), GFP_KERNEL
);
617 memcpy(&n
->sel
, s
, sizeof(*s
) + s
->nkeys
*sizeof(struct tc_u32_key
));
620 n
->fshift
= s
->hmask
? ffs(ntohl(s
->hmask
)) - 1 : 0;
622 #ifdef CONFIG_CLS_U32_MARK
623 if (tb
[TCA_U32_MARK
]) {
624 struct tc_u32_mark
*mark
;
626 mark
= nla_data(tb
[TCA_U32_MARK
]);
627 memcpy(&n
->mark
, mark
, sizeof(struct tc_u32_mark
));
632 err
= u32_set_parms(tp
, base
, ht
, n
, tb
, tca
[TCA_RATE
]);
634 struct tc_u_knode
**ins
;
635 for (ins
= &ht
->ht
[TC_U32_HASH(handle
)]; *ins
; ins
= &(*ins
)->next
)
636 if (TC_U32_NODE(handle
) < TC_U32_NODE((*ins
)->handle
))
643 *arg
= (unsigned long)n
;
646 #ifdef CONFIG_CLS_U32_PERF
653 static void u32_walk(struct tcf_proto
*tp
, struct tcf_walker
*arg
)
655 struct tc_u_common
*tp_c
= tp
->data
;
656 struct tc_u_hnode
*ht
;
657 struct tc_u_knode
*n
;
663 for (ht
= tp_c
->hlist
; ht
; ht
= ht
->next
) {
664 if (ht
->prio
!= tp
->prio
)
666 if (arg
->count
>= arg
->skip
) {
667 if (arg
->fn(tp
, (unsigned long)ht
, arg
) < 0) {
673 for (h
= 0; h
<= ht
->divisor
; h
++) {
674 for (n
= ht
->ht
[h
]; n
; n
= n
->next
) {
675 if (arg
->count
< arg
->skip
) {
679 if (arg
->fn(tp
, (unsigned long)n
, arg
) < 0) {
689 static int u32_dump(struct tcf_proto
*tp
, unsigned long fh
,
690 struct sk_buff
*skb
, struct tcmsg
*t
)
692 struct tc_u_knode
*n
= (struct tc_u_knode
*)fh
;
698 t
->tcm_handle
= n
->handle
;
700 nest
= nla_nest_start(skb
, TCA_OPTIONS
);
702 goto nla_put_failure
;
704 if (TC_U32_KEY(n
->handle
) == 0) {
705 struct tc_u_hnode
*ht
= (struct tc_u_hnode
*)fh
;
706 u32 divisor
= ht
->divisor
+1;
707 NLA_PUT_U32(skb
, TCA_U32_DIVISOR
, divisor
);
709 NLA_PUT(skb
, TCA_U32_SEL
,
710 sizeof(n
->sel
) + n
->sel
.nkeys
*sizeof(struct tc_u32_key
),
713 u32 htid
= n
->handle
& 0xFFFFF000;
714 NLA_PUT_U32(skb
, TCA_U32_HASH
, htid
);
717 NLA_PUT_U32(skb
, TCA_U32_CLASSID
, n
->res
.classid
);
719 NLA_PUT_U32(skb
, TCA_U32_LINK
, n
->ht_down
->handle
);
721 #ifdef CONFIG_CLS_U32_MARK
722 if (n
->mark
.val
|| n
->mark
.mask
)
723 NLA_PUT(skb
, TCA_U32_MARK
, sizeof(n
->mark
), &n
->mark
);
726 if (tcf_exts_dump(skb
, &n
->exts
, &u32_ext_map
) < 0)
727 goto nla_put_failure
;
729 #ifdef CONFIG_NET_CLS_IND
731 NLA_PUT_STRING(skb
, TCA_U32_INDEV
, n
->indev
);
733 #ifdef CONFIG_CLS_U32_PERF
734 NLA_PUT(skb
, TCA_U32_PCNT
,
735 sizeof(struct tc_u32_pcnt
) + n
->sel
.nkeys
*sizeof(u64
),
740 nla_nest_end(skb
, nest
);
742 if (TC_U32_KEY(n
->handle
))
743 if (tcf_exts_dump_stats(skb
, &n
->exts
, &u32_ext_map
) < 0)
744 goto nla_put_failure
;
748 nla_nest_cancel(skb
, nest
);
752 static struct tcf_proto_ops cls_u32_ops __read_mostly
= {
754 .classify
= u32_classify
,
756 .destroy
= u32_destroy
,
759 .change
= u32_change
,
760 .delete = u32_delete
,
763 .owner
= THIS_MODULE
,
766 static int __init
init_u32(void)
768 printk("u32 classifier\n");
769 #ifdef CONFIG_CLS_U32_PERF
770 printk(" Performance counters on\n");
772 #ifdef CONFIG_NET_CLS_IND
773 printk(" input device check on \n");
775 #ifdef CONFIG_NET_CLS_ACT
776 printk(" Actions configured \n");
778 return register_tcf_proto_ops(&cls_u32_ops
);
781 static void __exit
exit_u32(void)
783 unregister_tcf_proto_ops(&cls_u32_ops
);
786 module_init(init_u32
)
787 module_exit(exit_u32
)
788 MODULE_LICENSE("GPL");