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/slab.h>
13 #include <net/act_api.h>
14 #include <net/netlink.h>
15 #include <net/pkt_cls.h>
16 #include <net/sch_generic.h>
19 * Passing parameters to the root seems to be done more awkwardly than really
20 * necessary. At least, u32 doesn't seem to use such dirty hacks. To be
24 #define PERFECT_HASH_THRESHOLD 64 /* use perfect hash if not bigger */
25 #define DEFAULT_HASH_SIZE 64 /* optimized for diffserv */
28 struct tcindex_filter_result {
30 struct tcf_result res;
31 struct rcu_work rwork;
34 struct tcindex_filter {
36 struct tcindex_filter_result result;
37 struct tcindex_filter __rcu *next;
38 struct rcu_work rwork;
43 struct tcindex_filter_result *perfect; /* perfect hash; NULL if none */
44 struct tcindex_filter __rcu **h; /* imperfect hash; */
46 u16 mask; /* AND key with mask */
47 u32 shift; /* shift ANDed key to the right */
48 u32 hash; /* hash table size; 0 if undefined */
49 u32 alloc_hash; /* allocated size */
50 u32 fall_through; /* 0: only classify if explicit match */
54 static inline int tcindex_filter_is_set(struct tcindex_filter_result *r)
56 return tcf_exts_has_actions(&r->exts) || r->res.classid;
59 static struct tcindex_filter_result *tcindex_lookup(struct tcindex_data *p,
63 struct tcindex_filter_result *f = p->perfect + key;
65 return tcindex_filter_is_set(f) ? f : NULL;
67 struct tcindex_filter __rcu **fp;
68 struct tcindex_filter *f;
70 fp = &p->h[key % p->hash];
71 for (f = rcu_dereference_bh_rtnl(*fp);
73 fp = &f->next, f = rcu_dereference_bh_rtnl(*fp))
82 static int tcindex_classify(struct sk_buff *skb, const struct tcf_proto *tp,
83 struct tcf_result *res)
85 struct tcindex_data *p = rcu_dereference_bh(tp->root);
86 struct tcindex_filter_result *f;
87 int key = (skb->tc_index & p->mask) >> p->shift;
89 pr_debug("tcindex_classify(skb %p,tp %p,res %p),p %p\n",
92 f = tcindex_lookup(p, key);
94 struct Qdisc *q = tcf_block_q(tp->chain->block);
98 res->classid = TC_H_MAKE(TC_H_MAJ(q->handle), key);
100 pr_debug("alg 0x%x\n", res->classid);
104 pr_debug("map 0x%x\n", res->classid);
106 return tcf_exts_exec(skb, &f->exts, res);
110 static void *tcindex_get(struct tcf_proto *tp, u32 handle)
112 struct tcindex_data *p = rtnl_dereference(tp->root);
113 struct tcindex_filter_result *r;
115 pr_debug("tcindex_get(tp %p,handle 0x%08x)\n", tp, handle);
116 if (p->perfect && handle >= p->alloc_hash)
118 r = tcindex_lookup(p, handle);
119 return r && tcindex_filter_is_set(r) ? r : NULL;
122 static int tcindex_init(struct tcf_proto *tp)
124 struct tcindex_data *p;
126 pr_debug("tcindex_init(tp %p)\n", tp);
127 p = kzalloc(sizeof(struct tcindex_data), GFP_KERNEL);
132 p->hash = DEFAULT_HASH_SIZE;
135 rcu_assign_pointer(tp->root, p);
139 static void __tcindex_destroy_rexts(struct tcindex_filter_result *r)
141 tcf_exts_destroy(&r->exts);
142 tcf_exts_put_net(&r->exts);
145 static void tcindex_destroy_rexts_work(struct work_struct *work)
147 struct tcindex_filter_result *r;
149 r = container_of(to_rcu_work(work),
150 struct tcindex_filter_result,
153 __tcindex_destroy_rexts(r);
157 static void __tcindex_destroy_fexts(struct tcindex_filter *f)
159 tcf_exts_destroy(&f->result.exts);
160 tcf_exts_put_net(&f->result.exts);
164 static void tcindex_destroy_fexts_work(struct work_struct *work)
166 struct tcindex_filter *f = container_of(to_rcu_work(work),
167 struct tcindex_filter,
171 __tcindex_destroy_fexts(f);
175 static int tcindex_delete(struct tcf_proto *tp, void *arg, bool *last,
176 struct netlink_ext_ack *extack)
178 struct tcindex_data *p = rtnl_dereference(tp->root);
179 struct tcindex_filter_result *r = arg;
180 struct tcindex_filter __rcu **walk;
181 struct tcindex_filter *f = NULL;
183 pr_debug("tcindex_delete(tp %p,arg %p),p %p\n", tp, arg, p);
190 for (i = 0; i < p->hash; i++) {
192 for (f = rtnl_dereference(*walk); f;
193 walk = &f->next, f = rtnl_dereference(*walk)) {
201 rcu_assign_pointer(*walk, rtnl_dereference(f->next));
203 tcf_unbind_filter(tp, &r->res);
204 /* all classifiers are required to call tcf_exts_destroy() after rcu
205 * grace period, since converted-to-rcu actions are relying on that
206 * in cleanup() callback
209 if (tcf_exts_get_net(&f->result.exts))
210 tcf_queue_work(&f->rwork, tcindex_destroy_fexts_work);
212 __tcindex_destroy_fexts(f);
214 if (tcf_exts_get_net(&r->exts))
215 tcf_queue_work(&r->rwork, tcindex_destroy_rexts_work);
217 __tcindex_destroy_rexts(r);
224 static int tcindex_destroy_element(struct tcf_proto *tp,
225 void *arg, struct tcf_walker *walker)
229 return tcindex_delete(tp, arg, &last, NULL);
232 static void __tcindex_destroy(struct rcu_head *head)
234 struct tcindex_data *p = container_of(head, struct tcindex_data, rcu);
242 valid_perfect_hash(struct tcindex_data *p)
244 return p->hash > (p->mask >> p->shift);
247 static const struct nla_policy tcindex_policy[TCA_TCINDEX_MAX + 1] = {
248 [TCA_TCINDEX_HASH] = { .type = NLA_U32 },
249 [TCA_TCINDEX_MASK] = { .type = NLA_U16 },
250 [TCA_TCINDEX_SHIFT] = { .type = NLA_U32 },
251 [TCA_TCINDEX_FALL_THROUGH] = { .type = NLA_U32 },
252 [TCA_TCINDEX_CLASSID] = { .type = NLA_U32 },
255 static int tcindex_filter_result_init(struct tcindex_filter_result *r)
257 memset(r, 0, sizeof(*r));
258 return tcf_exts_init(&r->exts, TCA_TCINDEX_ACT, TCA_TCINDEX_POLICE);
261 static void __tcindex_partial_destroy(struct rcu_head *head)
263 struct tcindex_data *p = container_of(head, struct tcindex_data, rcu);
269 static void tcindex_free_perfect_hash(struct tcindex_data *cp)
273 for (i = 0; i < cp->hash; i++)
274 tcf_exts_destroy(&cp->perfect[i].exts);
278 static int tcindex_alloc_perfect_hash(struct tcindex_data *cp)
282 cp->perfect = kcalloc(cp->hash, sizeof(struct tcindex_filter_result),
287 for (i = 0; i < cp->hash; i++) {
288 err = tcf_exts_init(&cp->perfect[i].exts,
289 TCA_TCINDEX_ACT, TCA_TCINDEX_POLICE);
297 tcindex_free_perfect_hash(cp);
302 tcindex_set_parms(struct net *net, struct tcf_proto *tp, unsigned long base,
303 u32 handle, struct tcindex_data *p,
304 struct tcindex_filter_result *r, struct nlattr **tb,
305 struct nlattr *est, bool ovr, struct netlink_ext_ack *extack)
307 struct tcindex_filter_result new_filter_result, *old_r = r;
308 struct tcindex_filter_result cr;
309 struct tcindex_data *cp = NULL, *oldp;
310 struct tcindex_filter *f = NULL; /* make gcc behave */
314 err = tcf_exts_init(&e, TCA_TCINDEX_ACT, TCA_TCINDEX_POLICE);
317 err = tcf_exts_validate(net, tp, tb, est, &e, ovr, extack);
322 /* tcindex_data attributes must look atomic to classifier/lookup so
323 * allocate new tcindex data and RCU assign it onto root. Keeping
324 * perfect hash and hash pointers from old data.
326 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
331 cp->shift = p->shift;
333 cp->alloc_hash = p->alloc_hash;
334 cp->fall_through = p->fall_through;
340 if (tcindex_alloc_perfect_hash(cp) < 0)
342 for (i = 0; i < cp->hash; i++)
343 cp->perfect[i].res = p->perfect[i].res;
348 err = tcindex_filter_result_init(&new_filter_result);
351 err = tcindex_filter_result_init(&cr);
357 if (tb[TCA_TCINDEX_HASH])
358 cp->hash = nla_get_u32(tb[TCA_TCINDEX_HASH]);
360 if (tb[TCA_TCINDEX_MASK])
361 cp->mask = nla_get_u16(tb[TCA_TCINDEX_MASK]);
363 if (tb[TCA_TCINDEX_SHIFT])
364 cp->shift = nla_get_u32(tb[TCA_TCINDEX_SHIFT]);
368 /* Hash already allocated, make sure that we still meet the
369 * requirements for the allocated hash.
372 if (!valid_perfect_hash(cp) ||
373 cp->hash > cp->alloc_hash)
375 } else if (cp->h && cp->hash != cp->alloc_hash) {
380 if (tb[TCA_TCINDEX_FALL_THROUGH])
381 cp->fall_through = nla_get_u32(tb[TCA_TCINDEX_FALL_THROUGH]);
384 /* Hash not specified, use perfect hash if the upper limit
385 * of the hashing index is below the threshold.
387 if ((cp->mask >> cp->shift) < PERFECT_HASH_THRESHOLD)
388 cp->hash = (cp->mask >> cp->shift) + 1;
390 cp->hash = DEFAULT_HASH_SIZE;
393 if (!cp->perfect && !cp->h)
394 cp->alloc_hash = cp->hash;
396 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
397 * but then, we'd fail handles that may become valid after some future
398 * mask change. While this is extremely unlikely to ever matter,
399 * the check below is safer (and also more backwards-compatible).
401 if (cp->perfect || valid_perfect_hash(cp))
402 if (handle >= cp->alloc_hash)
407 if (!cp->perfect && !cp->h) {
408 if (valid_perfect_hash(cp)) {
409 if (tcindex_alloc_perfect_hash(cp) < 0)
413 struct tcindex_filter __rcu **hash;
415 hash = kcalloc(cp->hash,
416 sizeof(struct tcindex_filter *),
428 r = cp->perfect + handle;
430 r = tcindex_lookup(cp, handle) ? : &new_filter_result;
432 if (r == &new_filter_result) {
433 f = kzalloc(sizeof(*f), GFP_KERNEL);
438 err = tcindex_filter_result_init(&f->result);
445 if (tb[TCA_TCINDEX_CLASSID]) {
446 cr.res.classid = nla_get_u32(tb[TCA_TCINDEX_CLASSID]);
447 tcf_bind_filter(tp, &cr.res, base);
450 if (old_r && old_r != r) {
451 err = tcindex_filter_result_init(old_r);
460 tcf_exts_change(&r->exts, &e);
462 rcu_assign_pointer(tp->root, cp);
464 if (r == &new_filter_result) {
465 struct tcindex_filter *nfp;
466 struct tcindex_filter __rcu **fp;
468 f->result.res = r->res;
469 tcf_exts_change(&f->result.exts, &r->exts);
471 fp = cp->h + (handle % cp->hash);
472 for (nfp = rtnl_dereference(*fp);
474 fp = &nfp->next, nfp = rtnl_dereference(*fp))
477 rcu_assign_pointer(*fp, f);
481 call_rcu(&oldp->rcu, __tcindex_partial_destroy);
486 tcindex_free_perfect_hash(cp);
487 else if (balloc == 2)
490 tcf_exts_destroy(&cr.exts);
491 tcf_exts_destroy(&new_filter_result.exts);
494 tcf_exts_destroy(&e);
499 tcindex_change(struct net *net, struct sk_buff *in_skb,
500 struct tcf_proto *tp, unsigned long base, u32 handle,
501 struct nlattr **tca, void **arg, bool ovr,
502 struct netlink_ext_ack *extack)
504 struct nlattr *opt = tca[TCA_OPTIONS];
505 struct nlattr *tb[TCA_TCINDEX_MAX + 1];
506 struct tcindex_data *p = rtnl_dereference(tp->root);
507 struct tcindex_filter_result *r = *arg;
510 pr_debug("tcindex_change(tp %p,handle 0x%08x,tca %p,arg %p),opt %p,"
511 "p %p,r %p,*arg %p\n",
512 tp, handle, tca, arg, opt, p, r, arg ? *arg : NULL);
517 err = nla_parse_nested(tb, TCA_TCINDEX_MAX, opt, tcindex_policy, NULL);
521 return tcindex_set_parms(net, tp, base, handle, p, r, tb,
522 tca[TCA_RATE], ovr, extack);
525 static void tcindex_walk(struct tcf_proto *tp, struct tcf_walker *walker)
527 struct tcindex_data *p = rtnl_dereference(tp->root);
528 struct tcindex_filter *f, *next;
531 pr_debug("tcindex_walk(tp %p,walker %p),p %p\n", tp, walker, p);
533 for (i = 0; i < p->hash; i++) {
534 if (!p->perfect[i].res.class)
536 if (walker->count >= walker->skip) {
537 if (walker->fn(tp, p->perfect + i, walker) < 0) {
547 for (i = 0; i < p->hash; i++) {
548 for (f = rtnl_dereference(p->h[i]); f; f = next) {
549 next = rtnl_dereference(f->next);
550 if (walker->count >= walker->skip) {
551 if (walker->fn(tp, &f->result, walker) < 0) {
561 static void tcindex_destroy(struct tcf_proto *tp,
562 struct netlink_ext_ack *extack)
564 struct tcindex_data *p = rtnl_dereference(tp->root);
565 struct tcf_walker walker;
567 pr_debug("tcindex_destroy(tp %p),p %p\n", tp, p);
570 walker.fn = tcindex_destroy_element;
571 tcindex_walk(tp, &walker);
573 call_rcu(&p->rcu, __tcindex_destroy);
577 static int tcindex_dump(struct net *net, struct tcf_proto *tp, void *fh,
578 struct sk_buff *skb, struct tcmsg *t)
580 struct tcindex_data *p = rtnl_dereference(tp->root);
581 struct tcindex_filter_result *r = fh;
584 pr_debug("tcindex_dump(tp %p,fh %p,skb %p,t %p),p %p,r %p\n",
585 tp, fh, skb, t, p, r);
586 pr_debug("p->perfect %p p->h %p\n", p->perfect, p->h);
588 nest = nla_nest_start(skb, TCA_OPTIONS);
590 goto nla_put_failure;
593 t->tcm_handle = ~0; /* whatever ... */
594 if (nla_put_u32(skb, TCA_TCINDEX_HASH, p->hash) ||
595 nla_put_u16(skb, TCA_TCINDEX_MASK, p->mask) ||
596 nla_put_u32(skb, TCA_TCINDEX_SHIFT, p->shift) ||
597 nla_put_u32(skb, TCA_TCINDEX_FALL_THROUGH, p->fall_through))
598 goto nla_put_failure;
599 nla_nest_end(skb, nest);
602 t->tcm_handle = r - p->perfect;
604 struct tcindex_filter *f;
605 struct tcindex_filter __rcu **fp;
609 for (i = 0; !t->tcm_handle && i < p->hash; i++) {
611 for (f = rtnl_dereference(*fp);
613 fp = &f->next, f = rtnl_dereference(*fp)) {
615 t->tcm_handle = f->key;
619 pr_debug("handle = %d\n", t->tcm_handle);
621 nla_put_u32(skb, TCA_TCINDEX_CLASSID, r->res.classid))
622 goto nla_put_failure;
624 if (tcf_exts_dump(skb, &r->exts) < 0)
625 goto nla_put_failure;
626 nla_nest_end(skb, nest);
628 if (tcf_exts_dump_stats(skb, &r->exts) < 0)
629 goto nla_put_failure;
635 nla_nest_cancel(skb, nest);
639 static void tcindex_bind_class(void *fh, u32 classid, unsigned long cl)
641 struct tcindex_filter_result *r = fh;
643 if (r && r->res.classid == classid)
647 static struct tcf_proto_ops cls_tcindex_ops __read_mostly = {
649 .classify = tcindex_classify,
650 .init = tcindex_init,
651 .destroy = tcindex_destroy,
653 .change = tcindex_change,
654 .delete = tcindex_delete,
655 .walk = tcindex_walk,
656 .dump = tcindex_dump,
657 .bind_class = tcindex_bind_class,
658 .owner = THIS_MODULE,
661 static int __init init_tcindex(void)
663 return register_tcf_proto_ops(&cls_tcindex_ops);
666 static void __exit exit_tcindex(void)
668 unregister_tcf_proto_ops(&cls_tcindex_ops);
671 module_init(init_tcindex)
672 module_exit(exit_tcindex)
673 MODULE_LICENSE("GPL");