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 work_struct *work);
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);
189 static inline unsigned long
190 cls_set_class(struct Qdisc *q, unsigned long *clp, unsigned long cl)
192 unsigned long old_cl;
195 old_cl = __cls_set_class(clp, cl);
201 tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
203 struct Qdisc *q = tp->chain->block->q;
206 /* Check q as it is not set for shared blocks. In that case,
207 * setting class is not supported.
211 cl = q->ops->cl_ops->bind_tcf(q, base, r->classid);
212 cl = cls_set_class(q, &r->class, cl);
214 q->ops->cl_ops->unbind_tcf(q, cl);
218 tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
220 struct Qdisc *q = tp->chain->block->q;
225 if ((cl = __cls_set_class(&r->class, 0)) != 0)
226 q->ops->cl_ops->unbind_tcf(q, cl);
230 #ifdef CONFIG_NET_CLS_ACT
231 __u32 type; /* for backward compat(TCA_OLD_COMPAT) */
233 struct tc_action **actions;
235 /* Map to export classifier specific extension TLV types to the
236 * generic extensions API. Unsupported extensions must be set to 0.
242 static inline int tcf_exts_init(struct tcf_exts *exts, int action, int police)
244 #ifdef CONFIG_NET_CLS_ACT
246 exts->nr_actions = 0;
247 exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
252 exts->action = action;
253 exts->police = police;
257 static inline void tcf_exts_to_list(const struct tcf_exts *exts,
258 struct list_head *actions)
260 #ifdef CONFIG_NET_CLS_ACT
263 for (i = 0; i < exts->nr_actions; i++) {
264 struct tc_action *a = exts->actions[i];
266 list_add_tail(&a->list, actions);
272 tcf_exts_stats_update(const struct tcf_exts *exts,
273 u64 bytes, u64 packets, u64 lastuse)
275 #ifdef CONFIG_NET_CLS_ACT
280 for (i = 0; i < exts->nr_actions; i++) {
281 struct tc_action *a = exts->actions[i];
283 tcf_action_stats_update(a, bytes, packets, lastuse);
291 * tcf_exts_has_actions - check if at least one action is present
292 * @exts: tc filter extensions handle
294 * Returns true if at least one action is present.
296 static inline bool tcf_exts_has_actions(struct tcf_exts *exts)
298 #ifdef CONFIG_NET_CLS_ACT
299 return exts->nr_actions;
306 * tcf_exts_has_one_action - check if exactly one action is present
307 * @exts: tc filter extensions handle
309 * Returns true if exactly one action is present.
311 static inline bool tcf_exts_has_one_action(struct tcf_exts *exts)
313 #ifdef CONFIG_NET_CLS_ACT
314 return exts->nr_actions == 1;
321 * tcf_exts_exec - execute tc filter extensions
322 * @skb: socket buffer
323 * @exts: tc filter extensions handle
324 * @res: desired result
326 * Executes all configured extensions. Returns TC_ACT_OK on a normal execution,
327 * a negative number if the filter must be considered unmatched or
328 * a positive action code (TC_ACT_*) which must be returned to the
332 tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
333 struct tcf_result *res)
335 #ifdef CONFIG_NET_CLS_ACT
336 return tcf_action_exec(skb, exts->actions, exts->nr_actions, res);
341 int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
342 struct nlattr **tb, struct nlattr *rate_tlv,
343 struct tcf_exts *exts, bool ovr);
344 void tcf_exts_destroy(struct tcf_exts *exts);
345 void tcf_exts_change(struct tcf_exts *dst, struct tcf_exts *src);
346 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
347 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
350 * struct tcf_pkt_info - packet information
352 struct tcf_pkt_info {
357 #ifdef CONFIG_NET_EMATCH
359 struct tcf_ematch_ops;
362 * struct tcf_ematch - extended match (ematch)
364 * @matchid: identifier to allow userspace to reidentify a match
365 * @flags: flags specifying attributes and the relation to other matches
366 * @ops: the operations lookup table of the corresponding ematch module
367 * @datalen: length of the ematch specific configuration data
368 * @data: ematch specific data
371 struct tcf_ematch_ops * ops;
373 unsigned int datalen;
379 static inline int tcf_em_is_container(struct tcf_ematch *em)
384 static inline int tcf_em_is_simple(struct tcf_ematch *em)
386 return em->flags & TCF_EM_SIMPLE;
389 static inline int tcf_em_is_inverted(struct tcf_ematch *em)
391 return em->flags & TCF_EM_INVERT;
394 static inline int tcf_em_last_match(struct tcf_ematch *em)
396 return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
399 static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
401 if (tcf_em_last_match(em))
404 if (result == 0 && em->flags & TCF_EM_REL_AND)
407 if (result != 0 && em->flags & TCF_EM_REL_OR)
414 * struct tcf_ematch_tree - ematch tree handle
416 * @hdr: ematch tree header supplied by userspace
417 * @matches: array of ematches
419 struct tcf_ematch_tree {
420 struct tcf_ematch_tree_hdr hdr;
421 struct tcf_ematch * matches;
426 * struct tcf_ematch_ops - ematch module operations
428 * @kind: identifier (kind) of this ematch module
429 * @datalen: length of expected configuration data (optional)
430 * @change: called during validation (optional)
431 * @match: called during ematch tree evaluation, must return 1/0
432 * @destroy: called during destroyage (optional)
433 * @dump: called during dumping process (optional)
434 * @owner: owner, must be set to THIS_MODULE
435 * @link: link to previous/next ematch module (internal use)
437 struct tcf_ematch_ops {
440 int (*change)(struct net *net, void *,
441 int, struct tcf_ematch *);
442 int (*match)(struct sk_buff *, struct tcf_ematch *,
443 struct tcf_pkt_info *);
444 void (*destroy)(struct tcf_ematch *);
445 int (*dump)(struct sk_buff *, struct tcf_ematch *);
446 struct module *owner;
447 struct list_head link;
450 int tcf_em_register(struct tcf_ematch_ops *);
451 void tcf_em_unregister(struct tcf_ematch_ops *);
452 int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
453 struct tcf_ematch_tree *);
454 void tcf_em_tree_destroy(struct tcf_ematch_tree *);
455 int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
456 int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
457 struct tcf_pkt_info *);
460 * tcf_em_tree_match - evaulate an ematch tree
462 * @skb: socket buffer of the packet in question
463 * @tree: ematch tree to be used for evaluation
464 * @info: packet information examined by classifier
466 * This function matches @skb against the ematch tree in @tree by going
467 * through all ematches respecting their logic relations returning
468 * as soon as the result is obvious.
470 * Returns 1 if the ematch tree as-one matches, no ematches are configured
471 * or ematch is not enabled in the kernel, otherwise 0 is returned.
473 static inline int tcf_em_tree_match(struct sk_buff *skb,
474 struct tcf_ematch_tree *tree,
475 struct tcf_pkt_info *info)
477 if (tree->hdr.nmatches)
478 return __tcf_em_tree_match(skb, tree, info);
483 #define MODULE_ALIAS_TCF_EMATCH(kind) MODULE_ALIAS("ematch-kind-" __stringify(kind))
485 #else /* CONFIG_NET_EMATCH */
487 struct tcf_ematch_tree {
490 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
491 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
492 #define tcf_em_tree_dump(skb, t, tlv) (0)
493 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
495 #endif /* CONFIG_NET_EMATCH */
497 static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
502 case TCF_LAYER_NETWORK:
503 return skb_network_header(skb);
504 case TCF_LAYER_TRANSPORT:
505 return skb_transport_header(skb);
511 static inline int tcf_valid_offset(const struct sk_buff *skb,
512 const unsigned char *ptr, const int len)
514 return likely((ptr + len) <= skb_tail_pointer(skb) &&
516 (ptr <= (ptr + len)));
519 #ifdef CONFIG_NET_CLS_IND
520 #include <net/net_namespace.h>
523 tcf_change_indev(struct net *net, struct nlattr *indev_tlv)
525 char indev[IFNAMSIZ];
526 struct net_device *dev;
528 if (nla_strlcpy(indev, indev_tlv, IFNAMSIZ) >= IFNAMSIZ)
530 dev = __dev_get_by_name(net, indev);
537 tcf_match_indev(struct sk_buff *skb, int ifindex)
543 return ifindex == skb->skb_iif;
545 #endif /* CONFIG_NET_CLS_IND */
547 int tc_setup_cb_call(struct tcf_block *block, struct tcf_exts *exts,
548 enum tc_setup_type type, void *type_data, bool err_stop);
550 enum tc_block_command {
555 struct tc_block_offload {
556 enum tc_block_command command;
557 enum tcf_block_binder_type binder_type;
558 struct tcf_block *block;
561 struct tc_cls_common_offload {
568 tc_cls_common_offload_init(struct tc_cls_common_offload *cls_common,
569 const struct tcf_proto *tp)
571 cls_common->chain_index = tp->chain->index;
572 cls_common->protocol = tp->protocol;
573 cls_common->prio = tp->prio;
576 struct tc_cls_u32_knode {
577 struct tcf_exts *exts;
578 struct tc_u32_sel *sel;
586 struct tc_cls_u32_hnode {
589 unsigned int divisor;
592 enum tc_clsu32_command {
594 TC_CLSU32_REPLACE_KNODE,
595 TC_CLSU32_DELETE_KNODE,
597 TC_CLSU32_REPLACE_HNODE,
598 TC_CLSU32_DELETE_HNODE,
601 struct tc_cls_u32_offload {
602 struct tc_cls_common_offload common;
604 enum tc_clsu32_command command;
606 struct tc_cls_u32_knode knode;
607 struct tc_cls_u32_hnode hnode;
611 static inline bool tc_can_offload(const struct net_device *dev)
613 return dev->features & NETIF_F_HW_TC;
616 static inline bool tc_skip_hw(u32 flags)
618 return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
621 static inline bool tc_skip_sw(u32 flags)
623 return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
626 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
627 static inline bool tc_flags_valid(u32 flags)
629 if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW))
632 if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
638 static inline bool tc_in_hw(u32 flags)
640 return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
644 TC_CLSFLOWER_REPLACE,
645 TC_CLSFLOWER_DESTROY,
649 struct tc_cls_flower_offload {
650 struct tc_cls_common_offload common;
651 enum tc_fl_command command;
652 unsigned long cookie;
653 struct flow_dissector *dissector;
654 struct fl_flow_key *mask;
655 struct fl_flow_key *key;
656 struct tcf_exts *exts;
660 enum tc_matchall_command {
661 TC_CLSMATCHALL_REPLACE,
662 TC_CLSMATCHALL_DESTROY,
665 struct tc_cls_matchall_offload {
666 struct tc_cls_common_offload common;
667 enum tc_matchall_command command;
668 struct tcf_exts *exts;
669 unsigned long cookie;
672 enum tc_clsbpf_command {
679 struct tc_cls_bpf_offload {
680 struct tc_cls_common_offload common;
681 enum tc_clsbpf_command command;
682 struct tcf_exts *exts;
683 struct bpf_prog *prog;
685 bool exts_integrated;
689 struct tc_mqprio_qopt_offload {
690 /* struct tc_mqprio_qopt must always be the first element */
691 struct tc_mqprio_qopt qopt;
695 u64 min_rate[TC_QOPT_MAX_QUEUE];
696 u64 max_rate[TC_QOPT_MAX_QUEUE];
699 /* This structure holds cookie structure that is passed from user
700 * to the kernel for actions and classifiers