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>
9 #include <net/flow_offload.h>
11 /* TC action not accessible from user space */
12 #define TC_ACT_REINSERT (TC_ACT_VALUE_MAX + 1)
14 /* Basic packet classifier frontend definitions. */
21 int (*fn)(struct tcf_proto *, void *node, struct tcf_walker *);
24 int register_tcf_proto_ops(struct tcf_proto_ops *ops);
25 int unregister_tcf_proto_ops(struct tcf_proto_ops *ops);
27 enum tcf_block_binder_type {
28 TCF_BLOCK_BINDER_TYPE_UNSPEC,
29 TCF_BLOCK_BINDER_TYPE_CLSACT_INGRESS,
30 TCF_BLOCK_BINDER_TYPE_CLSACT_EGRESS,
33 struct tcf_block_ext_info {
34 enum tcf_block_binder_type binder_type;
35 tcf_chain_head_change_t *chain_head_change;
36 void *chain_head_change_priv;
41 bool tcf_queue_work(struct rcu_work *rwork, work_func_t func);
44 struct tcf_chain *tcf_chain_get_by_act(struct tcf_block *block,
46 void tcf_chain_put_by_act(struct tcf_chain *chain);
47 void tcf_block_netif_keep_dst(struct tcf_block *block);
48 int tcf_block_get(struct tcf_block **p_block,
49 struct tcf_proto __rcu **p_filter_chain, struct Qdisc *q,
50 struct netlink_ext_ack *extack);
51 int tcf_block_get_ext(struct tcf_block **p_block, struct Qdisc *q,
52 struct tcf_block_ext_info *ei,
53 struct netlink_ext_ack *extack);
54 void tcf_block_put(struct tcf_block *block);
55 void tcf_block_put_ext(struct tcf_block *block, struct Qdisc *q,
56 struct tcf_block_ext_info *ei);
58 static inline bool tcf_block_shared(struct tcf_block *block)
63 static inline struct Qdisc *tcf_block_q(struct tcf_block *block)
65 WARN_ON(tcf_block_shared(block));
69 void *tcf_block_cb_priv(struct tcf_block_cb *block_cb);
70 struct tcf_block_cb *tcf_block_cb_lookup(struct tcf_block *block,
71 tc_setup_cb_t *cb, void *cb_ident);
72 void tcf_block_cb_incref(struct tcf_block_cb *block_cb);
73 unsigned int tcf_block_cb_decref(struct tcf_block_cb *block_cb);
74 struct tcf_block_cb *__tcf_block_cb_register(struct tcf_block *block,
75 tc_setup_cb_t *cb, void *cb_ident,
77 struct netlink_ext_ack *extack);
78 int tcf_block_cb_register(struct tcf_block *block,
79 tc_setup_cb_t *cb, void *cb_ident,
80 void *cb_priv, struct netlink_ext_ack *extack);
81 void __tcf_block_cb_unregister(struct tcf_block *block,
82 struct tcf_block_cb *block_cb);
83 void tcf_block_cb_unregister(struct tcf_block *block,
84 tc_setup_cb_t *cb, void *cb_ident);
85 int __tc_indr_block_cb_register(struct net_device *dev, void *cb_priv,
86 tc_indr_block_bind_cb_t *cb, void *cb_ident);
87 int tc_indr_block_cb_register(struct net_device *dev, void *cb_priv,
88 tc_indr_block_bind_cb_t *cb, void *cb_ident);
89 void __tc_indr_block_cb_unregister(struct net_device *dev,
90 tc_indr_block_bind_cb_t *cb, void *cb_ident);
91 void tc_indr_block_cb_unregister(struct net_device *dev,
92 tc_indr_block_bind_cb_t *cb, void *cb_ident);
94 int tcf_classify(struct sk_buff *skb, const struct tcf_proto *tp,
95 struct tcf_result *res, bool compat_mode);
99 int tcf_block_get(struct tcf_block **p_block,
100 struct tcf_proto __rcu **p_filter_chain, struct Qdisc *q,
101 struct netlink_ext_ack *extack)
107 int tcf_block_get_ext(struct tcf_block **p_block, struct Qdisc *q,
108 struct tcf_block_ext_info *ei,
109 struct netlink_ext_ack *extack)
114 static inline void tcf_block_put(struct tcf_block *block)
119 void tcf_block_put_ext(struct tcf_block *block, struct Qdisc *q,
120 struct tcf_block_ext_info *ei)
124 static inline struct Qdisc *tcf_block_q(struct tcf_block *block)
130 int tc_setup_cb_block_register(struct tcf_block *block, tc_setup_cb_t *cb,
137 void tc_setup_cb_block_unregister(struct tcf_block *block, tc_setup_cb_t *cb,
143 void *tcf_block_cb_priv(struct tcf_block_cb *block_cb)
149 struct tcf_block_cb *tcf_block_cb_lookup(struct tcf_block *block,
150 tc_setup_cb_t *cb, void *cb_ident)
156 void tcf_block_cb_incref(struct tcf_block_cb *block_cb)
161 unsigned int tcf_block_cb_decref(struct tcf_block_cb *block_cb)
167 struct tcf_block_cb *__tcf_block_cb_register(struct tcf_block *block,
168 tc_setup_cb_t *cb, void *cb_ident,
170 struct netlink_ext_ack *extack)
176 int tcf_block_cb_register(struct tcf_block *block,
177 tc_setup_cb_t *cb, void *cb_ident,
178 void *cb_priv, struct netlink_ext_ack *extack)
184 void __tcf_block_cb_unregister(struct tcf_block *block,
185 struct tcf_block_cb *block_cb)
190 void tcf_block_cb_unregister(struct tcf_block *block,
191 tc_setup_cb_t *cb, void *cb_ident)
196 int __tc_indr_block_cb_register(struct net_device *dev, void *cb_priv,
197 tc_indr_block_bind_cb_t *cb, void *cb_ident)
203 int tc_indr_block_cb_register(struct net_device *dev, void *cb_priv,
204 tc_indr_block_bind_cb_t *cb, void *cb_ident)
210 void __tc_indr_block_cb_unregister(struct net_device *dev,
211 tc_indr_block_bind_cb_t *cb, void *cb_ident)
216 void tc_indr_block_cb_unregister(struct net_device *dev,
217 tc_indr_block_bind_cb_t *cb, void *cb_ident)
221 static inline int tcf_classify(struct sk_buff *skb, const struct tcf_proto *tp,
222 struct tcf_result *res, bool compat_mode)
224 return TC_ACT_UNSPEC;
228 static inline unsigned long
229 __cls_set_class(unsigned long *clp, unsigned long cl)
231 return xchg(clp, cl);
234 static inline unsigned long
235 cls_set_class(struct Qdisc *q, unsigned long *clp, unsigned long cl)
237 unsigned long old_cl;
240 old_cl = __cls_set_class(clp, cl);
246 tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
248 struct Qdisc *q = tp->chain->block->q;
251 /* Check q as it is not set for shared blocks. In that case,
252 * setting class is not supported.
256 cl = q->ops->cl_ops->bind_tcf(q, base, r->classid);
257 cl = cls_set_class(q, &r->class, cl);
259 q->ops->cl_ops->unbind_tcf(q, cl);
263 tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
265 struct Qdisc *q = tp->chain->block->q;
270 if ((cl = __cls_set_class(&r->class, 0)) != 0)
271 q->ops->cl_ops->unbind_tcf(q, cl);
275 #ifdef CONFIG_NET_CLS_ACT
276 __u32 type; /* for backward compat(TCA_OLD_COMPAT) */
278 struct tc_action **actions;
281 /* Map to export classifier specific extension TLV types to the
282 * generic extensions API. Unsupported extensions must be set to 0.
288 static inline int tcf_exts_init(struct tcf_exts *exts, int action, int police)
290 #ifdef CONFIG_NET_CLS_ACT
292 exts->nr_actions = 0;
294 exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
299 exts->action = action;
300 exts->police = police;
304 /* Return false if the netns is being destroyed in cleanup_net(). Callers
305 * need to do cleanup synchronously in this case, otherwise may race with
306 * tc_action_net_exit(). Return true for other cases.
308 static inline bool tcf_exts_get_net(struct tcf_exts *exts)
310 #ifdef CONFIG_NET_CLS_ACT
311 exts->net = maybe_get_net(exts->net);
312 return exts->net != NULL;
318 static inline void tcf_exts_put_net(struct tcf_exts *exts)
320 #ifdef CONFIG_NET_CLS_ACT
326 #ifdef CONFIG_NET_CLS_ACT
327 #define tcf_exts_for_each_action(i, a, exts) \
328 for (i = 0; i < TCA_ACT_MAX_PRIO && ((a) = (exts)->actions[i]); i++)
330 #define tcf_exts_for_each_action(i, a, exts) \
331 for (; 0; (void)(i), (void)(a), (void)(exts))
335 tcf_exts_stats_update(const struct tcf_exts *exts,
336 u64 bytes, u64 packets, u64 lastuse)
338 #ifdef CONFIG_NET_CLS_ACT
343 for (i = 0; i < exts->nr_actions; i++) {
344 struct tc_action *a = exts->actions[i];
346 tcf_action_stats_update(a, bytes, packets, lastuse, true);
354 * tcf_exts_has_actions - check if at least one action is present
355 * @exts: tc filter extensions handle
357 * Returns true if at least one action is present.
359 static inline bool tcf_exts_has_actions(struct tcf_exts *exts)
361 #ifdef CONFIG_NET_CLS_ACT
362 return exts->nr_actions;
369 * tcf_exts_has_one_action - check if exactly one action is present
370 * @exts: tc filter extensions handle
372 * Returns true if exactly one action is present.
374 static inline bool tcf_exts_has_one_action(struct tcf_exts *exts)
376 #ifdef CONFIG_NET_CLS_ACT
377 return exts->nr_actions == 1;
383 static inline struct tc_action *tcf_exts_first_action(struct tcf_exts *exts)
385 #ifdef CONFIG_NET_CLS_ACT
386 return exts->actions[0];
393 * tcf_exts_exec - execute tc filter extensions
394 * @skb: socket buffer
395 * @exts: tc filter extensions handle
396 * @res: desired result
398 * Executes all configured extensions. Returns TC_ACT_OK on a normal execution,
399 * a negative number if the filter must be considered unmatched or
400 * a positive action code (TC_ACT_*) which must be returned to the
404 tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
405 struct tcf_result *res)
407 #ifdef CONFIG_NET_CLS_ACT
408 return tcf_action_exec(skb, exts->actions, exts->nr_actions, res);
413 int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
414 struct nlattr **tb, struct nlattr *rate_tlv,
415 struct tcf_exts *exts, bool ovr,
416 struct netlink_ext_ack *extack);
417 void tcf_exts_destroy(struct tcf_exts *exts);
418 void tcf_exts_change(struct tcf_exts *dst, struct tcf_exts *src);
419 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
420 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
423 * struct tcf_pkt_info - packet information
425 struct tcf_pkt_info {
430 #ifdef CONFIG_NET_EMATCH
432 struct tcf_ematch_ops;
435 * struct tcf_ematch - extended match (ematch)
437 * @matchid: identifier to allow userspace to reidentify a match
438 * @flags: flags specifying attributes and the relation to other matches
439 * @ops: the operations lookup table of the corresponding ematch module
440 * @datalen: length of the ematch specific configuration data
441 * @data: ematch specific data
444 struct tcf_ematch_ops * ops;
446 unsigned int datalen;
452 static inline int tcf_em_is_container(struct tcf_ematch *em)
457 static inline int tcf_em_is_simple(struct tcf_ematch *em)
459 return em->flags & TCF_EM_SIMPLE;
462 static inline int tcf_em_is_inverted(struct tcf_ematch *em)
464 return em->flags & TCF_EM_INVERT;
467 static inline int tcf_em_last_match(struct tcf_ematch *em)
469 return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
472 static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
474 if (tcf_em_last_match(em))
477 if (result == 0 && em->flags & TCF_EM_REL_AND)
480 if (result != 0 && em->flags & TCF_EM_REL_OR)
487 * struct tcf_ematch_tree - ematch tree handle
489 * @hdr: ematch tree header supplied by userspace
490 * @matches: array of ematches
492 struct tcf_ematch_tree {
493 struct tcf_ematch_tree_hdr hdr;
494 struct tcf_ematch * matches;
499 * struct tcf_ematch_ops - ematch module operations
501 * @kind: identifier (kind) of this ematch module
502 * @datalen: length of expected configuration data (optional)
503 * @change: called during validation (optional)
504 * @match: called during ematch tree evaluation, must return 1/0
505 * @destroy: called during destroyage (optional)
506 * @dump: called during dumping process (optional)
507 * @owner: owner, must be set to THIS_MODULE
508 * @link: link to previous/next ematch module (internal use)
510 struct tcf_ematch_ops {
513 int (*change)(struct net *net, void *,
514 int, struct tcf_ematch *);
515 int (*match)(struct sk_buff *, struct tcf_ematch *,
516 struct tcf_pkt_info *);
517 void (*destroy)(struct tcf_ematch *);
518 int (*dump)(struct sk_buff *, struct tcf_ematch *);
519 struct module *owner;
520 struct list_head link;
523 int tcf_em_register(struct tcf_ematch_ops *);
524 void tcf_em_unregister(struct tcf_ematch_ops *);
525 int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
526 struct tcf_ematch_tree *);
527 void tcf_em_tree_destroy(struct tcf_ematch_tree *);
528 int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
529 int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
530 struct tcf_pkt_info *);
533 * tcf_em_tree_match - evaulate an ematch tree
535 * @skb: socket buffer of the packet in question
536 * @tree: ematch tree to be used for evaluation
537 * @info: packet information examined by classifier
539 * This function matches @skb against the ematch tree in @tree by going
540 * through all ematches respecting their logic relations returning
541 * as soon as the result is obvious.
543 * Returns 1 if the ematch tree as-one matches, no ematches are configured
544 * or ematch is not enabled in the kernel, otherwise 0 is returned.
546 static inline int tcf_em_tree_match(struct sk_buff *skb,
547 struct tcf_ematch_tree *tree,
548 struct tcf_pkt_info *info)
550 if (tree->hdr.nmatches)
551 return __tcf_em_tree_match(skb, tree, info);
556 #define MODULE_ALIAS_TCF_EMATCH(kind) MODULE_ALIAS("ematch-kind-" __stringify(kind))
558 #else /* CONFIG_NET_EMATCH */
560 struct tcf_ematch_tree {
563 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
564 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
565 #define tcf_em_tree_dump(skb, t, tlv) (0)
566 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
568 #endif /* CONFIG_NET_EMATCH */
570 static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
574 return skb_mac_header(skb);
575 case TCF_LAYER_NETWORK:
576 return skb_network_header(skb);
577 case TCF_LAYER_TRANSPORT:
578 return skb_transport_header(skb);
584 static inline int tcf_valid_offset(const struct sk_buff *skb,
585 const unsigned char *ptr, const int len)
587 return likely((ptr + len) <= skb_tail_pointer(skb) &&
589 (ptr <= (ptr + len)));
592 #ifdef CONFIG_NET_CLS_IND
593 #include <net/net_namespace.h>
596 tcf_change_indev(struct net *net, struct nlattr *indev_tlv,
597 struct netlink_ext_ack *extack)
599 char indev[IFNAMSIZ];
600 struct net_device *dev;
602 if (nla_strlcpy(indev, indev_tlv, IFNAMSIZ) >= IFNAMSIZ) {
603 NL_SET_ERR_MSG(extack, "Interface name too long");
606 dev = __dev_get_by_name(net, indev);
613 tcf_match_indev(struct sk_buff *skb, int ifindex)
619 return ifindex == skb->skb_iif;
621 #endif /* CONFIG_NET_CLS_IND */
623 int tc_setup_flow_action(struct flow_action *flow_action,
624 const struct tcf_exts *exts);
625 int tc_setup_cb_call(struct tcf_block *block, enum tc_setup_type type,
626 void *type_data, bool err_stop);
627 unsigned int tcf_exts_num_actions(struct tcf_exts *exts);
629 enum tc_block_command {
634 struct tc_block_offload {
635 enum tc_block_command command;
636 enum tcf_block_binder_type binder_type;
637 struct tcf_block *block;
638 struct netlink_ext_ack *extack;
641 struct tc_cls_common_offload {
645 struct netlink_ext_ack *extack;
648 struct tc_cls_u32_knode {
649 struct tcf_exts *exts;
650 struct tcf_result *res;
651 struct tc_u32_sel *sel;
659 struct tc_cls_u32_hnode {
662 unsigned int divisor;
665 enum tc_clsu32_command {
667 TC_CLSU32_REPLACE_KNODE,
668 TC_CLSU32_DELETE_KNODE,
670 TC_CLSU32_REPLACE_HNODE,
671 TC_CLSU32_DELETE_HNODE,
674 struct tc_cls_u32_offload {
675 struct tc_cls_common_offload common;
677 enum tc_clsu32_command command;
679 struct tc_cls_u32_knode knode;
680 struct tc_cls_u32_hnode hnode;
684 static inline bool tc_can_offload(const struct net_device *dev)
686 return dev->features & NETIF_F_HW_TC;
689 static inline bool tc_can_offload_extack(const struct net_device *dev,
690 struct netlink_ext_ack *extack)
692 bool can = tc_can_offload(dev);
695 NL_SET_ERR_MSG(extack, "TC offload is disabled on net device");
701 tc_cls_can_offload_and_chain0(const struct net_device *dev,
702 struct tc_cls_common_offload *common)
704 if (!tc_can_offload_extack(dev, common->extack))
706 if (common->chain_index) {
707 NL_SET_ERR_MSG(common->extack,
708 "Driver supports only offload of chain 0");
714 static inline bool tc_skip_hw(u32 flags)
716 return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
719 static inline bool tc_skip_sw(u32 flags)
721 return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
724 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
725 static inline bool tc_flags_valid(u32 flags)
727 if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW |
728 TCA_CLS_FLAGS_VERBOSE))
731 flags &= TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW;
732 if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
738 static inline bool tc_in_hw(u32 flags)
740 return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
744 tc_cls_common_offload_init(struct tc_cls_common_offload *cls_common,
745 const struct tcf_proto *tp, u32 flags,
746 struct netlink_ext_ack *extack)
748 cls_common->chain_index = tp->chain->index;
749 cls_common->protocol = tp->protocol;
750 cls_common->prio = tp->prio;
751 if (tc_skip_sw(flags) || flags & TCA_CLS_FLAGS_VERBOSE)
752 cls_common->extack = extack;
756 TC_CLSFLOWER_REPLACE,
757 TC_CLSFLOWER_DESTROY,
759 TC_CLSFLOWER_TMPLT_CREATE,
760 TC_CLSFLOWER_TMPLT_DESTROY,
763 struct tc_cls_flower_offload {
764 struct tc_cls_common_offload common;
765 enum tc_fl_command command;
766 unsigned long cookie;
767 struct flow_rule *rule;
768 struct flow_stats stats;
772 static inline struct flow_rule *
773 tc_cls_flower_offload_flow_rule(struct tc_cls_flower_offload *tc_flow_cmd)
775 return tc_flow_cmd->rule;
778 enum tc_matchall_command {
779 TC_CLSMATCHALL_REPLACE,
780 TC_CLSMATCHALL_DESTROY,
783 struct tc_cls_matchall_offload {
784 struct tc_cls_common_offload common;
785 enum tc_matchall_command command;
786 struct tcf_exts *exts;
787 unsigned long cookie;
790 enum tc_clsbpf_command {
795 struct tc_cls_bpf_offload {
796 struct tc_cls_common_offload common;
797 enum tc_clsbpf_command command;
798 struct tcf_exts *exts;
799 struct bpf_prog *prog;
800 struct bpf_prog *oldprog;
802 bool exts_integrated;
805 struct tc_mqprio_qopt_offload {
806 /* struct tc_mqprio_qopt must always be the first element */
807 struct tc_mqprio_qopt qopt;
811 u64 min_rate[TC_QOPT_MAX_QUEUE];
812 u64 max_rate[TC_QOPT_MAX_QUEUE];
815 /* This structure holds cookie structure that is passed from user
816 * to the kernel for actions and classifiers
824 struct tc_qopt_offload_stats {
825 struct gnet_stats_basic_packed *bstats;
826 struct gnet_stats_queue *qstats;
836 struct tc_mq_opt_offload_graft_params {
841 struct tc_mq_qopt_offload {
842 enum tc_mq_command command;
845 struct tc_qopt_offload_stats stats;
846 struct tc_mq_opt_offload_graft_params graft_params;
850 enum tc_red_command {
858 struct tc_red_qopt_offload_params {
865 struct gnet_stats_queue *qstats;
868 struct tc_red_qopt_offload {
869 enum tc_red_command command;
873 struct tc_red_qopt_offload_params set;
874 struct tc_qopt_offload_stats stats;
875 struct red_stats *xstats;
880 enum tc_gred_command {
886 struct tc_gred_vq_qopt_offload_params {
895 /* Only need backlog, see struct tc_prio_qopt_offload_params */
899 struct tc_gred_qopt_offload_params {
904 struct gnet_stats_queue *qstats;
905 struct tc_gred_vq_qopt_offload_params tab[MAX_DPs];
908 struct tc_gred_qopt_offload_stats {
909 struct gnet_stats_basic_packed bstats[MAX_DPs];
910 struct gnet_stats_queue qstats[MAX_DPs];
911 struct red_stats *xstats[MAX_DPs];
914 struct tc_gred_qopt_offload {
915 enum tc_gred_command command;
919 struct tc_gred_qopt_offload_params set;
920 struct tc_gred_qopt_offload_stats stats;
924 enum tc_prio_command {
931 struct tc_prio_qopt_offload_params {
933 u8 priomap[TC_PRIO_MAX + 1];
934 /* In case that a prio qdisc is offloaded and now is changed to a
935 * non-offloadedable config, it needs to update the backlog & qlen
936 * values to negate the HW backlog & qlen values (and only them).
938 struct gnet_stats_queue *qstats;
941 struct tc_prio_qopt_offload_graft_params {
946 struct tc_prio_qopt_offload {
947 enum tc_prio_command command;
951 struct tc_prio_qopt_offload_params replace_params;
952 struct tc_qopt_offload_stats stats;
953 struct tc_prio_qopt_offload_graft_params graft_params;
957 enum tc_root_command {
961 struct tc_root_qopt_offload {
962 enum tc_root_command command;