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