1 #ifndef _NET_FLOW_OFFLOAD_H
2 #define _NET_FLOW_OFFLOAD_H
4 #include <linux/kernel.h>
5 #include <linux/list.h>
6 #include <linux/netlink.h>
7 #include <net/flow_dissector.h>
10 struct flow_dissector
*dissector
;
15 struct flow_match_meta
{
16 struct flow_dissector_key_meta
*key
, *mask
;
19 struct flow_match_basic
{
20 struct flow_dissector_key_basic
*key
, *mask
;
23 struct flow_match_control
{
24 struct flow_dissector_key_control
*key
, *mask
;
27 struct flow_match_eth_addrs
{
28 struct flow_dissector_key_eth_addrs
*key
, *mask
;
31 struct flow_match_vlan
{
32 struct flow_dissector_key_vlan
*key
, *mask
;
35 struct flow_match_arp
{
36 struct flow_dissector_key_arp
*key
, *mask
;
39 struct flow_match_ipv4_addrs
{
40 struct flow_dissector_key_ipv4_addrs
*key
, *mask
;
43 struct flow_match_ipv6_addrs
{
44 struct flow_dissector_key_ipv6_addrs
*key
, *mask
;
47 struct flow_match_ip
{
48 struct flow_dissector_key_ip
*key
, *mask
;
51 struct flow_match_ports
{
52 struct flow_dissector_key_ports
*key
, *mask
;
55 struct flow_match_ports_range
{
56 struct flow_dissector_key_ports_range
*key
, *mask
;
59 struct flow_match_icmp
{
60 struct flow_dissector_key_icmp
*key
, *mask
;
63 struct flow_match_tcp
{
64 struct flow_dissector_key_tcp
*key
, *mask
;
67 struct flow_match_ipsec
{
68 struct flow_dissector_key_ipsec
*key
, *mask
;
71 struct flow_match_mpls
{
72 struct flow_dissector_key_mpls
*key
, *mask
;
75 struct flow_match_enc_keyid
{
76 struct flow_dissector_key_keyid
*key
, *mask
;
79 struct flow_match_enc_opts
{
80 struct flow_dissector_key_enc_opts
*key
, *mask
;
83 struct flow_match_ct
{
84 struct flow_dissector_key_ct
*key
, *mask
;
87 struct flow_match_pppoe
{
88 struct flow_dissector_key_pppoe
*key
, *mask
;
91 struct flow_match_l2tpv3
{
92 struct flow_dissector_key_l2tpv3
*key
, *mask
;
97 void flow_rule_match_meta(const struct flow_rule
*rule
,
98 struct flow_match_meta
*out
);
99 void flow_rule_match_basic(const struct flow_rule
*rule
,
100 struct flow_match_basic
*out
);
101 void flow_rule_match_control(const struct flow_rule
*rule
,
102 struct flow_match_control
*out
);
103 void flow_rule_match_eth_addrs(const struct flow_rule
*rule
,
104 struct flow_match_eth_addrs
*out
);
105 void flow_rule_match_vlan(const struct flow_rule
*rule
,
106 struct flow_match_vlan
*out
);
107 void flow_rule_match_cvlan(const struct flow_rule
*rule
,
108 struct flow_match_vlan
*out
);
109 void flow_rule_match_arp(const struct flow_rule
*rule
,
110 struct flow_match_arp
*out
);
111 void flow_rule_match_ipv4_addrs(const struct flow_rule
*rule
,
112 struct flow_match_ipv4_addrs
*out
);
113 void flow_rule_match_ipv6_addrs(const struct flow_rule
*rule
,
114 struct flow_match_ipv6_addrs
*out
);
115 void flow_rule_match_ip(const struct flow_rule
*rule
,
116 struct flow_match_ip
*out
);
117 void flow_rule_match_ports(const struct flow_rule
*rule
,
118 struct flow_match_ports
*out
);
119 void flow_rule_match_ports_range(const struct flow_rule
*rule
,
120 struct flow_match_ports_range
*out
);
121 void flow_rule_match_tcp(const struct flow_rule
*rule
,
122 struct flow_match_tcp
*out
);
123 void flow_rule_match_ipsec(const struct flow_rule
*rule
,
124 struct flow_match_ipsec
*out
);
125 void flow_rule_match_icmp(const struct flow_rule
*rule
,
126 struct flow_match_icmp
*out
);
127 void flow_rule_match_mpls(const struct flow_rule
*rule
,
128 struct flow_match_mpls
*out
);
129 void flow_rule_match_enc_control(const struct flow_rule
*rule
,
130 struct flow_match_control
*out
);
131 void flow_rule_match_enc_ipv4_addrs(const struct flow_rule
*rule
,
132 struct flow_match_ipv4_addrs
*out
);
133 void flow_rule_match_enc_ipv6_addrs(const struct flow_rule
*rule
,
134 struct flow_match_ipv6_addrs
*out
);
135 void flow_rule_match_enc_ip(const struct flow_rule
*rule
,
136 struct flow_match_ip
*out
);
137 void flow_rule_match_enc_ports(const struct flow_rule
*rule
,
138 struct flow_match_ports
*out
);
139 void flow_rule_match_enc_keyid(const struct flow_rule
*rule
,
140 struct flow_match_enc_keyid
*out
);
141 void flow_rule_match_enc_opts(const struct flow_rule
*rule
,
142 struct flow_match_enc_opts
*out
);
143 void flow_rule_match_ct(const struct flow_rule
*rule
,
144 struct flow_match_ct
*out
);
145 void flow_rule_match_pppoe(const struct flow_rule
*rule
,
146 struct flow_match_pppoe
*out
);
147 void flow_rule_match_l2tpv3(const struct flow_rule
*rule
,
148 struct flow_match_l2tpv3
*out
);
150 enum flow_action_id
{
151 FLOW_ACTION_ACCEPT
= 0,
155 FLOW_ACTION_REDIRECT
,
157 FLOW_ACTION_REDIRECT_INGRESS
,
158 FLOW_ACTION_MIRRED_INGRESS
,
159 FLOW_ACTION_VLAN_PUSH
,
160 FLOW_ACTION_VLAN_POP
,
161 FLOW_ACTION_VLAN_MANGLE
,
162 FLOW_ACTION_TUNNEL_ENCAP
,
163 FLOW_ACTION_TUNNEL_DECAP
,
169 FLOW_ACTION_PRIORITY
,
170 FLOW_ACTION_RX_QUEUE_MAPPING
,
176 FLOW_ACTION_CT_METADATA
,
177 FLOW_ACTION_MPLS_PUSH
,
178 FLOW_ACTION_MPLS_POP
,
179 FLOW_ACTION_MPLS_MANGLE
,
181 FLOW_ACTION_PPPOE_PUSH
,
184 FLOW_ACTION_VLAN_PUSH_ETH
,
185 FLOW_ACTION_VLAN_POP_ETH
,
186 FLOW_ACTION_CONTINUE
,
190 /* This is mirroring enum pedit_header_type definition for easy mapping between
191 * tc pedit action. Legacy TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK is mapped to
192 * FLOW_ACT_MANGLE_UNSPEC, which is supported by no driver.
194 enum flow_action_mangle_base
{
195 FLOW_ACT_MANGLE_UNSPEC
= 0,
196 FLOW_ACT_MANGLE_HDR_TYPE_ETH
,
197 FLOW_ACT_MANGLE_HDR_TYPE_IP4
,
198 FLOW_ACT_MANGLE_HDR_TYPE_IP6
,
199 FLOW_ACT_MANGLE_HDR_TYPE_TCP
,
200 FLOW_ACT_MANGLE_HDR_TYPE_UDP
,
203 enum flow_action_hw_stats_bit
{
204 FLOW_ACTION_HW_STATS_IMMEDIATE_BIT
,
205 FLOW_ACTION_HW_STATS_DELAYED_BIT
,
206 FLOW_ACTION_HW_STATS_DISABLED_BIT
,
208 FLOW_ACTION_HW_STATS_NUM_BITS
211 enum flow_action_hw_stats
{
212 FLOW_ACTION_HW_STATS_IMMEDIATE
=
213 BIT(FLOW_ACTION_HW_STATS_IMMEDIATE_BIT
),
214 FLOW_ACTION_HW_STATS_DELAYED
= BIT(FLOW_ACTION_HW_STATS_DELAYED_BIT
),
215 FLOW_ACTION_HW_STATS_ANY
= FLOW_ACTION_HW_STATS_IMMEDIATE
|
216 FLOW_ACTION_HW_STATS_DELAYED
,
217 FLOW_ACTION_HW_STATS_DISABLED
=
218 BIT(FLOW_ACTION_HW_STATS_DISABLED_BIT
),
219 FLOW_ACTION_HW_STATS_DONT_CARE
= BIT(FLOW_ACTION_HW_STATS_NUM_BITS
) - 1,
222 typedef void (*action_destr
)(void *priv
);
224 struct flow_action_cookie
{
229 struct flow_action_cookie
*flow_action_cookie_create(void *data
,
232 void flow_action_cookie_destroy(struct flow_action_cookie
*cookie
);
234 struct flow_action_entry
{
235 enum flow_action_id id
;
237 unsigned long cookie
;
239 enum flow_action_hw_stats hw_stats
;
240 action_destr destructor
;
241 void *destructor_priv
;
243 u32 chain_index
; /* FLOW_ACTION_GOTO */
244 struct net_device
*dev
; /* FLOW_ACTION_REDIRECT */
245 struct { /* FLOW_ACTION_VLAN */
250 struct { /* FLOW_ACTION_VLAN_PUSH_ETH */
251 unsigned char dst
[ETH_ALEN
];
252 unsigned char src
[ETH_ALEN
];
254 struct { /* FLOW_ACTION_MANGLE */
255 /* FLOW_ACTION_ADD */
256 enum flow_action_mangle_base htype
;
261 struct ip_tunnel_info
*tunnel
; /* FLOW_ACTION_TUNNEL_ENCAP */
262 u32 csum_flags
; /* FLOW_ACTION_CSUM */
263 u32 mark
; /* FLOW_ACTION_MARK */
264 u16 ptype
; /* FLOW_ACTION_PTYPE */
265 u16 rx_queue
; /* FLOW_ACTION_RX_QUEUE_MAPPING */
266 u32 priority
; /* FLOW_ACTION_PRIORITY */
267 struct { /* FLOW_ACTION_QUEUE */
272 struct { /* FLOW_ACTION_SAMPLE */
273 struct psample_group
*psample_group
;
278 struct { /* FLOW_ACTION_POLICE */
281 u64 peakrate_bytes_ps
;
288 enum flow_action_id act_id
;
292 struct { /* FLOW_ACTION_CT */
295 struct nf_flowtable
*flow_table
;
298 unsigned long cookie
;
303 struct { /* FLOW_ACTION_MPLS_PUSH */
310 struct { /* FLOW_ACTION_MPLS_POP */
313 struct { /* FLOW_ACTION_MPLS_MANGLE */
325 struct action_gate_entry
*entries
;
327 struct { /* FLOW_ACTION_PPPOE_PUSH */
331 struct flow_action_cookie
*user_cookie
; /* user defined action cookie */
335 unsigned int num_entries
;
336 struct flow_action_entry entries
[] __counted_by(num_entries
);
339 static inline bool flow_action_has_entries(const struct flow_action
*action
)
341 return action
->num_entries
;
345 * flow_offload_has_one_action() - check if exactly one action is present
346 * @action: tc filter flow offload action
348 * Return: true if exactly one action is present.
350 static inline bool flow_offload_has_one_action(const struct flow_action
*action
)
352 return action
->num_entries
== 1;
355 static inline bool flow_action_is_last_entry(const struct flow_action
*action
,
356 const struct flow_action_entry
*entry
)
358 return entry
== &action
->entries
[action
->num_entries
- 1];
361 #define flow_action_for_each(__i, __act, __actions) \
362 for (__i = 0, __act = &(__actions)->entries[0]; \
363 __i < (__actions)->num_entries; \
364 __act = &(__actions)->entries[++__i])
367 flow_action_mixed_hw_stats_check(const struct flow_action
*action
,
368 struct netlink_ext_ack
*extack
)
370 const struct flow_action_entry
*action_entry
;
374 if (flow_offload_has_one_action(action
))
377 flow_action_for_each(i
, action_entry
, action
) {
378 if (i
&& action_entry
->hw_stats
!= last_hw_stats
) {
379 NL_SET_ERR_MSG_MOD(extack
, "Mixing HW stats types for actions is not supported");
382 last_hw_stats
= action_entry
->hw_stats
;
387 static inline const struct flow_action_entry
*
388 flow_action_first_entry_get(const struct flow_action
*action
)
390 WARN_ON(!flow_action_has_entries(action
));
391 return &action
->entries
[0];
395 __flow_action_hw_stats_check(const struct flow_action
*action
,
396 struct netlink_ext_ack
*extack
,
397 bool check_allow_bit
,
398 enum flow_action_hw_stats_bit allow_bit
)
400 const struct flow_action_entry
*action_entry
;
402 if (!flow_action_has_entries(action
))
404 if (!flow_action_mixed_hw_stats_check(action
, extack
))
407 action_entry
= flow_action_first_entry_get(action
);
409 /* Zero is not a legal value for hw_stats, catch anyone passing it */
410 WARN_ON_ONCE(!action_entry
->hw_stats
);
412 if (!check_allow_bit
&&
413 ~action_entry
->hw_stats
& FLOW_ACTION_HW_STATS_ANY
) {
414 NL_SET_ERR_MSG_MOD(extack
, "Driver supports only default HW stats type \"any\"");
416 } else if (check_allow_bit
&&
417 !(action_entry
->hw_stats
& BIT(allow_bit
))) {
418 NL_SET_ERR_MSG_MOD(extack
, "Driver does not support selected HW stats type");
425 flow_action_hw_stats_check(const struct flow_action
*action
,
426 struct netlink_ext_ack
*extack
,
427 enum flow_action_hw_stats_bit allow_bit
)
429 return __flow_action_hw_stats_check(action
, extack
, true, allow_bit
);
433 flow_action_basic_hw_stats_check(const struct flow_action
*action
,
434 struct netlink_ext_ack
*extack
)
436 return __flow_action_hw_stats_check(action
, extack
, false, 0);
440 struct flow_match match
;
441 struct flow_action action
;
444 struct flow_rule
*flow_rule_alloc(unsigned int num_actions
);
446 static inline bool flow_rule_match_key(const struct flow_rule
*rule
,
447 enum flow_dissector_key_id key
)
449 return dissector_uses_key(rule
->match
.dissector
, key
);
453 * flow_rule_is_supp_control_flags() - check for supported control flags
454 * @supp_flags: control flags supported by driver
455 * @ctrl_flags: control flags present in rule
456 * @extack: The netlink extended ACK for reporting errors.
458 * Return: true if only supported control flags are set, false otherwise.
460 static inline bool flow_rule_is_supp_control_flags(const u32 supp_flags
,
461 const u32 ctrl_flags
,
462 struct netlink_ext_ack
*extack
)
464 if (likely((ctrl_flags
& ~supp_flags
) == 0))
467 NL_SET_ERR_MSG_FMT_MOD(extack
,
468 "Unsupported match on control.flags %#x",
475 * flow_rule_is_supp_enc_control_flags() - check for supported control flags
476 * @supp_enc_flags: encapsulation control flags supported by driver
477 * @enc_ctrl_flags: encapsulation control flags present in rule
478 * @extack: The netlink extended ACK for reporting errors.
480 * Return: true if only supported control flags are set, false otherwise.
482 static inline bool flow_rule_is_supp_enc_control_flags(const u32 supp_enc_flags
,
483 const u32 enc_ctrl_flags
,
484 struct netlink_ext_ack
*extack
)
486 if (likely((enc_ctrl_flags
& ~supp_enc_flags
) == 0))
489 NL_SET_ERR_MSG_FMT_MOD(extack
,
490 "Unsupported match on enc_control.flags %#x",
497 * flow_rule_has_control_flags() - check for presence of any control flags
498 * @ctrl_flags: control flags present in rule
499 * @extack: The netlink extended ACK for reporting errors.
501 * Return: true if control flags are set, false otherwise.
503 static inline bool flow_rule_has_control_flags(const u32 ctrl_flags
,
504 struct netlink_ext_ack
*extack
)
506 return !flow_rule_is_supp_control_flags(0, ctrl_flags
, extack
);
510 * flow_rule_has_enc_control_flags() - check for presence of any control flags
511 * @enc_ctrl_flags: encapsulation control flags present in rule
512 * @extack: The netlink extended ACK for reporting errors.
514 * Return: true if control flags are set, false otherwise.
516 static inline bool flow_rule_has_enc_control_flags(const u32 enc_ctrl_flags
,
517 struct netlink_ext_ack
*extack
)
519 return !flow_rule_is_supp_enc_control_flags(0, enc_ctrl_flags
, extack
);
523 * flow_rule_match_has_control_flags() - match and check for any control flags
524 * @rule: The flow_rule under evaluation.
525 * @extack: The netlink extended ACK for reporting errors.
527 * Return: true if control flags are set, false otherwise.
529 static inline bool flow_rule_match_has_control_flags(struct flow_rule
*rule
,
530 struct netlink_ext_ack
*extack
)
532 struct flow_match_control match
;
534 if (!flow_rule_match_key(rule
, FLOW_DISSECTOR_KEY_CONTROL
))
537 flow_rule_match_control(rule
, &match
);
539 return flow_rule_has_control_flags(match
.mask
->flags
, extack
);
547 enum flow_action_hw_stats used_hw_stats
;
548 bool used_hw_stats_valid
;
551 static inline void flow_stats_update(struct flow_stats
*flow_stats
,
553 u64 drops
, u64 lastused
,
554 enum flow_action_hw_stats used_hw_stats
)
556 flow_stats
->pkts
+= pkts
;
557 flow_stats
->bytes
+= bytes
;
558 flow_stats
->drops
+= drops
;
559 flow_stats
->lastused
= max_t(u64
, flow_stats
->lastused
, lastused
);
561 /* The driver should pass value with a maximum of one bit set.
562 * Passing FLOW_ACTION_HW_STATS_ANY is invalid.
564 WARN_ON(used_hw_stats
== FLOW_ACTION_HW_STATS_ANY
);
565 flow_stats
->used_hw_stats
|= used_hw_stats
;
566 flow_stats
->used_hw_stats_valid
= true;
569 enum flow_block_command
{
574 enum flow_block_binder_type
{
575 FLOW_BLOCK_BINDER_TYPE_UNSPEC
,
576 FLOW_BLOCK_BINDER_TYPE_CLSACT_INGRESS
,
577 FLOW_BLOCK_BINDER_TYPE_CLSACT_EGRESS
,
578 FLOW_BLOCK_BINDER_TYPE_RED_EARLY_DROP
,
579 FLOW_BLOCK_BINDER_TYPE_RED_MARK
,
583 struct list_head cb_list
;
586 struct netlink_ext_ack
;
588 struct flow_block_offload
{
589 enum flow_block_command command
;
590 enum flow_block_binder_type binder_type
;
592 bool unlocked_driver_cb
;
594 struct flow_block
*block
;
595 struct list_head cb_list
;
596 struct list_head
*driver_block_list
;
597 struct netlink_ext_ack
*extack
;
599 struct list_head
*cb_list_head
;
603 typedef int flow_setup_cb_t(enum tc_setup_type type
, void *type_data
,
606 struct flow_block_cb
;
608 struct flow_block_indr
{
609 struct list_head list
;
610 struct net_device
*dev
;
612 enum flow_block_binder_type binder_type
;
615 void (*cleanup
)(struct flow_block_cb
*block_cb
);
618 struct flow_block_cb
{
619 struct list_head driver_list
;
620 struct list_head list
;
624 void (*release
)(void *cb_priv
);
625 struct flow_block_indr indr
;
629 struct flow_block_cb
*flow_block_cb_alloc(flow_setup_cb_t
*cb
,
630 void *cb_ident
, void *cb_priv
,
631 void (*release
)(void *cb_priv
));
632 struct flow_block_cb
*flow_indr_block_cb_alloc(flow_setup_cb_t
*cb
,
633 void *cb_ident
, void *cb_priv
,
634 void (*release
)(void *cb_priv
),
635 struct flow_block_offload
*bo
,
636 struct net_device
*dev
,
637 struct Qdisc
*sch
, void *data
,
639 void (*cleanup
)(struct flow_block_cb
*block_cb
));
640 void flow_block_cb_free(struct flow_block_cb
*block_cb
);
642 struct flow_block_cb
*flow_block_cb_lookup(struct flow_block
*block
,
643 flow_setup_cb_t
*cb
, void *cb_ident
);
645 void *flow_block_cb_priv(struct flow_block_cb
*block_cb
);
646 void flow_block_cb_incref(struct flow_block_cb
*block_cb
);
647 unsigned int flow_block_cb_decref(struct flow_block_cb
*block_cb
);
649 static inline void flow_block_cb_add(struct flow_block_cb
*block_cb
,
650 struct flow_block_offload
*offload
)
652 list_add_tail(&block_cb
->list
, &offload
->cb_list
);
655 static inline void flow_block_cb_remove(struct flow_block_cb
*block_cb
,
656 struct flow_block_offload
*offload
)
658 list_move(&block_cb
->list
, &offload
->cb_list
);
661 static inline void flow_indr_block_cb_remove(struct flow_block_cb
*block_cb
,
662 struct flow_block_offload
*offload
)
664 list_del(&block_cb
->indr
.list
);
665 list_move(&block_cb
->list
, &offload
->cb_list
);
668 bool flow_block_cb_is_busy(flow_setup_cb_t
*cb
, void *cb_ident
,
669 struct list_head
*driver_block_list
);
671 int flow_block_cb_setup_simple(struct flow_block_offload
*f
,
672 struct list_head
*driver_list
,
674 void *cb_ident
, void *cb_priv
, bool ingress_only
);
676 enum flow_cls_command
{
680 FLOW_CLS_TMPLT_CREATE
,
681 FLOW_CLS_TMPLT_DESTROY
,
684 struct flow_cls_common_offload
{
689 struct netlink_ext_ack
*extack
;
692 struct flow_cls_offload
{
693 struct flow_cls_common_offload common
;
694 enum flow_cls_command command
;
696 unsigned long cookie
;
697 struct flow_rule
*rule
;
698 struct flow_stats stats
;
702 enum offload_act_command
{
708 struct flow_offload_action
{
709 struct netlink_ext_ack
*extack
; /* NULL in FLOW_ACT_STATS process*/
710 enum offload_act_command command
;
711 enum flow_action_id id
;
713 unsigned long cookie
;
714 struct flow_stats stats
;
715 struct flow_action action
;
718 struct flow_offload_action
*offload_action_alloc(unsigned int num_actions
);
720 static inline struct flow_rule
*
721 flow_cls_offload_flow_rule(struct flow_cls_offload
*flow_cmd
)
723 return flow_cmd
->rule
;
726 static inline void flow_block_init(struct flow_block
*flow_block
)
728 INIT_LIST_HEAD(&flow_block
->cb_list
);
731 typedef int flow_indr_block_bind_cb_t(struct net_device
*dev
, struct Qdisc
*sch
, void *cb_priv
,
732 enum tc_setup_type type
, void *type_data
,
734 void (*cleanup
)(struct flow_block_cb
*block_cb
));
736 int flow_indr_dev_register(flow_indr_block_bind_cb_t
*cb
, void *cb_priv
);
737 void flow_indr_dev_unregister(flow_indr_block_bind_cb_t
*cb
, void *cb_priv
,
738 void (*release
)(void *cb_priv
));
739 int flow_indr_dev_setup_offload(struct net_device
*dev
, struct Qdisc
*sch
,
740 enum tc_setup_type type
, void *data
,
741 struct flow_block_offload
*bo
,
742 void (*cleanup
)(struct flow_block_cb
*block_cb
));
743 bool flow_indr_dev_exists(void);
745 #endif /* _NET_FLOW_OFFLOAD_H */