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 */
51 struct rcu_work rwork
;
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 void tcindex_destroy_work(struct work_struct
*work
)
226 struct tcindex_data
*p
= container_of(to_rcu_work(work
),
236 valid_perfect_hash(struct tcindex_data
*p
)
238 return p
->hash
> (p
->mask
>> p
->shift
);
241 static const struct nla_policy tcindex_policy
[TCA_TCINDEX_MAX
+ 1] = {
242 [TCA_TCINDEX_HASH
] = { .type
= NLA_U32
},
243 [TCA_TCINDEX_MASK
] = { .type
= NLA_U16
},
244 [TCA_TCINDEX_SHIFT
] = { .type
= NLA_U32
},
245 [TCA_TCINDEX_FALL_THROUGH
] = { .type
= NLA_U32
},
246 [TCA_TCINDEX_CLASSID
] = { .type
= NLA_U32
},
249 static int tcindex_filter_result_init(struct tcindex_filter_result
*r
)
251 memset(r
, 0, sizeof(*r
));
252 return tcf_exts_init(&r
->exts
, TCA_TCINDEX_ACT
, TCA_TCINDEX_POLICE
);
255 static void tcindex_partial_destroy_work(struct work_struct
*work
)
257 struct tcindex_data
*p
= container_of(to_rcu_work(work
),
265 static void tcindex_free_perfect_hash(struct tcindex_data
*cp
)
269 for (i
= 0; i
< cp
->hash
; i
++)
270 tcf_exts_destroy(&cp
->perfect
[i
].exts
);
274 static int tcindex_alloc_perfect_hash(struct net
*net
, struct tcindex_data
*cp
)
278 cp
->perfect
= kcalloc(cp
->hash
, sizeof(struct tcindex_filter_result
),
283 for (i
= 0; i
< cp
->hash
; i
++) {
284 err
= tcf_exts_init(&cp
->perfect
[i
].exts
,
285 TCA_TCINDEX_ACT
, TCA_TCINDEX_POLICE
);
288 #ifdef CONFIG_NET_CLS_ACT
289 cp
->perfect
[i
].exts
.net
= net
;
296 tcindex_free_perfect_hash(cp
);
301 tcindex_set_parms(struct net
*net
, struct tcf_proto
*tp
, unsigned long base
,
302 u32 handle
, struct tcindex_data
*p
,
303 struct tcindex_filter_result
*r
, struct nlattr
**tb
,
304 struct nlattr
*est
, bool ovr
, struct netlink_ext_ack
*extack
)
306 struct tcindex_filter_result new_filter_result
, *old_r
= r
;
307 struct tcindex_data
*cp
= NULL
, *oldp
;
308 struct tcindex_filter
*f
= NULL
; /* make gcc behave */
309 struct tcf_result cr
= {};
313 err
= tcf_exts_init(&e
, TCA_TCINDEX_ACT
, TCA_TCINDEX_POLICE
);
316 err
= tcf_exts_validate(net
, tp
, tb
, est
, &e
, ovr
, extack
);
321 /* tcindex_data attributes must look atomic to classifier/lookup so
322 * allocate new tcindex data and RCU assign it onto root. Keeping
323 * perfect hash and hash pointers from old data.
325 cp
= kzalloc(sizeof(*cp
), GFP_KERNEL
);
330 cp
->shift
= p
->shift
;
332 cp
->alloc_hash
= p
->alloc_hash
;
333 cp
->fall_through
= p
->fall_through
;
336 if (tb
[TCA_TCINDEX_HASH
])
337 cp
->hash
= nla_get_u32(tb
[TCA_TCINDEX_HASH
]);
339 if (tb
[TCA_TCINDEX_MASK
])
340 cp
->mask
= nla_get_u16(tb
[TCA_TCINDEX_MASK
]);
342 if (tb
[TCA_TCINDEX_SHIFT
])
343 cp
->shift
= nla_get_u32(tb
[TCA_TCINDEX_SHIFT
]);
346 /* Hash not specified, use perfect hash if the upper limit
347 * of the hashing index is below the threshold.
349 if ((cp
->mask
>> cp
->shift
) < PERFECT_HASH_THRESHOLD
)
350 cp
->hash
= (cp
->mask
>> cp
->shift
) + 1;
352 cp
->hash
= DEFAULT_HASH_SIZE
;
358 if (tcindex_alloc_perfect_hash(net
, cp
) < 0)
360 cp
->alloc_hash
= cp
->hash
;
361 for (i
= 0; i
< min(cp
->hash
, p
->hash
); i
++)
362 cp
->perfect
[i
].res
= p
->perfect
[i
].res
;
367 err
= tcindex_filter_result_init(&new_filter_result
);
375 /* Hash already allocated, make sure that we still meet the
376 * requirements for the allocated hash.
379 if (!valid_perfect_hash(cp
) ||
380 cp
->hash
> cp
->alloc_hash
)
382 } else if (cp
->h
&& cp
->hash
!= cp
->alloc_hash
) {
387 if (tb
[TCA_TCINDEX_FALL_THROUGH
])
388 cp
->fall_through
= nla_get_u32(tb
[TCA_TCINDEX_FALL_THROUGH
]);
390 if (!cp
->perfect
&& !cp
->h
)
391 cp
->alloc_hash
= cp
->hash
;
393 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
394 * but then, we'd fail handles that may become valid after some future
395 * mask change. While this is extremely unlikely to ever matter,
396 * the check below is safer (and also more backwards-compatible).
398 if (cp
->perfect
|| valid_perfect_hash(cp
))
399 if (handle
>= cp
->alloc_hash
)
404 if (!cp
->perfect
&& !cp
->h
) {
405 if (valid_perfect_hash(cp
)) {
406 if (tcindex_alloc_perfect_hash(net
, cp
) < 0)
410 struct tcindex_filter __rcu
**hash
;
412 hash
= kcalloc(cp
->hash
,
413 sizeof(struct tcindex_filter
*),
425 r
= cp
->perfect
+ handle
;
427 r
= tcindex_lookup(cp
, handle
) ? : &new_filter_result
;
429 if (r
== &new_filter_result
) {
430 f
= kzalloc(sizeof(*f
), GFP_KERNEL
);
435 err
= tcindex_filter_result_init(&f
->result
);
442 if (tb
[TCA_TCINDEX_CLASSID
]) {
443 cr
.classid
= nla_get_u32(tb
[TCA_TCINDEX_CLASSID
]);
444 tcf_bind_filter(tp
, &cr
, base
);
447 if (old_r
&& old_r
!= r
) {
448 err
= tcindex_filter_result_init(old_r
);
457 tcf_exts_change(&r
->exts
, &e
);
459 rcu_assign_pointer(tp
->root
, cp
);
461 if (r
== &new_filter_result
) {
462 struct tcindex_filter
*nfp
;
463 struct tcindex_filter __rcu
**fp
;
465 f
->result
.res
= r
->res
;
466 tcf_exts_change(&f
->result
.exts
, &r
->exts
);
468 fp
= cp
->h
+ (handle
% cp
->hash
);
469 for (nfp
= rtnl_dereference(*fp
);
471 fp
= &nfp
->next
, nfp
= rtnl_dereference(*fp
))
474 rcu_assign_pointer(*fp
, f
);
476 tcf_exts_destroy(&new_filter_result
.exts
);
480 tcf_queue_work(&oldp
->rwork
, tcindex_partial_destroy_work
);
485 tcindex_free_perfect_hash(cp
);
486 else if (balloc
== 2)
488 tcf_exts_destroy(&new_filter_result
.exts
);
491 tcf_exts_destroy(&e
);
496 tcindex_change(struct net
*net
, struct sk_buff
*in_skb
,
497 struct tcf_proto
*tp
, unsigned long base
, u32 handle
,
498 struct nlattr
**tca
, void **arg
, bool ovr
,
499 struct netlink_ext_ack
*extack
)
501 struct nlattr
*opt
= tca
[TCA_OPTIONS
];
502 struct nlattr
*tb
[TCA_TCINDEX_MAX
+ 1];
503 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
504 struct tcindex_filter_result
*r
= *arg
;
507 pr_debug("tcindex_change(tp %p,handle 0x%08x,tca %p,arg %p),opt %p,"
508 "p %p,r %p,*arg %p\n",
509 tp
, handle
, tca
, arg
, opt
, p
, r
, arg
? *arg
: NULL
);
514 err
= nla_parse_nested(tb
, TCA_TCINDEX_MAX
, opt
, tcindex_policy
, NULL
);
518 return tcindex_set_parms(net
, tp
, base
, handle
, p
, r
, tb
,
519 tca
[TCA_RATE
], ovr
, extack
);
522 static void tcindex_walk(struct tcf_proto
*tp
, struct tcf_walker
*walker
)
524 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
525 struct tcindex_filter
*f
, *next
;
528 pr_debug("tcindex_walk(tp %p,walker %p),p %p\n", tp
, walker
, p
);
530 for (i
= 0; i
< p
->hash
; i
++) {
531 if (!p
->perfect
[i
].res
.class)
533 if (walker
->count
>= walker
->skip
) {
534 if (walker
->fn(tp
, p
->perfect
+ i
, walker
) < 0) {
544 for (i
= 0; i
< p
->hash
; i
++) {
545 for (f
= rtnl_dereference(p
->h
[i
]); f
; f
= next
) {
546 next
= rtnl_dereference(f
->next
);
547 if (walker
->count
>= walker
->skip
) {
548 if (walker
->fn(tp
, &f
->result
, walker
) < 0) {
558 static void tcindex_destroy(struct tcf_proto
*tp
,
559 struct netlink_ext_ack
*extack
)
561 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
564 pr_debug("tcindex_destroy(tp %p),p %p\n", tp
, p
);
567 for (i
= 0; i
< p
->hash
; i
++) {
568 struct tcindex_filter_result
*r
= p
->perfect
+ i
;
570 tcf_unbind_filter(tp
, &r
->res
);
571 if (tcf_exts_get_net(&r
->exts
))
572 tcf_queue_work(&r
->rwork
,
573 tcindex_destroy_rexts_work
);
575 __tcindex_destroy_rexts(r
);
579 for (i
= 0; p
->h
&& i
< p
->hash
; i
++) {
580 struct tcindex_filter
*f
, *next
;
583 for (f
= rtnl_dereference(p
->h
[i
]); f
; f
= next
) {
584 next
= rtnl_dereference(f
->next
);
585 tcindex_delete(tp
, &f
->result
, &last
, NULL
);
589 tcf_queue_work(&p
->rwork
, tcindex_destroy_work
);
593 static int tcindex_dump(struct net
*net
, struct tcf_proto
*tp
, void *fh
,
594 struct sk_buff
*skb
, struct tcmsg
*t
)
596 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
597 struct tcindex_filter_result
*r
= fh
;
600 pr_debug("tcindex_dump(tp %p,fh %p,skb %p,t %p),p %p,r %p\n",
601 tp
, fh
, skb
, t
, p
, r
);
602 pr_debug("p->perfect %p p->h %p\n", p
->perfect
, p
->h
);
604 nest
= nla_nest_start(skb
, TCA_OPTIONS
);
606 goto nla_put_failure
;
609 t
->tcm_handle
= ~0; /* whatever ... */
610 if (nla_put_u32(skb
, TCA_TCINDEX_HASH
, p
->hash
) ||
611 nla_put_u16(skb
, TCA_TCINDEX_MASK
, p
->mask
) ||
612 nla_put_u32(skb
, TCA_TCINDEX_SHIFT
, p
->shift
) ||
613 nla_put_u32(skb
, TCA_TCINDEX_FALL_THROUGH
, p
->fall_through
))
614 goto nla_put_failure
;
615 nla_nest_end(skb
, nest
);
618 t
->tcm_handle
= r
- p
->perfect
;
620 struct tcindex_filter
*f
;
621 struct tcindex_filter __rcu
**fp
;
625 for (i
= 0; !t
->tcm_handle
&& i
< p
->hash
; i
++) {
627 for (f
= rtnl_dereference(*fp
);
629 fp
= &f
->next
, f
= rtnl_dereference(*fp
)) {
631 t
->tcm_handle
= f
->key
;
635 pr_debug("handle = %d\n", t
->tcm_handle
);
637 nla_put_u32(skb
, TCA_TCINDEX_CLASSID
, r
->res
.classid
))
638 goto nla_put_failure
;
640 if (tcf_exts_dump(skb
, &r
->exts
) < 0)
641 goto nla_put_failure
;
642 nla_nest_end(skb
, nest
);
644 if (tcf_exts_dump_stats(skb
, &r
->exts
) < 0)
645 goto nla_put_failure
;
651 nla_nest_cancel(skb
, nest
);
655 static void tcindex_bind_class(void *fh
, u32 classid
, unsigned long cl
,
656 void *q
, unsigned long base
)
658 struct tcindex_filter_result
*r
= fh
;
660 if (r
&& r
->res
.classid
== classid
) {
662 __tcf_bind_filter(q
, &r
->res
, base
);
664 __tcf_unbind_filter(q
, &r
->res
);
668 static struct tcf_proto_ops cls_tcindex_ops __read_mostly
= {
670 .classify
= tcindex_classify
,
671 .init
= tcindex_init
,
672 .destroy
= tcindex_destroy
,
674 .change
= tcindex_change
,
675 .delete = tcindex_delete
,
676 .walk
= tcindex_walk
,
677 .dump
= tcindex_dump
,
678 .bind_class
= tcindex_bind_class
,
679 .owner
= THIS_MODULE
,
682 static int __init
init_tcindex(void)
684 return register_tcf_proto_ops(&cls_tcindex_ops
);
687 static void __exit
exit_tcindex(void)
689 unregister_tcf_proto_ops(&cls_tcindex_ops
);
692 module_init(init_tcindex
)
693 module_exit(exit_tcindex
)
694 MODULE_LICENSE("GPL");