1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NET_PKT_CLS_H
3 #define __NET_PKT_CLS_H
5 #include <linux/pkt_cls.h>
6 #include <linux/workqueue.h>
7 #include <net/sch_generic.h>
8 #include <net/act_api.h>
10 /* Basic packet classifier frontend definitions. */
16 int (*fn
)(struct tcf_proto
*, void *node
, struct tcf_walker
*);
19 int register_tcf_proto_ops(struct tcf_proto_ops
*ops
);
20 int unregister_tcf_proto_ops(struct tcf_proto_ops
*ops
);
22 enum tcf_block_binder_type
{
23 TCF_BLOCK_BINDER_TYPE_UNSPEC
,
24 TCF_BLOCK_BINDER_TYPE_CLSACT_INGRESS
,
25 TCF_BLOCK_BINDER_TYPE_CLSACT_EGRESS
,
28 struct tcf_block_ext_info
{
29 enum tcf_block_binder_type binder_type
;
30 tcf_chain_head_change_t
*chain_head_change
;
31 void *chain_head_change_priv
;
35 bool tcf_queue_work(struct rcu_work
*rwork
, work_func_t func
);
38 struct tcf_chain
*tcf_chain_get(struct tcf_block
*block
, u32 chain_index
,
40 void tcf_chain_put(struct tcf_chain
*chain
);
41 int tcf_block_get(struct tcf_block
**p_block
,
42 struct tcf_proto __rcu
**p_filter_chain
, struct Qdisc
*q
);
43 int tcf_block_get_ext(struct tcf_block
**p_block
, struct Qdisc
*q
,
44 struct tcf_block_ext_info
*ei
);
45 void tcf_block_put(struct tcf_block
*block
);
46 void tcf_block_put_ext(struct tcf_block
*block
, struct Qdisc
*q
,
47 struct tcf_block_ext_info
*ei
);
49 static inline struct Qdisc
*tcf_block_q(struct tcf_block
*block
)
54 static inline struct net_device
*tcf_block_dev(struct tcf_block
*block
)
56 return tcf_block_q(block
)->dev_queue
->dev
;
59 void *tcf_block_cb_priv(struct tcf_block_cb
*block_cb
);
60 struct tcf_block_cb
*tcf_block_cb_lookup(struct tcf_block
*block
,
61 tc_setup_cb_t
*cb
, void *cb_ident
);
62 void tcf_block_cb_incref(struct tcf_block_cb
*block_cb
);
63 unsigned int tcf_block_cb_decref(struct tcf_block_cb
*block_cb
);
64 struct tcf_block_cb
*__tcf_block_cb_register(struct tcf_block
*block
,
65 tc_setup_cb_t
*cb
, void *cb_ident
,
67 int tcf_block_cb_register(struct tcf_block
*block
,
68 tc_setup_cb_t
*cb
, void *cb_ident
,
70 void __tcf_block_cb_unregister(struct tcf_block_cb
*block_cb
);
71 void tcf_block_cb_unregister(struct tcf_block
*block
,
72 tc_setup_cb_t
*cb
, void *cb_ident
);
74 int tcf_classify(struct sk_buff
*skb
, const struct tcf_proto
*tp
,
75 struct tcf_result
*res
, bool compat_mode
);
79 int tcf_block_get(struct tcf_block
**p_block
,
80 struct tcf_proto __rcu
**p_filter_chain
, struct Qdisc
*q
)
86 int tcf_block_get_ext(struct tcf_block
**p_block
, struct Qdisc
*q
,
87 struct tcf_block_ext_info
*ei
)
92 static inline void tcf_block_put(struct tcf_block
*block
)
97 void tcf_block_put_ext(struct tcf_block
*block
, struct Qdisc
*q
,
98 struct tcf_block_ext_info
*ei
)
102 static inline struct Qdisc
*tcf_block_q(struct tcf_block
*block
)
107 static inline struct net_device
*tcf_block_dev(struct tcf_block
*block
)
113 int tc_setup_cb_block_register(struct tcf_block
*block
, tc_setup_cb_t
*cb
,
120 void tc_setup_cb_block_unregister(struct tcf_block
*block
, tc_setup_cb_t
*cb
,
126 void *tcf_block_cb_priv(struct tcf_block_cb
*block_cb
)
132 struct tcf_block_cb
*tcf_block_cb_lookup(struct tcf_block
*block
,
133 tc_setup_cb_t
*cb
, void *cb_ident
)
139 void tcf_block_cb_incref(struct tcf_block_cb
*block_cb
)
144 unsigned int tcf_block_cb_decref(struct tcf_block_cb
*block_cb
)
150 struct tcf_block_cb
*__tcf_block_cb_register(struct tcf_block
*block
,
151 tc_setup_cb_t
*cb
, void *cb_ident
,
158 int tcf_block_cb_register(struct tcf_block
*block
,
159 tc_setup_cb_t
*cb
, void *cb_ident
,
166 void __tcf_block_cb_unregister(struct tcf_block_cb
*block_cb
)
171 void tcf_block_cb_unregister(struct tcf_block
*block
,
172 tc_setup_cb_t
*cb
, void *cb_ident
)
176 static inline int tcf_classify(struct sk_buff
*skb
, const struct tcf_proto
*tp
,
177 struct tcf_result
*res
, bool compat_mode
)
179 return TC_ACT_UNSPEC
;
183 static inline unsigned long
184 __cls_set_class(unsigned long *clp
, unsigned long cl
)
186 return xchg(clp
, cl
);
190 __tcf_bind_filter(struct Qdisc
*q
, struct tcf_result
*r
, unsigned long base
)
194 cl
= q
->ops
->cl_ops
->bind_tcf(q
, base
, r
->classid
);
195 cl
= __cls_set_class(&r
->class, cl
);
197 q
->ops
->cl_ops
->unbind_tcf(q
, cl
);
201 tcf_bind_filter(struct tcf_proto
*tp
, struct tcf_result
*r
, unsigned long base
)
203 struct Qdisc
*q
= tp
->chain
->block
->q
;
205 /* Check q as it is not set for shared blocks. In that case,
206 * setting class is not supported.
211 __tcf_bind_filter(q
, r
, base
);
216 __tcf_unbind_filter(struct Qdisc
*q
, struct tcf_result
*r
)
220 if ((cl
= __cls_set_class(&r
->class, 0)) != 0)
221 q
->ops
->cl_ops
->unbind_tcf(q
, cl
);
225 tcf_unbind_filter(struct tcf_proto
*tp
, struct tcf_result
*r
)
227 struct Qdisc
*q
= tp
->chain
->block
->q
;
231 __tcf_unbind_filter(q
, r
);
235 #ifdef CONFIG_NET_CLS_ACT
236 __u32 type
; /* for backward compat(TCA_OLD_COMPAT) */
238 struct tc_action
**actions
;
241 /* Map to export classifier specific extension TLV types to the
242 * generic extensions API. Unsupported extensions must be set to 0.
248 static inline int tcf_exts_init(struct tcf_exts
*exts
, struct net
*net
,
249 int action
, int police
)
251 #ifdef CONFIG_NET_CLS_ACT
253 exts
->nr_actions
= 0;
255 exts
->actions
= kcalloc(TCA_ACT_MAX_PRIO
, sizeof(struct tc_action
*),
260 exts
->action
= action
;
261 exts
->police
= police
;
265 /* Return false if the netns is being destroyed in cleanup_net(). Callers
266 * need to do cleanup synchronously in this case, otherwise may race with
267 * tc_action_net_exit(). Return true for other cases.
269 static inline bool tcf_exts_get_net(struct tcf_exts
*exts
)
271 #ifdef CONFIG_NET_CLS_ACT
272 exts
->net
= maybe_get_net(exts
->net
);
273 return exts
->net
!= NULL
;
279 static inline void tcf_exts_put_net(struct tcf_exts
*exts
)
281 #ifdef CONFIG_NET_CLS_ACT
287 static inline void tcf_exts_to_list(const struct tcf_exts
*exts
,
288 struct list_head
*actions
)
290 #ifdef CONFIG_NET_CLS_ACT
293 for (i
= 0; i
< exts
->nr_actions
; i
++) {
294 struct tc_action
*a
= exts
->actions
[i
];
296 list_add_tail(&a
->list
, actions
);
302 tcf_exts_stats_update(const struct tcf_exts
*exts
,
303 u64 bytes
, u64 packets
, u64 lastuse
)
305 #ifdef CONFIG_NET_CLS_ACT
310 for (i
= 0; i
< exts
->nr_actions
; i
++) {
311 struct tc_action
*a
= exts
->actions
[i
];
313 tcf_action_stats_update(a
, bytes
, packets
, lastuse
);
321 * tcf_exts_has_actions - check if at least one action is present
322 * @exts: tc filter extensions handle
324 * Returns true if at least one action is present.
326 static inline bool tcf_exts_has_actions(struct tcf_exts
*exts
)
328 #ifdef CONFIG_NET_CLS_ACT
329 return exts
->nr_actions
;
336 * tcf_exts_has_one_action - check if exactly one action is present
337 * @exts: tc filter extensions handle
339 * Returns true if exactly one action is present.
341 static inline bool tcf_exts_has_one_action(struct tcf_exts
*exts
)
343 #ifdef CONFIG_NET_CLS_ACT
344 return exts
->nr_actions
== 1;
351 * tcf_exts_exec - execute tc filter extensions
352 * @skb: socket buffer
353 * @exts: tc filter extensions handle
354 * @res: desired result
356 * Executes all configured extensions. Returns TC_ACT_OK on a normal execution,
357 * a negative number if the filter must be considered unmatched or
358 * a positive action code (TC_ACT_*) which must be returned to the
362 tcf_exts_exec(struct sk_buff
*skb
, struct tcf_exts
*exts
,
363 struct tcf_result
*res
)
365 #ifdef CONFIG_NET_CLS_ACT
366 return tcf_action_exec(skb
, exts
->actions
, exts
->nr_actions
, res
);
371 int tcf_exts_validate(struct net
*net
, struct tcf_proto
*tp
,
372 struct nlattr
**tb
, struct nlattr
*rate_tlv
,
373 struct tcf_exts
*exts
, bool ovr
);
374 void tcf_exts_destroy(struct tcf_exts
*exts
);
375 void tcf_exts_change(struct tcf_exts
*dst
, struct tcf_exts
*src
);
376 int tcf_exts_dump(struct sk_buff
*skb
, struct tcf_exts
*exts
);
377 int tcf_exts_dump_stats(struct sk_buff
*skb
, struct tcf_exts
*exts
);
380 * struct tcf_pkt_info - packet information
382 struct tcf_pkt_info
{
387 #ifdef CONFIG_NET_EMATCH
389 struct tcf_ematch_ops
;
392 * struct tcf_ematch - extended match (ematch)
394 * @matchid: identifier to allow userspace to reidentify a match
395 * @flags: flags specifying attributes and the relation to other matches
396 * @ops: the operations lookup table of the corresponding ematch module
397 * @datalen: length of the ematch specific configuration data
398 * @data: ematch specific data
401 struct tcf_ematch_ops
* ops
;
403 unsigned int datalen
;
409 static inline int tcf_em_is_container(struct tcf_ematch
*em
)
414 static inline int tcf_em_is_simple(struct tcf_ematch
*em
)
416 return em
->flags
& TCF_EM_SIMPLE
;
419 static inline int tcf_em_is_inverted(struct tcf_ematch
*em
)
421 return em
->flags
& TCF_EM_INVERT
;
424 static inline int tcf_em_last_match(struct tcf_ematch
*em
)
426 return (em
->flags
& TCF_EM_REL_MASK
) == TCF_EM_REL_END
;
429 static inline int tcf_em_early_end(struct tcf_ematch
*em
, int result
)
431 if (tcf_em_last_match(em
))
434 if (result
== 0 && em
->flags
& TCF_EM_REL_AND
)
437 if (result
!= 0 && em
->flags
& TCF_EM_REL_OR
)
444 * struct tcf_ematch_tree - ematch tree handle
446 * @hdr: ematch tree header supplied by userspace
447 * @matches: array of ematches
449 struct tcf_ematch_tree
{
450 struct tcf_ematch_tree_hdr hdr
;
451 struct tcf_ematch
* matches
;
456 * struct tcf_ematch_ops - ematch module operations
458 * @kind: identifier (kind) of this ematch module
459 * @datalen: length of expected configuration data (optional)
460 * @change: called during validation (optional)
461 * @match: called during ematch tree evaluation, must return 1/0
462 * @destroy: called during destroyage (optional)
463 * @dump: called during dumping process (optional)
464 * @owner: owner, must be set to THIS_MODULE
465 * @link: link to previous/next ematch module (internal use)
467 struct tcf_ematch_ops
{
470 int (*change
)(struct net
*net
, void *,
471 int, struct tcf_ematch
*);
472 int (*match
)(struct sk_buff
*, struct tcf_ematch
*,
473 struct tcf_pkt_info
*);
474 void (*destroy
)(struct tcf_ematch
*);
475 int (*dump
)(struct sk_buff
*, struct tcf_ematch
*);
476 struct module
*owner
;
477 struct list_head link
;
480 int tcf_em_register(struct tcf_ematch_ops
*);
481 void tcf_em_unregister(struct tcf_ematch_ops
*);
482 int tcf_em_tree_validate(struct tcf_proto
*, struct nlattr
*,
483 struct tcf_ematch_tree
*);
484 void tcf_em_tree_destroy(struct tcf_ematch_tree
*);
485 int tcf_em_tree_dump(struct sk_buff
*, struct tcf_ematch_tree
*, int);
486 int __tcf_em_tree_match(struct sk_buff
*, struct tcf_ematch_tree
*,
487 struct tcf_pkt_info
*);
490 * tcf_em_tree_match - evaulate an ematch tree
492 * @skb: socket buffer of the packet in question
493 * @tree: ematch tree to be used for evaluation
494 * @info: packet information examined by classifier
496 * This function matches @skb against the ematch tree in @tree by going
497 * through all ematches respecting their logic relations returning
498 * as soon as the result is obvious.
500 * Returns 1 if the ematch tree as-one matches, no ematches are configured
501 * or ematch is not enabled in the kernel, otherwise 0 is returned.
503 static inline int tcf_em_tree_match(struct sk_buff
*skb
,
504 struct tcf_ematch_tree
*tree
,
505 struct tcf_pkt_info
*info
)
507 if (tree
->hdr
.nmatches
)
508 return __tcf_em_tree_match(skb
, tree
, info
);
513 #define MODULE_ALIAS_TCF_EMATCH(kind) MODULE_ALIAS("ematch-kind-" __stringify(kind))
515 #else /* CONFIG_NET_EMATCH */
517 struct tcf_ematch_tree
{
520 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
521 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
522 #define tcf_em_tree_dump(skb, t, tlv) (0)
523 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
525 #endif /* CONFIG_NET_EMATCH */
527 static inline unsigned char * tcf_get_base_ptr(struct sk_buff
*skb
, int layer
)
531 return skb_mac_header(skb
);
532 case TCF_LAYER_NETWORK
:
533 return skb_network_header(skb
);
534 case TCF_LAYER_TRANSPORT
:
535 return skb_transport_header(skb
);
541 static inline int tcf_valid_offset(const struct sk_buff
*skb
,
542 const unsigned char *ptr
, const int len
)
544 return likely((ptr
+ len
) <= skb_tail_pointer(skb
) &&
546 (ptr
<= (ptr
+ len
)));
549 #ifdef CONFIG_NET_CLS_IND
550 #include <net/net_namespace.h>
553 tcf_change_indev(struct net
*net
, struct nlattr
*indev_tlv
)
555 char indev
[IFNAMSIZ
];
556 struct net_device
*dev
;
558 if (nla_strlcpy(indev
, indev_tlv
, IFNAMSIZ
) >= IFNAMSIZ
)
560 dev
= __dev_get_by_name(net
, indev
);
567 tcf_match_indev(struct sk_buff
*skb
, int ifindex
)
573 return ifindex
== skb
->skb_iif
;
575 #endif /* CONFIG_NET_CLS_IND */
577 int tc_setup_cb_call(struct tcf_block
*block
, struct tcf_exts
*exts
,
578 enum tc_setup_type type
, void *type_data
, bool err_stop
);
580 enum tc_block_command
{
585 struct tc_block_offload
{
586 enum tc_block_command command
;
587 enum tcf_block_binder_type binder_type
;
588 struct tcf_block
*block
;
591 struct tc_cls_common_offload
{
598 tc_cls_common_offload_init(struct tc_cls_common_offload
*cls_common
,
599 const struct tcf_proto
*tp
)
601 cls_common
->chain_index
= tp
->chain
->index
;
602 cls_common
->protocol
= tp
->protocol
;
603 cls_common
->prio
= tp
->prio
;
606 struct tc_cls_u32_knode
{
607 struct tcf_exts
*exts
;
608 struct tc_u32_sel
*sel
;
616 struct tc_cls_u32_hnode
{
619 unsigned int divisor
;
622 enum tc_clsu32_command
{
624 TC_CLSU32_REPLACE_KNODE
,
625 TC_CLSU32_DELETE_KNODE
,
627 TC_CLSU32_REPLACE_HNODE
,
628 TC_CLSU32_DELETE_HNODE
,
631 struct tc_cls_u32_offload
{
632 struct tc_cls_common_offload common
;
634 enum tc_clsu32_command command
;
636 struct tc_cls_u32_knode knode
;
637 struct tc_cls_u32_hnode hnode
;
641 static inline bool tc_can_offload(const struct net_device
*dev
)
643 return dev
->features
& NETIF_F_HW_TC
;
646 static inline bool tc_skip_hw(u32 flags
)
648 return (flags
& TCA_CLS_FLAGS_SKIP_HW
) ? true : false;
651 static inline bool tc_skip_sw(u32 flags
)
653 return (flags
& TCA_CLS_FLAGS_SKIP_SW
) ? true : false;
656 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
657 static inline bool tc_flags_valid(u32 flags
)
659 if (flags
& ~(TCA_CLS_FLAGS_SKIP_HW
| TCA_CLS_FLAGS_SKIP_SW
))
662 if (!(flags
^ (TCA_CLS_FLAGS_SKIP_HW
| TCA_CLS_FLAGS_SKIP_SW
)))
668 static inline bool tc_in_hw(u32 flags
)
670 return (flags
& TCA_CLS_FLAGS_IN_HW
) ? true : false;
674 TC_CLSFLOWER_REPLACE
,
675 TC_CLSFLOWER_DESTROY
,
679 struct tc_cls_flower_offload
{
680 struct tc_cls_common_offload common
;
681 enum tc_fl_command command
;
682 unsigned long cookie
;
683 struct flow_dissector
*dissector
;
684 struct fl_flow_key
*mask
;
685 struct fl_flow_key
*key
;
686 struct tcf_exts
*exts
;
690 enum tc_matchall_command
{
691 TC_CLSMATCHALL_REPLACE
,
692 TC_CLSMATCHALL_DESTROY
,
695 struct tc_cls_matchall_offload
{
696 struct tc_cls_common_offload common
;
697 enum tc_matchall_command command
;
698 struct tcf_exts
*exts
;
699 unsigned long cookie
;
702 enum tc_clsbpf_command
{
707 struct tc_cls_bpf_offload
{
708 struct tc_cls_common_offload common
;
709 enum tc_clsbpf_command command
;
710 struct tcf_exts
*exts
;
711 struct bpf_prog
*prog
;
712 struct bpf_prog
*oldprog
;
714 bool exts_integrated
;
718 struct tc_mqprio_qopt_offload
{
719 /* struct tc_mqprio_qopt must always be the first element */
720 struct tc_mqprio_qopt qopt
;
724 u64 min_rate
[TC_QOPT_MAX_QUEUE
];
725 u64 max_rate
[TC_QOPT_MAX_QUEUE
];
728 /* This structure holds cookie structure that is passed from user
729 * to the kernel for actions and classifiers
736 enum tc_red_command
{
743 struct tc_red_qopt_offload_params
{
749 struct tc_red_qopt_offload_stats
{
750 struct gnet_stats_basic_packed
*bstats
;
751 struct gnet_stats_queue
*qstats
;
754 struct tc_red_qopt_offload
{
755 enum tc_red_command command
;
759 struct tc_red_qopt_offload_params set
;
760 struct tc_red_qopt_offload_stats stats
;
761 struct red_stats
*xstats
;