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_ipv4_addrs {
36 struct flow_dissector_key_ipv4_addrs *key, *mask;
39 struct flow_match_ipv6_addrs {
40 struct flow_dissector_key_ipv6_addrs *key, *mask;
43 struct flow_match_ip {
44 struct flow_dissector_key_ip *key, *mask;
47 struct flow_match_ports {
48 struct flow_dissector_key_ports *key, *mask;
51 struct flow_match_icmp {
52 struct flow_dissector_key_icmp *key, *mask;
55 struct flow_match_tcp {
56 struct flow_dissector_key_tcp *key, *mask;
59 struct flow_match_mpls {
60 struct flow_dissector_key_mpls *key, *mask;
63 struct flow_match_enc_keyid {
64 struct flow_dissector_key_keyid *key, *mask;
67 struct flow_match_enc_opts {
68 struct flow_dissector_key_enc_opts *key, *mask;
71 struct flow_match_ct {
72 struct flow_dissector_key_ct *key, *mask;
77 void flow_rule_match_meta(const struct flow_rule *rule,
78 struct flow_match_meta *out);
79 void flow_rule_match_basic(const struct flow_rule *rule,
80 struct flow_match_basic *out);
81 void flow_rule_match_control(const struct flow_rule *rule,
82 struct flow_match_control *out);
83 void flow_rule_match_eth_addrs(const struct flow_rule *rule,
84 struct flow_match_eth_addrs *out);
85 void flow_rule_match_vlan(const struct flow_rule *rule,
86 struct flow_match_vlan *out);
87 void flow_rule_match_cvlan(const struct flow_rule *rule,
88 struct flow_match_vlan *out);
89 void flow_rule_match_ipv4_addrs(const struct flow_rule *rule,
90 struct flow_match_ipv4_addrs *out);
91 void flow_rule_match_ipv6_addrs(const struct flow_rule *rule,
92 struct flow_match_ipv6_addrs *out);
93 void flow_rule_match_ip(const struct flow_rule *rule,
94 struct flow_match_ip *out);
95 void flow_rule_match_ports(const struct flow_rule *rule,
96 struct flow_match_ports *out);
97 void flow_rule_match_tcp(const struct flow_rule *rule,
98 struct flow_match_tcp *out);
99 void flow_rule_match_icmp(const struct flow_rule *rule,
100 struct flow_match_icmp *out);
101 void flow_rule_match_mpls(const struct flow_rule *rule,
102 struct flow_match_mpls *out);
103 void flow_rule_match_enc_control(const struct flow_rule *rule,
104 struct flow_match_control *out);
105 void flow_rule_match_enc_ipv4_addrs(const struct flow_rule *rule,
106 struct flow_match_ipv4_addrs *out);
107 void flow_rule_match_enc_ipv6_addrs(const struct flow_rule *rule,
108 struct flow_match_ipv6_addrs *out);
109 void flow_rule_match_enc_ip(const struct flow_rule *rule,
110 struct flow_match_ip *out);
111 void flow_rule_match_enc_ports(const struct flow_rule *rule,
112 struct flow_match_ports *out);
113 void flow_rule_match_enc_keyid(const struct flow_rule *rule,
114 struct flow_match_enc_keyid *out);
115 void flow_rule_match_enc_opts(const struct flow_rule *rule,
116 struct flow_match_enc_opts *out);
117 void flow_rule_match_ct(const struct flow_rule *rule,
118 struct flow_match_ct *out);
120 enum flow_action_id {
121 FLOW_ACTION_ACCEPT = 0,
125 FLOW_ACTION_REDIRECT,
127 FLOW_ACTION_REDIRECT_INGRESS,
128 FLOW_ACTION_MIRRED_INGRESS,
129 FLOW_ACTION_VLAN_PUSH,
130 FLOW_ACTION_VLAN_POP,
131 FLOW_ACTION_VLAN_MANGLE,
132 FLOW_ACTION_TUNNEL_ENCAP,
133 FLOW_ACTION_TUNNEL_DECAP,
139 FLOW_ACTION_PRIORITY,
145 FLOW_ACTION_CT_METADATA,
146 FLOW_ACTION_MPLS_PUSH,
147 FLOW_ACTION_MPLS_POP,
148 FLOW_ACTION_MPLS_MANGLE,
150 FLOW_ACTION_PPPOE_PUSH,
153 FLOW_ACTION_VLAN_PUSH_ETH,
154 FLOW_ACTION_VLAN_POP_ETH,
158 /* This is mirroring enum pedit_header_type definition for easy mapping between
159 * tc pedit action. Legacy TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK is mapped to
160 * FLOW_ACT_MANGLE_UNSPEC, which is supported by no driver.
162 enum flow_action_mangle_base {
163 FLOW_ACT_MANGLE_UNSPEC = 0,
164 FLOW_ACT_MANGLE_HDR_TYPE_ETH,
165 FLOW_ACT_MANGLE_HDR_TYPE_IP4,
166 FLOW_ACT_MANGLE_HDR_TYPE_IP6,
167 FLOW_ACT_MANGLE_HDR_TYPE_TCP,
168 FLOW_ACT_MANGLE_HDR_TYPE_UDP,
171 enum flow_action_hw_stats_bit {
172 FLOW_ACTION_HW_STATS_IMMEDIATE_BIT,
173 FLOW_ACTION_HW_STATS_DELAYED_BIT,
174 FLOW_ACTION_HW_STATS_DISABLED_BIT,
176 FLOW_ACTION_HW_STATS_NUM_BITS
179 enum flow_action_hw_stats {
180 FLOW_ACTION_HW_STATS_IMMEDIATE =
181 BIT(FLOW_ACTION_HW_STATS_IMMEDIATE_BIT),
182 FLOW_ACTION_HW_STATS_DELAYED = BIT(FLOW_ACTION_HW_STATS_DELAYED_BIT),
183 FLOW_ACTION_HW_STATS_ANY = FLOW_ACTION_HW_STATS_IMMEDIATE |
184 FLOW_ACTION_HW_STATS_DELAYED,
185 FLOW_ACTION_HW_STATS_DISABLED =
186 BIT(FLOW_ACTION_HW_STATS_DISABLED_BIT),
187 FLOW_ACTION_HW_STATS_DONT_CARE = BIT(FLOW_ACTION_HW_STATS_NUM_BITS) - 1,
190 typedef void (*action_destr)(void *priv);
192 struct flow_action_cookie {
197 struct flow_action_cookie *flow_action_cookie_create(void *data,
200 void flow_action_cookie_destroy(struct flow_action_cookie *cookie);
202 struct flow_action_entry {
203 enum flow_action_id id;
205 enum flow_action_hw_stats hw_stats;
206 action_destr destructor;
207 void *destructor_priv;
209 u32 chain_index; /* FLOW_ACTION_GOTO */
210 struct net_device *dev; /* FLOW_ACTION_REDIRECT */
211 struct { /* FLOW_ACTION_VLAN */
216 struct { /* FLOW_ACTION_VLAN_PUSH_ETH */
217 unsigned char dst[ETH_ALEN];
218 unsigned char src[ETH_ALEN];
220 struct { /* FLOW_ACTION_MANGLE */
221 /* FLOW_ACTION_ADD */
222 enum flow_action_mangle_base htype;
227 struct ip_tunnel_info *tunnel; /* FLOW_ACTION_TUNNEL_ENCAP */
228 u32 csum_flags; /* FLOW_ACTION_CSUM */
229 u32 mark; /* FLOW_ACTION_MARK */
230 u16 ptype; /* FLOW_ACTION_PTYPE */
231 u32 priority; /* FLOW_ACTION_PRIORITY */
232 struct { /* FLOW_ACTION_QUEUE */
237 struct { /* FLOW_ACTION_SAMPLE */
238 struct psample_group *psample_group;
243 struct { /* FLOW_ACTION_POLICE */
246 u64 peakrate_bytes_ps;
253 enum flow_action_id act_id;
257 struct { /* FLOW_ACTION_CT */
260 struct nf_flowtable *flow_table;
263 unsigned long cookie;
268 struct { /* FLOW_ACTION_MPLS_PUSH */
275 struct { /* FLOW_ACTION_MPLS_POP */
278 struct { /* FLOW_ACTION_MPLS_MANGLE */
290 struct action_gate_entry *entries;
292 struct { /* FLOW_ACTION_PPPOE_PUSH */
296 struct flow_action_cookie *cookie; /* user defined action cookie */
300 unsigned int num_entries;
301 struct flow_action_entry entries[];
304 static inline bool flow_action_has_entries(const struct flow_action *action)
306 return action->num_entries;
310 * flow_offload_has_one_action() - check if exactly one action is present
311 * @action: tc filter flow offload action
313 * Returns true if exactly one action is present.
315 static inline bool flow_offload_has_one_action(const struct flow_action *action)
317 return action->num_entries == 1;
320 static inline bool flow_action_is_last_entry(const struct flow_action *action,
321 const struct flow_action_entry *entry)
323 return entry == &action->entries[action->num_entries - 1];
326 #define flow_action_for_each(__i, __act, __actions) \
327 for (__i = 0, __act = &(__actions)->entries[0]; \
328 __i < (__actions)->num_entries; \
329 __act = &(__actions)->entries[++__i])
332 flow_action_mixed_hw_stats_check(const struct flow_action *action,
333 struct netlink_ext_ack *extack)
335 const struct flow_action_entry *action_entry;
339 if (flow_offload_has_one_action(action))
342 flow_action_for_each(i, action_entry, action) {
343 if (i && action_entry->hw_stats != last_hw_stats) {
344 NL_SET_ERR_MSG_MOD(extack, "Mixing HW stats types for actions is not supported");
347 last_hw_stats = action_entry->hw_stats;
352 static inline const struct flow_action_entry *
353 flow_action_first_entry_get(const struct flow_action *action)
355 WARN_ON(!flow_action_has_entries(action));
356 return &action->entries[0];
360 __flow_action_hw_stats_check(const struct flow_action *action,
361 struct netlink_ext_ack *extack,
362 bool check_allow_bit,
363 enum flow_action_hw_stats_bit allow_bit)
365 const struct flow_action_entry *action_entry;
367 if (!flow_action_has_entries(action))
369 if (!flow_action_mixed_hw_stats_check(action, extack))
372 action_entry = flow_action_first_entry_get(action);
374 /* Zero is not a legal value for hw_stats, catch anyone passing it */
375 WARN_ON_ONCE(!action_entry->hw_stats);
377 if (!check_allow_bit &&
378 ~action_entry->hw_stats & FLOW_ACTION_HW_STATS_ANY) {
379 NL_SET_ERR_MSG_MOD(extack, "Driver supports only default HW stats type \"any\"");
381 } else if (check_allow_bit &&
382 !(action_entry->hw_stats & BIT(allow_bit))) {
383 NL_SET_ERR_MSG_MOD(extack, "Driver does not support selected HW stats type");
390 flow_action_hw_stats_check(const struct flow_action *action,
391 struct netlink_ext_ack *extack,
392 enum flow_action_hw_stats_bit allow_bit)
394 return __flow_action_hw_stats_check(action, extack, true, allow_bit);
398 flow_action_basic_hw_stats_check(const struct flow_action *action,
399 struct netlink_ext_ack *extack)
401 return __flow_action_hw_stats_check(action, extack, false, 0);
405 struct flow_match match;
406 struct flow_action action;
409 struct flow_rule *flow_rule_alloc(unsigned int num_actions);
411 static inline bool flow_rule_match_key(const struct flow_rule *rule,
412 enum flow_dissector_key_id key)
414 return dissector_uses_key(rule->match.dissector, key);
422 enum flow_action_hw_stats used_hw_stats;
423 bool used_hw_stats_valid;
426 static inline void flow_stats_update(struct flow_stats *flow_stats,
428 u64 drops, u64 lastused,
429 enum flow_action_hw_stats used_hw_stats)
431 flow_stats->pkts += pkts;
432 flow_stats->bytes += bytes;
433 flow_stats->drops += drops;
434 flow_stats->lastused = max_t(u64, flow_stats->lastused, lastused);
436 /* The driver should pass value with a maximum of one bit set.
437 * Passing FLOW_ACTION_HW_STATS_ANY is invalid.
439 WARN_ON(used_hw_stats == FLOW_ACTION_HW_STATS_ANY);
440 flow_stats->used_hw_stats |= used_hw_stats;
441 flow_stats->used_hw_stats_valid = true;
444 enum flow_block_command {
449 enum flow_block_binder_type {
450 FLOW_BLOCK_BINDER_TYPE_UNSPEC,
451 FLOW_BLOCK_BINDER_TYPE_CLSACT_INGRESS,
452 FLOW_BLOCK_BINDER_TYPE_CLSACT_EGRESS,
453 FLOW_BLOCK_BINDER_TYPE_RED_EARLY_DROP,
454 FLOW_BLOCK_BINDER_TYPE_RED_MARK,
458 struct list_head cb_list;
461 struct netlink_ext_ack;
463 struct flow_block_offload {
464 enum flow_block_command command;
465 enum flow_block_binder_type binder_type;
467 bool unlocked_driver_cb;
469 struct flow_block *block;
470 struct list_head cb_list;
471 struct list_head *driver_block_list;
472 struct netlink_ext_ack *extack;
474 struct list_head *cb_list_head;
478 typedef int flow_setup_cb_t(enum tc_setup_type type, void *type_data,
481 struct flow_block_cb;
483 struct flow_block_indr {
484 struct list_head list;
485 struct net_device *dev;
487 enum flow_block_binder_type binder_type;
490 void (*cleanup)(struct flow_block_cb *block_cb);
493 struct flow_block_cb {
494 struct list_head driver_list;
495 struct list_head list;
499 void (*release)(void *cb_priv);
500 struct flow_block_indr indr;
504 struct flow_block_cb *flow_block_cb_alloc(flow_setup_cb_t *cb,
505 void *cb_ident, void *cb_priv,
506 void (*release)(void *cb_priv));
507 struct flow_block_cb *flow_indr_block_cb_alloc(flow_setup_cb_t *cb,
508 void *cb_ident, void *cb_priv,
509 void (*release)(void *cb_priv),
510 struct flow_block_offload *bo,
511 struct net_device *dev,
512 struct Qdisc *sch, void *data,
514 void (*cleanup)(struct flow_block_cb *block_cb));
515 void flow_block_cb_free(struct flow_block_cb *block_cb);
517 struct flow_block_cb *flow_block_cb_lookup(struct flow_block *block,
518 flow_setup_cb_t *cb, void *cb_ident);
520 void *flow_block_cb_priv(struct flow_block_cb *block_cb);
521 void flow_block_cb_incref(struct flow_block_cb *block_cb);
522 unsigned int flow_block_cb_decref(struct flow_block_cb *block_cb);
524 static inline void flow_block_cb_add(struct flow_block_cb *block_cb,
525 struct flow_block_offload *offload)
527 list_add_tail(&block_cb->list, &offload->cb_list);
530 static inline void flow_block_cb_remove(struct flow_block_cb *block_cb,
531 struct flow_block_offload *offload)
533 list_move(&block_cb->list, &offload->cb_list);
536 static inline void flow_indr_block_cb_remove(struct flow_block_cb *block_cb,
537 struct flow_block_offload *offload)
539 list_del(&block_cb->indr.list);
540 list_move(&block_cb->list, &offload->cb_list);
543 bool flow_block_cb_is_busy(flow_setup_cb_t *cb, void *cb_ident,
544 struct list_head *driver_block_list);
546 int flow_block_cb_setup_simple(struct flow_block_offload *f,
547 struct list_head *driver_list,
549 void *cb_ident, void *cb_priv, bool ingress_only);
551 enum flow_cls_command {
555 FLOW_CLS_TMPLT_CREATE,
556 FLOW_CLS_TMPLT_DESTROY,
559 struct flow_cls_common_offload {
563 struct netlink_ext_ack *extack;
566 struct flow_cls_offload {
567 struct flow_cls_common_offload common;
568 enum flow_cls_command command;
569 unsigned long cookie;
570 struct flow_rule *rule;
571 struct flow_stats stats;
575 enum offload_act_command {
581 struct flow_offload_action {
582 struct netlink_ext_ack *extack; /* NULL in FLOW_ACT_STATS process*/
583 enum offload_act_command command;
584 enum flow_action_id id;
586 struct flow_stats stats;
587 struct flow_action action;
590 struct flow_offload_action *offload_action_alloc(unsigned int num_actions);
592 static inline struct flow_rule *
593 flow_cls_offload_flow_rule(struct flow_cls_offload *flow_cmd)
595 return flow_cmd->rule;
598 static inline void flow_block_init(struct flow_block *flow_block)
600 INIT_LIST_HEAD(&flow_block->cb_list);
603 typedef int flow_indr_block_bind_cb_t(struct net_device *dev, struct Qdisc *sch, void *cb_priv,
604 enum tc_setup_type type, void *type_data,
606 void (*cleanup)(struct flow_block_cb *block_cb));
608 int flow_indr_dev_register(flow_indr_block_bind_cb_t *cb, void *cb_priv);
609 void flow_indr_dev_unregister(flow_indr_block_bind_cb_t *cb, void *cb_priv,
610 void (*release)(void *cb_priv));
611 int flow_indr_dev_setup_offload(struct net_device *dev, struct Qdisc *sch,
612 enum tc_setup_type type, void *data,
613 struct flow_block_offload *bo,
614 void (*cleanup)(struct flow_block_cb *block_cb));
615 bool flow_indr_dev_exists(void);
617 #endif /* _NET_FLOW_OFFLOAD_H */