xref: /linux/include/net/pkt_cls.h (revision 6c8c1406a6d6a3f2e61ac590f5c0994231bc6be7)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NET_PKT_CLS_H
3 #define __NET_PKT_CLS_H
4 
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/net_namespace.h>
10 
11 /* TC action not accessible from user space */
12 #define TC_ACT_CONSUMED		(TC_ACT_VALUE_MAX + 1)
13 
14 /* Basic packet classifier frontend definitions. */
15 
16 struct tcf_walker {
17 	int	stop;
18 	int	skip;
19 	int	count;
20 	bool	nonempty;
21 	unsigned long cookie;
22 	int	(*fn)(struct tcf_proto *, void *node, struct tcf_walker *);
23 };
24 
25 int register_tcf_proto_ops(struct tcf_proto_ops *ops);
26 void unregister_tcf_proto_ops(struct tcf_proto_ops *ops);
27 
28 struct tcf_block_ext_info {
29 	enum flow_block_binder_type binder_type;
30 	tcf_chain_head_change_t *chain_head_change;
31 	void *chain_head_change_priv;
32 	u32 block_index;
33 };
34 
35 struct tcf_qevent {
36 	struct tcf_block	*block;
37 	struct tcf_block_ext_info info;
38 	struct tcf_proto __rcu *filter_chain;
39 };
40 
41 struct tcf_block_cb;
42 bool tcf_queue_work(struct rcu_work *rwork, work_func_t func);
43 
44 #ifdef CONFIG_NET_CLS
45 struct tcf_chain *tcf_chain_get_by_act(struct tcf_block *block,
46 				       u32 chain_index);
47 void tcf_chain_put_by_act(struct tcf_chain *chain);
48 struct tcf_chain *tcf_get_next_chain(struct tcf_block *block,
49 				     struct tcf_chain *chain);
50 struct tcf_proto *tcf_get_next_proto(struct tcf_chain *chain,
51 				     struct tcf_proto *tp);
52 void tcf_block_netif_keep_dst(struct tcf_block *block);
53 int tcf_block_get(struct tcf_block **p_block,
54 		  struct tcf_proto __rcu **p_filter_chain, struct Qdisc *q,
55 		  struct netlink_ext_ack *extack);
56 int tcf_block_get_ext(struct tcf_block **p_block, struct Qdisc *q,
57 		      struct tcf_block_ext_info *ei,
58 		      struct netlink_ext_ack *extack);
59 void tcf_block_put(struct tcf_block *block);
60 void tcf_block_put_ext(struct tcf_block *block, struct Qdisc *q,
61 		       struct tcf_block_ext_info *ei);
62 
63 static inline bool tcf_block_shared(struct tcf_block *block)
64 {
65 	return block->index;
66 }
67 
68 static inline bool tcf_block_non_null_shared(struct tcf_block *block)
69 {
70 	return block && block->index;
71 }
72 
73 static inline struct Qdisc *tcf_block_q(struct tcf_block *block)
74 {
75 	WARN_ON(tcf_block_shared(block));
76 	return block->q;
77 }
78 
79 int tcf_classify(struct sk_buff *skb,
80 		 const struct tcf_block *block,
81 		 const struct tcf_proto *tp, struct tcf_result *res,
82 		 bool compat_mode);
83 
84 static inline bool tc_cls_stats_dump(struct tcf_proto *tp,
85 				     struct tcf_walker *arg,
86 				     void *filter)
87 {
88 	if (arg->count >= arg->skip && arg->fn(tp, filter, arg) < 0) {
89 		arg->stop = 1;
90 		return false;
91 	}
92 
93 	arg->count++;
94 	return true;
95 }
96 
97 #else
98 static inline bool tcf_block_shared(struct tcf_block *block)
99 {
100 	return false;
101 }
102 
103 static inline bool tcf_block_non_null_shared(struct tcf_block *block)
104 {
105 	return false;
106 }
107 
108 static inline
109 int tcf_block_get(struct tcf_block **p_block,
110 		  struct tcf_proto __rcu **p_filter_chain, struct Qdisc *q,
111 		  struct netlink_ext_ack *extack)
112 {
113 	return 0;
114 }
115 
116 static inline
117 int tcf_block_get_ext(struct tcf_block **p_block, struct Qdisc *q,
118 		      struct tcf_block_ext_info *ei,
119 		      struct netlink_ext_ack *extack)
120 {
121 	return 0;
122 }
123 
124 static inline void tcf_block_put(struct tcf_block *block)
125 {
126 }
127 
128 static inline
129 void tcf_block_put_ext(struct tcf_block *block, struct Qdisc *q,
130 		       struct tcf_block_ext_info *ei)
131 {
132 }
133 
134 static inline struct Qdisc *tcf_block_q(struct tcf_block *block)
135 {
136 	return NULL;
137 }
138 
139 static inline
140 int tc_setup_cb_block_register(struct tcf_block *block, flow_setup_cb_t *cb,
141 			       void *cb_priv)
142 {
143 	return 0;
144 }
145 
146 static inline
147 void tc_setup_cb_block_unregister(struct tcf_block *block, flow_setup_cb_t *cb,
148 				  void *cb_priv)
149 {
150 }
151 
152 static inline int tcf_classify(struct sk_buff *skb,
153 			       const struct tcf_block *block,
154 			       const struct tcf_proto *tp,
155 			       struct tcf_result *res, bool compat_mode)
156 {
157 	return TC_ACT_UNSPEC;
158 }
159 
160 #endif
161 
162 static inline unsigned long
163 __cls_set_class(unsigned long *clp, unsigned long cl)
164 {
165 	return xchg(clp, cl);
166 }
167 
168 static inline void
169 __tcf_bind_filter(struct Qdisc *q, struct tcf_result *r, unsigned long base)
170 {
171 	unsigned long cl;
172 
173 	cl = q->ops->cl_ops->bind_tcf(q, base, r->classid);
174 	cl = __cls_set_class(&r->class, cl);
175 	if (cl)
176 		q->ops->cl_ops->unbind_tcf(q, cl);
177 }
178 
179 static inline void
180 tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
181 {
182 	struct Qdisc *q = tp->chain->block->q;
183 
184 	/* Check q as it is not set for shared blocks. In that case,
185 	 * setting class is not supported.
186 	 */
187 	if (!q)
188 		return;
189 	sch_tree_lock(q);
190 	__tcf_bind_filter(q, r, base);
191 	sch_tree_unlock(q);
192 }
193 
194 static inline void
195 __tcf_unbind_filter(struct Qdisc *q, struct tcf_result *r)
196 {
197 	unsigned long cl;
198 
199 	if ((cl = __cls_set_class(&r->class, 0)) != 0)
200 		q->ops->cl_ops->unbind_tcf(q, cl);
201 }
202 
203 static inline void
204 tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
205 {
206 	struct Qdisc *q = tp->chain->block->q;
207 
208 	if (!q)
209 		return;
210 	__tcf_unbind_filter(q, r);
211 }
212 
213 static inline void tc_cls_bind_class(u32 classid, unsigned long cl,
214 				     void *q, struct tcf_result *res,
215 				     unsigned long base)
216 {
217 	if (res->classid == classid) {
218 		if (cl)
219 			__tcf_bind_filter(q, res, base);
220 		else
221 			__tcf_unbind_filter(q, res);
222 	}
223 }
224 
225 struct tcf_exts {
226 #ifdef CONFIG_NET_CLS_ACT
227 	__u32	type; /* for backward compat(TCA_OLD_COMPAT) */
228 	int nr_actions;
229 	struct tc_action **actions;
230 	struct net	*net;
231 	netns_tracker	ns_tracker;
232 #endif
233 	/* Map to export classifier specific extension TLV types to the
234 	 * generic extensions API. Unsupported extensions must be set to 0.
235 	 */
236 	int action;
237 	int police;
238 };
239 
240 static inline int tcf_exts_init(struct tcf_exts *exts, struct net *net,
241 				int action, int police)
242 {
243 #ifdef CONFIG_NET_CLS_ACT
244 	exts->type = 0;
245 	exts->nr_actions = 0;
246 	/* Note: we do not own yet a reference on net.
247 	 * This reference might be taken later from tcf_exts_get_net().
248 	 */
249 	exts->net = net;
250 	exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
251 				GFP_KERNEL);
252 	if (!exts->actions)
253 		return -ENOMEM;
254 #endif
255 	exts->action = action;
256 	exts->police = police;
257 	return 0;
258 }
259 
260 /* Return false if the netns is being destroyed in cleanup_net(). Callers
261  * need to do cleanup synchronously in this case, otherwise may race with
262  * tc_action_net_exit(). Return true for other cases.
263  */
264 static inline bool tcf_exts_get_net(struct tcf_exts *exts)
265 {
266 #ifdef CONFIG_NET_CLS_ACT
267 	exts->net = maybe_get_net(exts->net);
268 	if (exts->net)
269 		netns_tracker_alloc(exts->net, &exts->ns_tracker, GFP_KERNEL);
270 	return exts->net != NULL;
271 #else
272 	return true;
273 #endif
274 }
275 
276 static inline void tcf_exts_put_net(struct tcf_exts *exts)
277 {
278 #ifdef CONFIG_NET_CLS_ACT
279 	if (exts->net)
280 		put_net_track(exts->net, &exts->ns_tracker);
281 #endif
282 }
283 
284 #ifdef CONFIG_NET_CLS_ACT
285 #define tcf_exts_for_each_action(i, a, exts) \
286 	for (i = 0; i < TCA_ACT_MAX_PRIO && ((a) = (exts)->actions[i]); i++)
287 #else
288 #define tcf_exts_for_each_action(i, a, exts) \
289 	for (; 0; (void)(i), (void)(a), (void)(exts))
290 #endif
291 
292 #define tcf_act_for_each_action(i, a, actions) \
293 	for (i = 0; i < TCA_ACT_MAX_PRIO && ((a) = actions[i]); i++)
294 
295 static inline void
296 tcf_exts_hw_stats_update(const struct tcf_exts *exts,
297 			 u64 bytes, u64 packets, u64 drops, u64 lastuse,
298 			 u8 used_hw_stats, bool used_hw_stats_valid)
299 {
300 #ifdef CONFIG_NET_CLS_ACT
301 	int i;
302 
303 	for (i = 0; i < exts->nr_actions; i++) {
304 		struct tc_action *a = exts->actions[i];
305 
306 		/* if stats from hw, just skip */
307 		if (tcf_action_update_hw_stats(a)) {
308 			preempt_disable();
309 			tcf_action_stats_update(a, bytes, packets, drops,
310 						lastuse, true);
311 			preempt_enable();
312 
313 			a->used_hw_stats = used_hw_stats;
314 			a->used_hw_stats_valid = used_hw_stats_valid;
315 		}
316 	}
317 #endif
318 }
319 
320 /**
321  * tcf_exts_has_actions - check if at least one action is present
322  * @exts: tc filter extensions handle
323  *
324  * Returns true if at least one action is present.
325  */
326 static inline bool tcf_exts_has_actions(struct tcf_exts *exts)
327 {
328 #ifdef CONFIG_NET_CLS_ACT
329 	return exts->nr_actions;
330 #else
331 	return false;
332 #endif
333 }
334 
335 /**
336  * tcf_exts_exec - execute tc filter extensions
337  * @skb: socket buffer
338  * @exts: tc filter extensions handle
339  * @res: desired result
340  *
341  * Executes all configured extensions. Returns TC_ACT_OK on a normal execution,
342  * a negative number if the filter must be considered unmatched or
343  * a positive action code (TC_ACT_*) which must be returned to the
344  * underlying layer.
345  */
346 static inline int
347 tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
348 	      struct tcf_result *res)
349 {
350 #ifdef CONFIG_NET_CLS_ACT
351 	return tcf_action_exec(skb, exts->actions, exts->nr_actions, res);
352 #endif
353 	return TC_ACT_OK;
354 }
355 
356 int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
357 		      struct nlattr **tb, struct nlattr *rate_tlv,
358 		      struct tcf_exts *exts, u32 flags,
359 		      struct netlink_ext_ack *extack);
360 int tcf_exts_validate_ex(struct net *net, struct tcf_proto *tp, struct nlattr **tb,
361 			 struct nlattr *rate_tlv, struct tcf_exts *exts,
362 			 u32 flags, u32 fl_flags, struct netlink_ext_ack *extack);
363 void tcf_exts_destroy(struct tcf_exts *exts);
364 void tcf_exts_change(struct tcf_exts *dst, struct tcf_exts *src);
365 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
366 int tcf_exts_terse_dump(struct sk_buff *skb, struct tcf_exts *exts);
367 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
368 
369 /**
370  * struct tcf_pkt_info - packet information
371  *
372  * @ptr: start of the pkt data
373  * @nexthdr: offset of the next header
374  */
375 struct tcf_pkt_info {
376 	unsigned char *		ptr;
377 	int			nexthdr;
378 };
379 
380 #ifdef CONFIG_NET_EMATCH
381 
382 struct tcf_ematch_ops;
383 
384 /**
385  * struct tcf_ematch - extended match (ematch)
386  *
387  * @matchid: identifier to allow userspace to reidentify a match
388  * @flags: flags specifying attributes and the relation to other matches
389  * @ops: the operations lookup table of the corresponding ematch module
390  * @datalen: length of the ematch specific configuration data
391  * @data: ematch specific data
392  * @net: the network namespace
393  */
394 struct tcf_ematch {
395 	struct tcf_ematch_ops * ops;
396 	unsigned long		data;
397 	unsigned int		datalen;
398 	u16			matchid;
399 	u16			flags;
400 	struct net		*net;
401 };
402 
403 static inline int tcf_em_is_container(struct tcf_ematch *em)
404 {
405 	return !em->ops;
406 }
407 
408 static inline int tcf_em_is_simple(struct tcf_ematch *em)
409 {
410 	return em->flags & TCF_EM_SIMPLE;
411 }
412 
413 static inline int tcf_em_is_inverted(struct tcf_ematch *em)
414 {
415 	return em->flags & TCF_EM_INVERT;
416 }
417 
418 static inline int tcf_em_last_match(struct tcf_ematch *em)
419 {
420 	return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
421 }
422 
423 static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
424 {
425 	if (tcf_em_last_match(em))
426 		return 1;
427 
428 	if (result == 0 && em->flags & TCF_EM_REL_AND)
429 		return 1;
430 
431 	if (result != 0 && em->flags & TCF_EM_REL_OR)
432 		return 1;
433 
434 	return 0;
435 }
436 
437 /**
438  * struct tcf_ematch_tree - ematch tree handle
439  *
440  * @hdr: ematch tree header supplied by userspace
441  * @matches: array of ematches
442  */
443 struct tcf_ematch_tree {
444 	struct tcf_ematch_tree_hdr hdr;
445 	struct tcf_ematch *	matches;
446 
447 };
448 
449 /**
450  * struct tcf_ematch_ops - ematch module operations
451  *
452  * @kind: identifier (kind) of this ematch module
453  * @datalen: length of expected configuration data (optional)
454  * @change: called during validation (optional)
455  * @match: called during ematch tree evaluation, must return 1/0
456  * @destroy: called during destroyage (optional)
457  * @dump: called during dumping process (optional)
458  * @owner: owner, must be set to THIS_MODULE
459  * @link: link to previous/next ematch module (internal use)
460  */
461 struct tcf_ematch_ops {
462 	int			kind;
463 	int			datalen;
464 	int			(*change)(struct net *net, void *,
465 					  int, struct tcf_ematch *);
466 	int			(*match)(struct sk_buff *, struct tcf_ematch *,
467 					 struct tcf_pkt_info *);
468 	void			(*destroy)(struct tcf_ematch *);
469 	int			(*dump)(struct sk_buff *, struct tcf_ematch *);
470 	struct module		*owner;
471 	struct list_head	link;
472 };
473 
474 int tcf_em_register(struct tcf_ematch_ops *);
475 void tcf_em_unregister(struct tcf_ematch_ops *);
476 int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
477 			 struct tcf_ematch_tree *);
478 void tcf_em_tree_destroy(struct tcf_ematch_tree *);
479 int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
480 int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
481 			struct tcf_pkt_info *);
482 
483 /**
484  * tcf_em_tree_match - evaulate an ematch tree
485  *
486  * @skb: socket buffer of the packet in question
487  * @tree: ematch tree to be used for evaluation
488  * @info: packet information examined by classifier
489  *
490  * This function matches @skb against the ematch tree in @tree by going
491  * through all ematches respecting their logic relations returning
492  * as soon as the result is obvious.
493  *
494  * Returns 1 if the ematch tree as-one matches, no ematches are configured
495  * or ematch is not enabled in the kernel, otherwise 0 is returned.
496  */
497 static inline int tcf_em_tree_match(struct sk_buff *skb,
498 				    struct tcf_ematch_tree *tree,
499 				    struct tcf_pkt_info *info)
500 {
501 	if (tree->hdr.nmatches)
502 		return __tcf_em_tree_match(skb, tree, info);
503 	else
504 		return 1;
505 }
506 
507 #define MODULE_ALIAS_TCF_EMATCH(kind)	MODULE_ALIAS("ematch-kind-" __stringify(kind))
508 
509 #else /* CONFIG_NET_EMATCH */
510 
511 struct tcf_ematch_tree {
512 };
513 
514 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
515 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
516 #define tcf_em_tree_dump(skb, t, tlv) (0)
517 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
518 
519 #endif /* CONFIG_NET_EMATCH */
520 
521 static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
522 {
523 	switch (layer) {
524 		case TCF_LAYER_LINK:
525 			return skb_mac_header(skb);
526 		case TCF_LAYER_NETWORK:
527 			return skb_network_header(skb);
528 		case TCF_LAYER_TRANSPORT:
529 			return skb_transport_header(skb);
530 	}
531 
532 	return NULL;
533 }
534 
535 static inline int tcf_valid_offset(const struct sk_buff *skb,
536 				   const unsigned char *ptr, const int len)
537 {
538 	return likely((ptr + len) <= skb_tail_pointer(skb) &&
539 		      ptr >= skb->head &&
540 		      (ptr <= (ptr + len)));
541 }
542 
543 static inline int
544 tcf_change_indev(struct net *net, struct nlattr *indev_tlv,
545 		 struct netlink_ext_ack *extack)
546 {
547 	char indev[IFNAMSIZ];
548 	struct net_device *dev;
549 
550 	if (nla_strscpy(indev, indev_tlv, IFNAMSIZ) < 0) {
551 		NL_SET_ERR_MSG_ATTR(extack, indev_tlv,
552 				    "Interface name too long");
553 		return -EINVAL;
554 	}
555 	dev = __dev_get_by_name(net, indev);
556 	if (!dev) {
557 		NL_SET_ERR_MSG_ATTR(extack, indev_tlv,
558 				    "Network device not found");
559 		return -ENODEV;
560 	}
561 	return dev->ifindex;
562 }
563 
564 static inline bool
565 tcf_match_indev(struct sk_buff *skb, int ifindex)
566 {
567 	if (!ifindex)
568 		return true;
569 	if  (!skb->skb_iif)
570 		return false;
571 	return ifindex == skb->skb_iif;
572 }
573 
574 int tc_setup_offload_action(struct flow_action *flow_action,
575 			    const struct tcf_exts *exts,
576 			    struct netlink_ext_ack *extack);
577 void tc_cleanup_offload_action(struct flow_action *flow_action);
578 int tc_setup_action(struct flow_action *flow_action,
579 		    struct tc_action *actions[],
580 		    struct netlink_ext_ack *extack);
581 
582 int tc_setup_cb_call(struct tcf_block *block, enum tc_setup_type type,
583 		     void *type_data, bool err_stop, bool rtnl_held);
584 int tc_setup_cb_add(struct tcf_block *block, struct tcf_proto *tp,
585 		    enum tc_setup_type type, void *type_data, bool err_stop,
586 		    u32 *flags, unsigned int *in_hw_count, bool rtnl_held);
587 int tc_setup_cb_replace(struct tcf_block *block, struct tcf_proto *tp,
588 			enum tc_setup_type type, void *type_data, bool err_stop,
589 			u32 *old_flags, unsigned int *old_in_hw_count,
590 			u32 *new_flags, unsigned int *new_in_hw_count,
591 			bool rtnl_held);
592 int tc_setup_cb_destroy(struct tcf_block *block, struct tcf_proto *tp,
593 			enum tc_setup_type type, void *type_data, bool err_stop,
594 			u32 *flags, unsigned int *in_hw_count, bool rtnl_held);
595 int tc_setup_cb_reoffload(struct tcf_block *block, struct tcf_proto *tp,
596 			  bool add, flow_setup_cb_t *cb,
597 			  enum tc_setup_type type, void *type_data,
598 			  void *cb_priv, u32 *flags, unsigned int *in_hw_count);
599 unsigned int tcf_exts_num_actions(struct tcf_exts *exts);
600 
601 #ifdef CONFIG_NET_CLS_ACT
602 int tcf_qevent_init(struct tcf_qevent *qe, struct Qdisc *sch,
603 		    enum flow_block_binder_type binder_type,
604 		    struct nlattr *block_index_attr,
605 		    struct netlink_ext_ack *extack);
606 void tcf_qevent_destroy(struct tcf_qevent *qe, struct Qdisc *sch);
607 int tcf_qevent_validate_change(struct tcf_qevent *qe, struct nlattr *block_index_attr,
608 			       struct netlink_ext_ack *extack);
609 struct sk_buff *tcf_qevent_handle(struct tcf_qevent *qe, struct Qdisc *sch, struct sk_buff *skb,
610 				  struct sk_buff **to_free, int *ret);
611 int tcf_qevent_dump(struct sk_buff *skb, int attr_name, struct tcf_qevent *qe);
612 #else
613 static inline int tcf_qevent_init(struct tcf_qevent *qe, struct Qdisc *sch,
614 				  enum flow_block_binder_type binder_type,
615 				  struct nlattr *block_index_attr,
616 				  struct netlink_ext_ack *extack)
617 {
618 	return 0;
619 }
620 
621 static inline void tcf_qevent_destroy(struct tcf_qevent *qe, struct Qdisc *sch)
622 {
623 }
624 
625 static inline int tcf_qevent_validate_change(struct tcf_qevent *qe, struct nlattr *block_index_attr,
626 					     struct netlink_ext_ack *extack)
627 {
628 	return 0;
629 }
630 
631 static inline struct sk_buff *
632 tcf_qevent_handle(struct tcf_qevent *qe, struct Qdisc *sch, struct sk_buff *skb,
633 		  struct sk_buff **to_free, int *ret)
634 {
635 	return skb;
636 }
637 
638 static inline int tcf_qevent_dump(struct sk_buff *skb, int attr_name, struct tcf_qevent *qe)
639 {
640 	return 0;
641 }
642 #endif
643 
644 struct tc_cls_u32_knode {
645 	struct tcf_exts *exts;
646 	struct tcf_result *res;
647 	struct tc_u32_sel *sel;
648 	u32 handle;
649 	u32 val;
650 	u32 mask;
651 	u32 link_handle;
652 	u8 fshift;
653 };
654 
655 struct tc_cls_u32_hnode {
656 	u32 handle;
657 	u32 prio;
658 	unsigned int divisor;
659 };
660 
661 enum tc_clsu32_command {
662 	TC_CLSU32_NEW_KNODE,
663 	TC_CLSU32_REPLACE_KNODE,
664 	TC_CLSU32_DELETE_KNODE,
665 	TC_CLSU32_NEW_HNODE,
666 	TC_CLSU32_REPLACE_HNODE,
667 	TC_CLSU32_DELETE_HNODE,
668 };
669 
670 struct tc_cls_u32_offload {
671 	struct flow_cls_common_offload common;
672 	/* knode values */
673 	enum tc_clsu32_command command;
674 	union {
675 		struct tc_cls_u32_knode knode;
676 		struct tc_cls_u32_hnode hnode;
677 	};
678 };
679 
680 static inline bool tc_can_offload(const struct net_device *dev)
681 {
682 	return dev->features & NETIF_F_HW_TC;
683 }
684 
685 static inline bool tc_can_offload_extack(const struct net_device *dev,
686 					 struct netlink_ext_ack *extack)
687 {
688 	bool can = tc_can_offload(dev);
689 
690 	if (!can)
691 		NL_SET_ERR_MSG(extack, "TC offload is disabled on net device");
692 
693 	return can;
694 }
695 
696 static inline bool
697 tc_cls_can_offload_and_chain0(const struct net_device *dev,
698 			      struct flow_cls_common_offload *common)
699 {
700 	if (!tc_can_offload_extack(dev, common->extack))
701 		return false;
702 	if (common->chain_index) {
703 		NL_SET_ERR_MSG(common->extack,
704 			       "Driver supports only offload of chain 0");
705 		return false;
706 	}
707 	return true;
708 }
709 
710 static inline bool tc_skip_hw(u32 flags)
711 {
712 	return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
713 }
714 
715 static inline bool tc_skip_sw(u32 flags)
716 {
717 	return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
718 }
719 
720 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
721 static inline bool tc_flags_valid(u32 flags)
722 {
723 	if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW |
724 		      TCA_CLS_FLAGS_VERBOSE))
725 		return false;
726 
727 	flags &= TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW;
728 	if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
729 		return false;
730 
731 	return true;
732 }
733 
734 static inline bool tc_in_hw(u32 flags)
735 {
736 	return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
737 }
738 
739 static inline void
740 tc_cls_common_offload_init(struct flow_cls_common_offload *cls_common,
741 			   const struct tcf_proto *tp, u32 flags,
742 			   struct netlink_ext_ack *extack)
743 {
744 	cls_common->chain_index = tp->chain->index;
745 	cls_common->protocol = tp->protocol;
746 	cls_common->prio = tp->prio >> 16;
747 	if (tc_skip_sw(flags) || flags & TCA_CLS_FLAGS_VERBOSE)
748 		cls_common->extack = extack;
749 }
750 
751 #if IS_ENABLED(CONFIG_NET_TC_SKB_EXT)
752 static inline struct tc_skb_ext *tc_skb_ext_alloc(struct sk_buff *skb)
753 {
754 	struct tc_skb_ext *tc_skb_ext = skb_ext_add(skb, TC_SKB_EXT);
755 
756 	if (tc_skb_ext)
757 		memset(tc_skb_ext, 0, sizeof(*tc_skb_ext));
758 	return tc_skb_ext;
759 }
760 #endif
761 
762 enum tc_matchall_command {
763 	TC_CLSMATCHALL_REPLACE,
764 	TC_CLSMATCHALL_DESTROY,
765 	TC_CLSMATCHALL_STATS,
766 };
767 
768 struct tc_cls_matchall_offload {
769 	struct flow_cls_common_offload common;
770 	enum tc_matchall_command command;
771 	struct flow_rule *rule;
772 	struct flow_stats stats;
773 	unsigned long cookie;
774 };
775 
776 enum tc_clsbpf_command {
777 	TC_CLSBPF_OFFLOAD,
778 	TC_CLSBPF_STATS,
779 };
780 
781 struct tc_cls_bpf_offload {
782 	struct flow_cls_common_offload common;
783 	enum tc_clsbpf_command command;
784 	struct tcf_exts *exts;
785 	struct bpf_prog *prog;
786 	struct bpf_prog *oldprog;
787 	const char *name;
788 	bool exts_integrated;
789 };
790 
791 struct tc_mqprio_qopt_offload {
792 	/* struct tc_mqprio_qopt must always be the first element */
793 	struct tc_mqprio_qopt qopt;
794 	u16 mode;
795 	u16 shaper;
796 	u32 flags;
797 	u64 min_rate[TC_QOPT_MAX_QUEUE];
798 	u64 max_rate[TC_QOPT_MAX_QUEUE];
799 };
800 
801 /* This structure holds cookie structure that is passed from user
802  * to the kernel for actions and classifiers
803  */
804 struct tc_cookie {
805 	u8  *data;
806 	u32 len;
807 	struct rcu_head rcu;
808 };
809 
810 struct tc_qopt_offload_stats {
811 	struct gnet_stats_basic_sync *bstats;
812 	struct gnet_stats_queue *qstats;
813 };
814 
815 enum tc_mq_command {
816 	TC_MQ_CREATE,
817 	TC_MQ_DESTROY,
818 	TC_MQ_STATS,
819 	TC_MQ_GRAFT,
820 };
821 
822 struct tc_mq_opt_offload_graft_params {
823 	unsigned long queue;
824 	u32 child_handle;
825 };
826 
827 struct tc_mq_qopt_offload {
828 	enum tc_mq_command command;
829 	u32 handle;
830 	union {
831 		struct tc_qopt_offload_stats stats;
832 		struct tc_mq_opt_offload_graft_params graft_params;
833 	};
834 };
835 
836 enum tc_htb_command {
837 	/* Root */
838 	TC_HTB_CREATE, /* Initialize HTB offload. */
839 	TC_HTB_DESTROY, /* Destroy HTB offload. */
840 
841 	/* Classes */
842 	/* Allocate qid and create leaf. */
843 	TC_HTB_LEAF_ALLOC_QUEUE,
844 	/* Convert leaf to inner, preserve and return qid, create new leaf. */
845 	TC_HTB_LEAF_TO_INNER,
846 	/* Delete leaf, while siblings remain. */
847 	TC_HTB_LEAF_DEL,
848 	/* Delete leaf, convert parent to leaf, preserving qid. */
849 	TC_HTB_LEAF_DEL_LAST,
850 	/* TC_HTB_LEAF_DEL_LAST, but delete driver data on hardware errors. */
851 	TC_HTB_LEAF_DEL_LAST_FORCE,
852 	/* Modify parameters of a node. */
853 	TC_HTB_NODE_MODIFY,
854 
855 	/* Class qdisc */
856 	TC_HTB_LEAF_QUERY_QUEUE, /* Query qid by classid. */
857 };
858 
859 struct tc_htb_qopt_offload {
860 	struct netlink_ext_ack *extack;
861 	enum tc_htb_command command;
862 	u32 parent_classid;
863 	u16 classid;
864 	u16 qid;
865 	u64 rate;
866 	u64 ceil;
867 };
868 
869 #define TC_HTB_CLASSID_ROOT U32_MAX
870 
871 enum tc_red_command {
872 	TC_RED_REPLACE,
873 	TC_RED_DESTROY,
874 	TC_RED_STATS,
875 	TC_RED_XSTATS,
876 	TC_RED_GRAFT,
877 };
878 
879 struct tc_red_qopt_offload_params {
880 	u32 min;
881 	u32 max;
882 	u32 probability;
883 	u32 limit;
884 	bool is_ecn;
885 	bool is_harddrop;
886 	bool is_nodrop;
887 	struct gnet_stats_queue *qstats;
888 };
889 
890 struct tc_red_qopt_offload {
891 	enum tc_red_command command;
892 	u32 handle;
893 	u32 parent;
894 	union {
895 		struct tc_red_qopt_offload_params set;
896 		struct tc_qopt_offload_stats stats;
897 		struct red_stats *xstats;
898 		u32 child_handle;
899 	};
900 };
901 
902 enum tc_gred_command {
903 	TC_GRED_REPLACE,
904 	TC_GRED_DESTROY,
905 	TC_GRED_STATS,
906 };
907 
908 struct tc_gred_vq_qopt_offload_params {
909 	bool present;
910 	u32 limit;
911 	u32 prio;
912 	u32 min;
913 	u32 max;
914 	bool is_ecn;
915 	bool is_harddrop;
916 	u32 probability;
917 	/* Only need backlog, see struct tc_prio_qopt_offload_params */
918 	u32 *backlog;
919 };
920 
921 struct tc_gred_qopt_offload_params {
922 	bool grio_on;
923 	bool wred_on;
924 	unsigned int dp_cnt;
925 	unsigned int dp_def;
926 	struct gnet_stats_queue *qstats;
927 	struct tc_gred_vq_qopt_offload_params tab[MAX_DPs];
928 };
929 
930 struct tc_gred_qopt_offload_stats {
931 	struct gnet_stats_basic_sync bstats[MAX_DPs];
932 	struct gnet_stats_queue qstats[MAX_DPs];
933 	struct red_stats *xstats[MAX_DPs];
934 };
935 
936 struct tc_gred_qopt_offload {
937 	enum tc_gred_command command;
938 	u32 handle;
939 	u32 parent;
940 	union {
941 		struct tc_gred_qopt_offload_params set;
942 		struct tc_gred_qopt_offload_stats stats;
943 	};
944 };
945 
946 enum tc_prio_command {
947 	TC_PRIO_REPLACE,
948 	TC_PRIO_DESTROY,
949 	TC_PRIO_STATS,
950 	TC_PRIO_GRAFT,
951 };
952 
953 struct tc_prio_qopt_offload_params {
954 	int bands;
955 	u8 priomap[TC_PRIO_MAX + 1];
956 	/* At the point of un-offloading the Qdisc, the reported backlog and
957 	 * qlen need to be reduced by the portion that is in HW.
958 	 */
959 	struct gnet_stats_queue *qstats;
960 };
961 
962 struct tc_prio_qopt_offload_graft_params {
963 	u8 band;
964 	u32 child_handle;
965 };
966 
967 struct tc_prio_qopt_offload {
968 	enum tc_prio_command command;
969 	u32 handle;
970 	u32 parent;
971 	union {
972 		struct tc_prio_qopt_offload_params replace_params;
973 		struct tc_qopt_offload_stats stats;
974 		struct tc_prio_qopt_offload_graft_params graft_params;
975 	};
976 };
977 
978 enum tc_root_command {
979 	TC_ROOT_GRAFT,
980 };
981 
982 struct tc_root_qopt_offload {
983 	enum tc_root_command command;
984 	u32 handle;
985 	bool ingress;
986 };
987 
988 enum tc_ets_command {
989 	TC_ETS_REPLACE,
990 	TC_ETS_DESTROY,
991 	TC_ETS_STATS,
992 	TC_ETS_GRAFT,
993 };
994 
995 struct tc_ets_qopt_offload_replace_params {
996 	unsigned int bands;
997 	u8 priomap[TC_PRIO_MAX + 1];
998 	unsigned int quanta[TCQ_ETS_MAX_BANDS];	/* 0 for strict bands. */
999 	unsigned int weights[TCQ_ETS_MAX_BANDS];
1000 	struct gnet_stats_queue *qstats;
1001 };
1002 
1003 struct tc_ets_qopt_offload_graft_params {
1004 	u8 band;
1005 	u32 child_handle;
1006 };
1007 
1008 struct tc_ets_qopt_offload {
1009 	enum tc_ets_command command;
1010 	u32 handle;
1011 	u32 parent;
1012 	union {
1013 		struct tc_ets_qopt_offload_replace_params replace_params;
1014 		struct tc_qopt_offload_stats stats;
1015 		struct tc_ets_qopt_offload_graft_params graft_params;
1016 	};
1017 };
1018 
1019 enum tc_tbf_command {
1020 	TC_TBF_REPLACE,
1021 	TC_TBF_DESTROY,
1022 	TC_TBF_STATS,
1023 	TC_TBF_GRAFT,
1024 };
1025 
1026 struct tc_tbf_qopt_offload_replace_params {
1027 	struct psched_ratecfg rate;
1028 	u32 max_size;
1029 	struct gnet_stats_queue *qstats;
1030 };
1031 
1032 struct tc_tbf_qopt_offload {
1033 	enum tc_tbf_command command;
1034 	u32 handle;
1035 	u32 parent;
1036 	union {
1037 		struct tc_tbf_qopt_offload_replace_params replace_params;
1038 		struct tc_qopt_offload_stats stats;
1039 		u32 child_handle;
1040 	};
1041 };
1042 
1043 enum tc_fifo_command {
1044 	TC_FIFO_REPLACE,
1045 	TC_FIFO_DESTROY,
1046 	TC_FIFO_STATS,
1047 };
1048 
1049 struct tc_fifo_qopt_offload {
1050 	enum tc_fifo_command command;
1051 	u32 handle;
1052 	u32 parent;
1053 	union {
1054 		struct tc_qopt_offload_stats stats;
1055 	};
1056 };
1057 
1058 #ifdef CONFIG_NET_CLS_ACT
1059 DECLARE_STATIC_KEY_FALSE(tc_skb_ext_tc);
1060 void tc_skb_ext_tc_enable(void);
1061 void tc_skb_ext_tc_disable(void);
1062 #define tc_skb_ext_tc_enabled() static_branch_unlikely(&tc_skb_ext_tc)
1063 #else /* CONFIG_NET_CLS_ACT */
1064 static inline void tc_skb_ext_tc_enable(void) { }
1065 static inline void tc_skb_ext_tc_disable(void) { }
1066 #define tc_skb_ext_tc_enabled() false
1067 #endif
1068 
1069 #endif
1070