1 // SPDX-License-Identifier: GPL-2.0-only
3 * net/sched/cls_tcindex.c Packet classifier for skb->tc_index
5 * Written 1998,1999 by Werner Almesberger, EPFL ICA
8 #include <linux/module.h>
9 #include <linux/types.h>
10 #include <linux/kernel.h>
11 #include <linux/skbuff.h>
12 #include <linux/errno.h>
13 #include <linux/slab.h>
14 #include <net/act_api.h>
15 #include <net/netlink.h>
16 #include <net/pkt_cls.h>
17 #include <net/sch_generic.h>
20 * Passing parameters to the root seems to be done more awkwardly than really
21 * necessary. At least, u32 doesn't seem to use such dirty hacks. To be
25 #define PERFECT_HASH_THRESHOLD 64 /* use perfect hash if not bigger */
26 #define DEFAULT_HASH_SIZE 64 /* optimized for diffserv */
29 struct tcindex_filter_result
{
31 struct tcf_result res
;
32 struct rcu_work rwork
;
35 struct tcindex_filter
{
37 struct tcindex_filter_result result
;
38 struct tcindex_filter __rcu
*next
;
39 struct rcu_work rwork
;
44 struct tcindex_filter_result
*perfect
; /* perfect hash; NULL if none */
45 struct tcindex_filter __rcu
**h
; /* imperfect hash; */
47 u16 mask
; /* AND key with mask */
48 u32 shift
; /* shift ANDed key to the right */
49 u32 hash
; /* hash table size; 0 if undefined */
50 u32 alloc_hash
; /* allocated size */
51 u32 fall_through
; /* 0: only classify if explicit match */
52 struct rcu_work rwork
;
55 static inline int tcindex_filter_is_set(struct tcindex_filter_result
*r
)
57 return tcf_exts_has_actions(&r
->exts
) || r
->res
.classid
;
60 static struct tcindex_filter_result
*tcindex_lookup(struct tcindex_data
*p
,
64 struct tcindex_filter_result
*f
= p
->perfect
+ key
;
66 return tcindex_filter_is_set(f
) ? f
: NULL
;
68 struct tcindex_filter __rcu
**fp
;
69 struct tcindex_filter
*f
;
71 fp
= &p
->h
[key
% p
->hash
];
72 for (f
= rcu_dereference_bh_rtnl(*fp
);
74 fp
= &f
->next
, f
= rcu_dereference_bh_rtnl(*fp
))
83 static int tcindex_classify(struct sk_buff
*skb
, const struct tcf_proto
*tp
,
84 struct tcf_result
*res
)
86 struct tcindex_data
*p
= rcu_dereference_bh(tp
->root
);
87 struct tcindex_filter_result
*f
;
88 int key
= (skb
->tc_index
& p
->mask
) >> p
->shift
;
90 pr_debug("tcindex_classify(skb %p,tp %p,res %p),p %p\n",
93 f
= tcindex_lookup(p
, key
);
95 struct Qdisc
*q
= tcf_block_q(tp
->chain
->block
);
99 res
->classid
= TC_H_MAKE(TC_H_MAJ(q
->handle
), key
);
101 pr_debug("alg 0x%x\n", res
->classid
);
105 pr_debug("map 0x%x\n", res
->classid
);
107 return tcf_exts_exec(skb
, &f
->exts
, res
);
111 static void *tcindex_get(struct tcf_proto
*tp
, u32 handle
)
113 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
114 struct tcindex_filter_result
*r
;
116 pr_debug("tcindex_get(tp %p,handle 0x%08x)\n", tp
, handle
);
117 if (p
->perfect
&& handle
>= p
->alloc_hash
)
119 r
= tcindex_lookup(p
, handle
);
120 return r
&& tcindex_filter_is_set(r
) ? r
: NULL
;
123 static int tcindex_init(struct tcf_proto
*tp
)
125 struct tcindex_data
*p
;
127 pr_debug("tcindex_init(tp %p)\n", tp
);
128 p
= kzalloc(sizeof(struct tcindex_data
), GFP_KERNEL
);
133 p
->hash
= DEFAULT_HASH_SIZE
;
136 rcu_assign_pointer(tp
->root
, p
);
140 static void __tcindex_destroy_rexts(struct tcindex_filter_result
*r
)
142 tcf_exts_destroy(&r
->exts
);
143 tcf_exts_put_net(&r
->exts
);
146 static void tcindex_destroy_rexts_work(struct work_struct
*work
)
148 struct tcindex_filter_result
*r
;
150 r
= container_of(to_rcu_work(work
),
151 struct tcindex_filter_result
,
154 __tcindex_destroy_rexts(r
);
158 static void __tcindex_destroy_fexts(struct tcindex_filter
*f
)
160 tcf_exts_destroy(&f
->result
.exts
);
161 tcf_exts_put_net(&f
->result
.exts
);
165 static void tcindex_destroy_fexts_work(struct work_struct
*work
)
167 struct tcindex_filter
*f
= container_of(to_rcu_work(work
),
168 struct tcindex_filter
,
172 __tcindex_destroy_fexts(f
);
176 static int tcindex_delete(struct tcf_proto
*tp
, void *arg
, bool *last
,
177 bool rtnl_held
, struct netlink_ext_ack
*extack
)
179 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
180 struct tcindex_filter_result
*r
= arg
;
181 struct tcindex_filter __rcu
**walk
;
182 struct tcindex_filter
*f
= NULL
;
184 pr_debug("tcindex_delete(tp %p,arg %p),p %p\n", tp
, arg
, p
);
191 for (i
= 0; i
< p
->hash
; i
++) {
193 for (f
= rtnl_dereference(*walk
); f
;
194 walk
= &f
->next
, f
= rtnl_dereference(*walk
)) {
202 rcu_assign_pointer(*walk
, rtnl_dereference(f
->next
));
204 tcf_unbind_filter(tp
, &r
->res
);
205 /* all classifiers are required to call tcf_exts_destroy() after rcu
206 * grace period, since converted-to-rcu actions are relying on that
207 * in cleanup() callback
210 if (tcf_exts_get_net(&f
->result
.exts
))
211 tcf_queue_work(&f
->rwork
, tcindex_destroy_fexts_work
);
213 __tcindex_destroy_fexts(f
);
215 if (tcf_exts_get_net(&r
->exts
))
216 tcf_queue_work(&r
->rwork
, tcindex_destroy_rexts_work
);
218 __tcindex_destroy_rexts(r
);
225 static void tcindex_destroy_work(struct work_struct
*work
)
227 struct tcindex_data
*p
= container_of(to_rcu_work(work
),
237 valid_perfect_hash(struct tcindex_data
*p
)
239 return p
->hash
> (p
->mask
>> p
->shift
);
242 static const struct nla_policy tcindex_policy
[TCA_TCINDEX_MAX
+ 1] = {
243 [TCA_TCINDEX_HASH
] = { .type
= NLA_U32
},
244 [TCA_TCINDEX_MASK
] = { .type
= NLA_U16
},
245 [TCA_TCINDEX_SHIFT
] = { .type
= NLA_U32
},
246 [TCA_TCINDEX_FALL_THROUGH
] = { .type
= NLA_U32
},
247 [TCA_TCINDEX_CLASSID
] = { .type
= NLA_U32
},
250 static int tcindex_filter_result_init(struct tcindex_filter_result
*r
,
253 memset(r
, 0, sizeof(*r
));
254 return tcf_exts_init(&r
->exts
, net
, TCA_TCINDEX_ACT
,
258 static void tcindex_partial_destroy_work(struct work_struct
*work
)
260 struct tcindex_data
*p
= container_of(to_rcu_work(work
),
268 static void tcindex_free_perfect_hash(struct tcindex_data
*cp
)
272 for (i
= 0; i
< cp
->hash
; i
++)
273 tcf_exts_destroy(&cp
->perfect
[i
].exts
);
277 static int tcindex_alloc_perfect_hash(struct net
*net
, struct tcindex_data
*cp
)
281 cp
->perfect
= kcalloc(cp
->hash
, sizeof(struct tcindex_filter_result
),
286 for (i
= 0; i
< cp
->hash
; i
++) {
287 err
= tcf_exts_init(&cp
->perfect
[i
].exts
, net
,
288 TCA_TCINDEX_ACT
, TCA_TCINDEX_POLICE
);
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
, net
, TCA_TCINDEX_ACT
, TCA_TCINDEX_POLICE
);
316 err
= tcf_exts_validate(net
, tp
, tb
, est
, &e
, ovr
, true, 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
;
339 if (tcindex_alloc_perfect_hash(net
, cp
) < 0)
341 for (i
= 0; i
< cp
->hash
; i
++)
342 cp
->perfect
[i
].res
= p
->perfect
[i
].res
;
347 err
= tcindex_filter_result_init(&new_filter_result
, net
);
353 if (tb
[TCA_TCINDEX_HASH
])
354 cp
->hash
= nla_get_u32(tb
[TCA_TCINDEX_HASH
]);
356 if (tb
[TCA_TCINDEX_MASK
])
357 cp
->mask
= nla_get_u16(tb
[TCA_TCINDEX_MASK
]);
359 if (tb
[TCA_TCINDEX_SHIFT
])
360 cp
->shift
= nla_get_u32(tb
[TCA_TCINDEX_SHIFT
]);
364 /* Hash already allocated, make sure that we still meet the
365 * requirements for the allocated hash.
368 if (!valid_perfect_hash(cp
) ||
369 cp
->hash
> cp
->alloc_hash
)
371 } else if (cp
->h
&& cp
->hash
!= cp
->alloc_hash
) {
376 if (tb
[TCA_TCINDEX_FALL_THROUGH
])
377 cp
->fall_through
= nla_get_u32(tb
[TCA_TCINDEX_FALL_THROUGH
]);
380 /* Hash not specified, use perfect hash if the upper limit
381 * of the hashing index is below the threshold.
383 if ((cp
->mask
>> cp
->shift
) < PERFECT_HASH_THRESHOLD
)
384 cp
->hash
= (cp
->mask
>> cp
->shift
) + 1;
386 cp
->hash
= DEFAULT_HASH_SIZE
;
389 if (!cp
->perfect
&& !cp
->h
)
390 cp
->alloc_hash
= cp
->hash
;
392 /* Note: this could be as restrictive as if (handle & ~(mask >> shift))
393 * but then, we'd fail handles that may become valid after some future
394 * mask change. While this is extremely unlikely to ever matter,
395 * the check below is safer (and also more backwards-compatible).
397 if (cp
->perfect
|| valid_perfect_hash(cp
))
398 if (handle
>= cp
->alloc_hash
)
403 if (!cp
->perfect
&& !cp
->h
) {
404 if (valid_perfect_hash(cp
)) {
405 if (tcindex_alloc_perfect_hash(net
, cp
) < 0)
409 struct tcindex_filter __rcu
**hash
;
411 hash
= kcalloc(cp
->hash
,
412 sizeof(struct tcindex_filter
*),
424 r
= cp
->perfect
+ handle
;
426 r
= tcindex_lookup(cp
, handle
) ? : &new_filter_result
;
428 if (r
== &new_filter_result
) {
429 f
= kzalloc(sizeof(*f
), GFP_KERNEL
);
434 err
= tcindex_filter_result_init(&f
->result
, net
);
441 if (tb
[TCA_TCINDEX_CLASSID
]) {
442 cr
.classid
= nla_get_u32(tb
[TCA_TCINDEX_CLASSID
]);
443 tcf_bind_filter(tp
, &cr
, base
);
446 if (old_r
&& old_r
!= r
) {
447 err
= tcindex_filter_result_init(old_r
, net
);
456 tcf_exts_change(&r
->exts
, &e
);
458 rcu_assign_pointer(tp
->root
, cp
);
460 if (r
== &new_filter_result
) {
461 struct tcindex_filter
*nfp
;
462 struct tcindex_filter __rcu
**fp
;
464 f
->result
.res
= r
->res
;
465 tcf_exts_change(&f
->result
.exts
, &r
->exts
);
467 fp
= cp
->h
+ (handle
% cp
->hash
);
468 for (nfp
= rtnl_dereference(*fp
);
470 fp
= &nfp
->next
, nfp
= rtnl_dereference(*fp
))
473 rcu_assign_pointer(*fp
, f
);
475 tcf_exts_destroy(&new_filter_result
.exts
);
479 tcf_queue_work(&oldp
->rwork
, tcindex_partial_destroy_work
);
484 tcindex_free_perfect_hash(cp
);
485 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 bool rtnl_held
, 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_deprecated(tb
, TCA_TCINDEX_MAX
, opt
,
515 tcindex_policy
, NULL
);
519 return tcindex_set_parms(net
, tp
, base
, handle
, p
, r
, tb
,
520 tca
[TCA_RATE
], ovr
, extack
);
523 static void tcindex_walk(struct tcf_proto
*tp
, struct tcf_walker
*walker
,
526 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
527 struct tcindex_filter
*f
, *next
;
530 pr_debug("tcindex_walk(tp %p,walker %p),p %p\n", tp
, walker
, p
);
532 for (i
= 0; i
< p
->hash
; i
++) {
533 if (!p
->perfect
[i
].res
.class)
535 if (walker
->count
>= walker
->skip
) {
536 if (walker
->fn(tp
, p
->perfect
+ i
, walker
) < 0) {
546 for (i
= 0; i
< p
->hash
; i
++) {
547 for (f
= rtnl_dereference(p
->h
[i
]); f
; f
= next
) {
548 next
= rtnl_dereference(f
->next
);
549 if (walker
->count
>= walker
->skip
) {
550 if (walker
->fn(tp
, &f
->result
, walker
) < 0) {
560 static void tcindex_destroy(struct tcf_proto
*tp
, bool rtnl_held
,
561 struct netlink_ext_ack
*extack
)
563 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
566 pr_debug("tcindex_destroy(tp %p),p %p\n", tp
, p
);
569 for (i
= 0; i
< p
->hash
; i
++) {
570 struct tcindex_filter_result
*r
= p
->perfect
+ i
;
572 tcf_unbind_filter(tp
, &r
->res
);
573 if (tcf_exts_get_net(&r
->exts
))
574 tcf_queue_work(&r
->rwork
,
575 tcindex_destroy_rexts_work
);
577 __tcindex_destroy_rexts(r
);
581 for (i
= 0; p
->h
&& i
< p
->hash
; i
++) {
582 struct tcindex_filter
*f
, *next
;
585 for (f
= rtnl_dereference(p
->h
[i
]); f
; f
= next
) {
586 next
= rtnl_dereference(f
->next
);
587 tcindex_delete(tp
, &f
->result
, &last
, rtnl_held
, NULL
);
591 tcf_queue_work(&p
->rwork
, tcindex_destroy_work
);
595 static int tcindex_dump(struct net
*net
, struct tcf_proto
*tp
, void *fh
,
596 struct sk_buff
*skb
, struct tcmsg
*t
, bool rtnl_held
)
598 struct tcindex_data
*p
= rtnl_dereference(tp
->root
);
599 struct tcindex_filter_result
*r
= fh
;
602 pr_debug("tcindex_dump(tp %p,fh %p,skb %p,t %p),p %p,r %p\n",
603 tp
, fh
, skb
, t
, p
, r
);
604 pr_debug("p->perfect %p p->h %p\n", p
->perfect
, p
->h
);
606 nest
= nla_nest_start_noflag(skb
, TCA_OPTIONS
);
608 goto nla_put_failure
;
611 t
->tcm_handle
= ~0; /* whatever ... */
612 if (nla_put_u32(skb
, TCA_TCINDEX_HASH
, p
->hash
) ||
613 nla_put_u16(skb
, TCA_TCINDEX_MASK
, p
->mask
) ||
614 nla_put_u32(skb
, TCA_TCINDEX_SHIFT
, p
->shift
) ||
615 nla_put_u32(skb
, TCA_TCINDEX_FALL_THROUGH
, p
->fall_through
))
616 goto nla_put_failure
;
617 nla_nest_end(skb
, nest
);
620 t
->tcm_handle
= r
- p
->perfect
;
622 struct tcindex_filter
*f
;
623 struct tcindex_filter __rcu
**fp
;
627 for (i
= 0; !t
->tcm_handle
&& i
< p
->hash
; i
++) {
629 for (f
= rtnl_dereference(*fp
);
631 fp
= &f
->next
, f
= rtnl_dereference(*fp
)) {
633 t
->tcm_handle
= f
->key
;
637 pr_debug("handle = %d\n", t
->tcm_handle
);
639 nla_put_u32(skb
, TCA_TCINDEX_CLASSID
, r
->res
.classid
))
640 goto nla_put_failure
;
642 if (tcf_exts_dump(skb
, &r
->exts
) < 0)
643 goto nla_put_failure
;
644 nla_nest_end(skb
, nest
);
646 if (tcf_exts_dump_stats(skb
, &r
->exts
) < 0)
647 goto nla_put_failure
;
653 nla_nest_cancel(skb
, nest
);
657 static void tcindex_bind_class(void *fh
, u32 classid
, unsigned long cl
)
659 struct tcindex_filter_result
*r
= fh
;
661 if (r
&& r
->res
.classid
== classid
)
665 static struct tcf_proto_ops cls_tcindex_ops __read_mostly
= {
667 .classify
= tcindex_classify
,
668 .init
= tcindex_init
,
669 .destroy
= tcindex_destroy
,
671 .change
= tcindex_change
,
672 .delete = tcindex_delete
,
673 .walk
= tcindex_walk
,
674 .dump
= tcindex_dump
,
675 .bind_class
= tcindex_bind_class
,
676 .owner
= THIS_MODULE
,
679 static int __init
init_tcindex(void)
681 return register_tcf_proto_ops(&cls_tcindex_ops
);
684 static void __exit
exit_tcindex(void)
686 unregister_tcf_proto_ops(&cls_tcindex_ops
);
689 module_init(init_tcindex
)
690 module_exit(exit_tcindex
)
691 MODULE_LICENSE("GPL");