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_ports_range {
52 struct flow_dissector_key_ports_range *key, *mask;
55 struct flow_match_icmp {
56 struct flow_dissector_key_icmp *key, *mask;
59 struct flow_match_tcp {
60 struct flow_dissector_key_tcp *key, *mask;
63 struct flow_match_mpls {
64 struct flow_dissector_key_mpls *key, *mask;
67 struct flow_match_enc_keyid {
68 struct flow_dissector_key_keyid *key, *mask;
71 struct flow_match_enc_opts {
72 struct flow_dissector_key_enc_opts *key, *mask;
75 struct flow_match_ct {
76 struct flow_dissector_key_ct *key, *mask;
79 struct flow_match_pppoe {
80 struct flow_dissector_key_pppoe *key, *mask;
85 void flow_rule_match_meta(const struct flow_rule *rule,
86 struct flow_match_meta *out);
87 void flow_rule_match_basic(const struct flow_rule *rule,
88 struct flow_match_basic *out);
89 void flow_rule_match_control(const struct flow_rule *rule,
90 struct flow_match_control *out);
91 void flow_rule_match_eth_addrs(const struct flow_rule *rule,
92 struct flow_match_eth_addrs *out);
93 void flow_rule_match_vlan(const struct flow_rule *rule,
94 struct flow_match_vlan *out);
95 void flow_rule_match_cvlan(const struct flow_rule *rule,
96 struct flow_match_vlan *out);
97 void flow_rule_match_ipv4_addrs(const struct flow_rule *rule,
98 struct flow_match_ipv4_addrs *out);
99 void flow_rule_match_ipv6_addrs(const struct flow_rule *rule,
100 struct flow_match_ipv6_addrs *out);
101 void flow_rule_match_ip(const struct flow_rule *rule,
102 struct flow_match_ip *out);
103 void flow_rule_match_ports(const struct flow_rule *rule,
104 struct flow_match_ports *out);
105 void flow_rule_match_ports_range(const struct flow_rule *rule,
106 struct flow_match_ports_range *out);
107 void flow_rule_match_tcp(const struct flow_rule *rule,
108 struct flow_match_tcp *out);
109 void flow_rule_match_icmp(const struct flow_rule *rule,
110 struct flow_match_icmp *out);
111 void flow_rule_match_mpls(const struct flow_rule *rule,
112 struct flow_match_mpls *out);
113 void flow_rule_match_enc_control(const struct flow_rule *rule,
114 struct flow_match_control *out);
115 void flow_rule_match_enc_ipv4_addrs(const struct flow_rule *rule,
116 struct flow_match_ipv4_addrs *out);
117 void flow_rule_match_enc_ipv6_addrs(const struct flow_rule *rule,
118 struct flow_match_ipv6_addrs *out);
119 void flow_rule_match_enc_ip(const struct flow_rule *rule,
120 struct flow_match_ip *out);
121 void flow_rule_match_enc_ports(const struct flow_rule *rule,
122 struct flow_match_ports *out);
123 void flow_rule_match_enc_keyid(const struct flow_rule *rule,
124 struct flow_match_enc_keyid *out);
125 void flow_rule_match_enc_opts(const struct flow_rule *rule,
126 struct flow_match_enc_opts *out);
127 void flow_rule_match_ct(const struct flow_rule *rule,
128 struct flow_match_ct *out);
129 void flow_rule_match_pppoe(const struct flow_rule *rule,
130 struct flow_match_pppoe *out);
132 enum flow_action_id {
133 FLOW_ACTION_ACCEPT = 0,
137 FLOW_ACTION_REDIRECT,
139 FLOW_ACTION_REDIRECT_INGRESS,
140 FLOW_ACTION_MIRRED_INGRESS,
141 FLOW_ACTION_VLAN_PUSH,
142 FLOW_ACTION_VLAN_POP,
143 FLOW_ACTION_VLAN_MANGLE,
144 FLOW_ACTION_TUNNEL_ENCAP,
145 FLOW_ACTION_TUNNEL_DECAP,
151 FLOW_ACTION_PRIORITY,
157 FLOW_ACTION_CT_METADATA,
158 FLOW_ACTION_MPLS_PUSH,
159 FLOW_ACTION_MPLS_POP,
160 FLOW_ACTION_MPLS_MANGLE,
162 FLOW_ACTION_PPPOE_PUSH,
165 FLOW_ACTION_VLAN_PUSH_ETH,
166 FLOW_ACTION_VLAN_POP_ETH,
167 FLOW_ACTION_CONTINUE,
171 /* This is mirroring enum pedit_header_type definition for easy mapping between
172 * tc pedit action. Legacy TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK is mapped to
173 * FLOW_ACT_MANGLE_UNSPEC, which is supported by no driver.
175 enum flow_action_mangle_base {
176 FLOW_ACT_MANGLE_UNSPEC = 0,
177 FLOW_ACT_MANGLE_HDR_TYPE_ETH,
178 FLOW_ACT_MANGLE_HDR_TYPE_IP4,
179 FLOW_ACT_MANGLE_HDR_TYPE_IP6,
180 FLOW_ACT_MANGLE_HDR_TYPE_TCP,
181 FLOW_ACT_MANGLE_HDR_TYPE_UDP,
184 enum flow_action_hw_stats_bit {
185 FLOW_ACTION_HW_STATS_IMMEDIATE_BIT,
186 FLOW_ACTION_HW_STATS_DELAYED_BIT,
187 FLOW_ACTION_HW_STATS_DISABLED_BIT,
189 FLOW_ACTION_HW_STATS_NUM_BITS
192 enum flow_action_hw_stats {
193 FLOW_ACTION_HW_STATS_IMMEDIATE =
194 BIT(FLOW_ACTION_HW_STATS_IMMEDIATE_BIT),
195 FLOW_ACTION_HW_STATS_DELAYED = BIT(FLOW_ACTION_HW_STATS_DELAYED_BIT),
196 FLOW_ACTION_HW_STATS_ANY = FLOW_ACTION_HW_STATS_IMMEDIATE |
197 FLOW_ACTION_HW_STATS_DELAYED,
198 FLOW_ACTION_HW_STATS_DISABLED =
199 BIT(FLOW_ACTION_HW_STATS_DISABLED_BIT),
200 FLOW_ACTION_HW_STATS_DONT_CARE = BIT(FLOW_ACTION_HW_STATS_NUM_BITS) - 1,
203 typedef void (*action_destr)(void *priv);
205 struct flow_action_cookie {
210 struct flow_action_cookie *flow_action_cookie_create(void *data,
213 void flow_action_cookie_destroy(struct flow_action_cookie *cookie);
215 struct flow_action_entry {
216 enum flow_action_id id;
218 enum flow_action_hw_stats hw_stats;
219 action_destr destructor;
220 void *destructor_priv;
222 u32 chain_index; /* FLOW_ACTION_GOTO */
223 struct net_device *dev; /* FLOW_ACTION_REDIRECT */
224 struct { /* FLOW_ACTION_VLAN */
229 struct { /* FLOW_ACTION_VLAN_PUSH_ETH */
230 unsigned char dst[ETH_ALEN];
231 unsigned char src[ETH_ALEN];
233 struct { /* FLOW_ACTION_MANGLE */
234 /* FLOW_ACTION_ADD */
235 enum flow_action_mangle_base htype;
240 struct ip_tunnel_info *tunnel; /* FLOW_ACTION_TUNNEL_ENCAP */
241 u32 csum_flags; /* FLOW_ACTION_CSUM */
242 u32 mark; /* FLOW_ACTION_MARK */
243 u16 ptype; /* FLOW_ACTION_PTYPE */
244 u32 priority; /* FLOW_ACTION_PRIORITY */
245 struct { /* FLOW_ACTION_QUEUE */
250 struct { /* FLOW_ACTION_SAMPLE */
251 struct psample_group *psample_group;
256 struct { /* FLOW_ACTION_POLICE */
259 u64 peakrate_bytes_ps;
266 enum flow_action_id act_id;
270 struct { /* FLOW_ACTION_CT */
273 struct nf_flowtable *flow_table;
276 unsigned long cookie;
281 struct { /* FLOW_ACTION_MPLS_PUSH */
288 struct { /* FLOW_ACTION_MPLS_POP */
291 struct { /* FLOW_ACTION_MPLS_MANGLE */
303 struct action_gate_entry *entries;
305 struct { /* FLOW_ACTION_PPPOE_PUSH */
309 struct flow_action_cookie *cookie; /* user defined action cookie */
313 unsigned int num_entries;
314 struct flow_action_entry entries[];
317 static inline bool flow_action_has_entries(const struct flow_action *action)
319 return action->num_entries;
323 * flow_offload_has_one_action() - check if exactly one action is present
324 * @action: tc filter flow offload action
326 * Returns true if exactly one action is present.
328 static inline bool flow_offload_has_one_action(const struct flow_action *action)
330 return action->num_entries == 1;
333 static inline bool flow_action_is_last_entry(const struct flow_action *action,
334 const struct flow_action_entry *entry)
336 return entry == &action->entries[action->num_entries - 1];
339 #define flow_action_for_each(__i, __act, __actions) \
340 for (__i = 0, __act = &(__actions)->entries[0]; \
341 __i < (__actions)->num_entries; \
342 __act = &(__actions)->entries[++__i])
345 flow_action_mixed_hw_stats_check(const struct flow_action *action,
346 struct netlink_ext_ack *extack)
348 const struct flow_action_entry *action_entry;
352 if (flow_offload_has_one_action(action))
355 flow_action_for_each(i, action_entry, action) {
356 if (i && action_entry->hw_stats != last_hw_stats) {
357 NL_SET_ERR_MSG_MOD(extack, "Mixing HW stats types for actions is not supported");
360 last_hw_stats = action_entry->hw_stats;
365 static inline const struct flow_action_entry *
366 flow_action_first_entry_get(const struct flow_action *action)
368 WARN_ON(!flow_action_has_entries(action));
369 return &action->entries[0];
373 __flow_action_hw_stats_check(const struct flow_action *action,
374 struct netlink_ext_ack *extack,
375 bool check_allow_bit,
376 enum flow_action_hw_stats_bit allow_bit)
378 const struct flow_action_entry *action_entry;
380 if (!flow_action_has_entries(action))
382 if (!flow_action_mixed_hw_stats_check(action, extack))
385 action_entry = flow_action_first_entry_get(action);
387 /* Zero is not a legal value for hw_stats, catch anyone passing it */
388 WARN_ON_ONCE(!action_entry->hw_stats);
390 if (!check_allow_bit &&
391 ~action_entry->hw_stats & FLOW_ACTION_HW_STATS_ANY) {
392 NL_SET_ERR_MSG_MOD(extack, "Driver supports only default HW stats type \"any\"");
394 } else if (check_allow_bit &&
395 !(action_entry->hw_stats & BIT(allow_bit))) {
396 NL_SET_ERR_MSG_MOD(extack, "Driver does not support selected HW stats type");
403 flow_action_hw_stats_check(const struct flow_action *action,
404 struct netlink_ext_ack *extack,
405 enum flow_action_hw_stats_bit allow_bit)
407 return __flow_action_hw_stats_check(action, extack, true, allow_bit);
411 flow_action_basic_hw_stats_check(const struct flow_action *action,
412 struct netlink_ext_ack *extack)
414 return __flow_action_hw_stats_check(action, extack, false, 0);
418 struct flow_match match;
419 struct flow_action action;
422 struct flow_rule *flow_rule_alloc(unsigned int num_actions);
424 static inline bool flow_rule_match_key(const struct flow_rule *rule,
425 enum flow_dissector_key_id key)
427 return dissector_uses_key(rule->match.dissector, key);
435 enum flow_action_hw_stats used_hw_stats;
436 bool used_hw_stats_valid;
439 static inline void flow_stats_update(struct flow_stats *flow_stats,
441 u64 drops, u64 lastused,
442 enum flow_action_hw_stats used_hw_stats)
444 flow_stats->pkts += pkts;
445 flow_stats->bytes += bytes;
446 flow_stats->drops += drops;
447 flow_stats->lastused = max_t(u64, flow_stats->lastused, lastused);
449 /* The driver should pass value with a maximum of one bit set.
450 * Passing FLOW_ACTION_HW_STATS_ANY is invalid.
452 WARN_ON(used_hw_stats == FLOW_ACTION_HW_STATS_ANY);
453 flow_stats->used_hw_stats |= used_hw_stats;
454 flow_stats->used_hw_stats_valid = true;
457 enum flow_block_command {
462 enum flow_block_binder_type {
463 FLOW_BLOCK_BINDER_TYPE_UNSPEC,
464 FLOW_BLOCK_BINDER_TYPE_CLSACT_INGRESS,
465 FLOW_BLOCK_BINDER_TYPE_CLSACT_EGRESS,
466 FLOW_BLOCK_BINDER_TYPE_RED_EARLY_DROP,
467 FLOW_BLOCK_BINDER_TYPE_RED_MARK,
471 struct list_head cb_list;
474 struct netlink_ext_ack;
476 struct flow_block_offload {
477 enum flow_block_command command;
478 enum flow_block_binder_type binder_type;
480 bool unlocked_driver_cb;
482 struct flow_block *block;
483 struct list_head cb_list;
484 struct list_head *driver_block_list;
485 struct netlink_ext_ack *extack;
487 struct list_head *cb_list_head;
491 typedef int flow_setup_cb_t(enum tc_setup_type type, void *type_data,
494 struct flow_block_cb;
496 struct flow_block_indr {
497 struct list_head list;
498 struct net_device *dev;
500 enum flow_block_binder_type binder_type;
503 void (*cleanup)(struct flow_block_cb *block_cb);
506 struct flow_block_cb {
507 struct list_head driver_list;
508 struct list_head list;
512 void (*release)(void *cb_priv);
513 struct flow_block_indr indr;
517 struct flow_block_cb *flow_block_cb_alloc(flow_setup_cb_t *cb,
518 void *cb_ident, void *cb_priv,
519 void (*release)(void *cb_priv));
520 struct flow_block_cb *flow_indr_block_cb_alloc(flow_setup_cb_t *cb,
521 void *cb_ident, void *cb_priv,
522 void (*release)(void *cb_priv),
523 struct flow_block_offload *bo,
524 struct net_device *dev,
525 struct Qdisc *sch, void *data,
527 void (*cleanup)(struct flow_block_cb *block_cb));
528 void flow_block_cb_free(struct flow_block_cb *block_cb);
530 struct flow_block_cb *flow_block_cb_lookup(struct flow_block *block,
531 flow_setup_cb_t *cb, void *cb_ident);
533 void *flow_block_cb_priv(struct flow_block_cb *block_cb);
534 void flow_block_cb_incref(struct flow_block_cb *block_cb);
535 unsigned int flow_block_cb_decref(struct flow_block_cb *block_cb);
537 static inline void flow_block_cb_add(struct flow_block_cb *block_cb,
538 struct flow_block_offload *offload)
540 list_add_tail(&block_cb->list, &offload->cb_list);
543 static inline void flow_block_cb_remove(struct flow_block_cb *block_cb,
544 struct flow_block_offload *offload)
546 list_move(&block_cb->list, &offload->cb_list);
549 static inline void flow_indr_block_cb_remove(struct flow_block_cb *block_cb,
550 struct flow_block_offload *offload)
552 list_del(&block_cb->indr.list);
553 list_move(&block_cb->list, &offload->cb_list);
556 bool flow_block_cb_is_busy(flow_setup_cb_t *cb, void *cb_ident,
557 struct list_head *driver_block_list);
559 int flow_block_cb_setup_simple(struct flow_block_offload *f,
560 struct list_head *driver_list,
562 void *cb_ident, void *cb_priv, bool ingress_only);
564 enum flow_cls_command {
568 FLOW_CLS_TMPLT_CREATE,
569 FLOW_CLS_TMPLT_DESTROY,
572 struct flow_cls_common_offload {
576 struct netlink_ext_ack *extack;
579 struct flow_cls_offload {
580 struct flow_cls_common_offload common;
581 enum flow_cls_command command;
582 unsigned long cookie;
583 struct flow_rule *rule;
584 struct flow_stats stats;
588 enum offload_act_command {
594 struct flow_offload_action {
595 struct netlink_ext_ack *extack; /* NULL in FLOW_ACT_STATS process*/
596 enum offload_act_command command;
597 enum flow_action_id id;
599 struct flow_stats stats;
600 struct flow_action action;
603 struct flow_offload_action *offload_action_alloc(unsigned int num_actions);
605 static inline struct flow_rule *
606 flow_cls_offload_flow_rule(struct flow_cls_offload *flow_cmd)
608 return flow_cmd->rule;
611 static inline void flow_block_init(struct flow_block *flow_block)
613 INIT_LIST_HEAD(&flow_block->cb_list);
616 typedef int flow_indr_block_bind_cb_t(struct net_device *dev, struct Qdisc *sch, void *cb_priv,
617 enum tc_setup_type type, void *type_data,
619 void (*cleanup)(struct flow_block_cb *block_cb));
621 int flow_indr_dev_register(flow_indr_block_bind_cb_t *cb, void *cb_priv);
622 void flow_indr_dev_unregister(flow_indr_block_bind_cb_t *cb, void *cb_priv,
623 void (*release)(void *cb_priv));
624 int flow_indr_dev_setup_offload(struct net_device *dev, struct Qdisc *sch,
625 enum tc_setup_type type, void *data,
626 struct flow_block_offload *bo,
627 void (*cleanup)(struct flow_block_cb *block_cb));
628 bool flow_indr_dev_exists(void);
630 #endif /* _NET_FLOW_OFFLOAD_H */