1 #ifndef _NET_FLOW_OFFLOAD_H 2 #define _NET_FLOW_OFFLOAD_H 3 4 #include <linux/kernel.h> 5 #include <linux/list.h> 6 #include <linux/netlink.h> 7 #include <net/flow_dissector.h> 8 9 struct flow_match { 10 struct flow_dissector *dissector; 11 void *mask; 12 void *key; 13 }; 14 15 struct flow_match_meta { 16 struct flow_dissector_key_meta *key, *mask; 17 }; 18 19 struct flow_match_basic { 20 struct flow_dissector_key_basic *key, *mask; 21 }; 22 23 struct flow_match_control { 24 struct flow_dissector_key_control *key, *mask; 25 }; 26 27 struct flow_match_eth_addrs { 28 struct flow_dissector_key_eth_addrs *key, *mask; 29 }; 30 31 struct flow_match_vlan { 32 struct flow_dissector_key_vlan *key, *mask; 33 }; 34 35 struct flow_match_arp { 36 struct flow_dissector_key_arp *key, *mask; 37 }; 38 39 struct flow_match_ipv4_addrs { 40 struct flow_dissector_key_ipv4_addrs *key, *mask; 41 }; 42 43 struct flow_match_ipv6_addrs { 44 struct flow_dissector_key_ipv6_addrs *key, *mask; 45 }; 46 47 struct flow_match_ip { 48 struct flow_dissector_key_ip *key, *mask; 49 }; 50 51 struct flow_match_ports { 52 struct flow_dissector_key_ports *key, *mask; 53 }; 54 55 struct flow_match_ports_range { 56 struct flow_dissector_key_ports_range *key, *mask; 57 }; 58 59 struct flow_match_icmp { 60 struct flow_dissector_key_icmp *key, *mask; 61 }; 62 63 struct flow_match_tcp { 64 struct flow_dissector_key_tcp *key, *mask; 65 }; 66 67 struct flow_match_mpls { 68 struct flow_dissector_key_mpls *key, *mask; 69 }; 70 71 struct flow_match_enc_keyid { 72 struct flow_dissector_key_keyid *key, *mask; 73 }; 74 75 struct flow_match_enc_opts { 76 struct flow_dissector_key_enc_opts *key, *mask; 77 }; 78 79 struct flow_match_ct { 80 struct flow_dissector_key_ct *key, *mask; 81 }; 82 83 struct flow_match_pppoe { 84 struct flow_dissector_key_pppoe *key, *mask; 85 }; 86 87 struct flow_match_l2tpv3 { 88 struct flow_dissector_key_l2tpv3 *key, *mask; 89 }; 90 91 struct flow_rule; 92 93 void flow_rule_match_meta(const struct flow_rule *rule, 94 struct flow_match_meta *out); 95 void flow_rule_match_basic(const struct flow_rule *rule, 96 struct flow_match_basic *out); 97 void flow_rule_match_control(const struct flow_rule *rule, 98 struct flow_match_control *out); 99 void flow_rule_match_eth_addrs(const struct flow_rule *rule, 100 struct flow_match_eth_addrs *out); 101 void flow_rule_match_vlan(const struct flow_rule *rule, 102 struct flow_match_vlan *out); 103 void flow_rule_match_cvlan(const struct flow_rule *rule, 104 struct flow_match_vlan *out); 105 void flow_rule_match_arp(const struct flow_rule *rule, 106 struct flow_match_arp *out); 107 void flow_rule_match_ipv4_addrs(const struct flow_rule *rule, 108 struct flow_match_ipv4_addrs *out); 109 void flow_rule_match_ipv6_addrs(const struct flow_rule *rule, 110 struct flow_match_ipv6_addrs *out); 111 void flow_rule_match_ip(const struct flow_rule *rule, 112 struct flow_match_ip *out); 113 void flow_rule_match_ports(const struct flow_rule *rule, 114 struct flow_match_ports *out); 115 void flow_rule_match_ports_range(const struct flow_rule *rule, 116 struct flow_match_ports_range *out); 117 void flow_rule_match_tcp(const struct flow_rule *rule, 118 struct flow_match_tcp *out); 119 void flow_rule_match_icmp(const struct flow_rule *rule, 120 struct flow_match_icmp *out); 121 void flow_rule_match_mpls(const struct flow_rule *rule, 122 struct flow_match_mpls *out); 123 void flow_rule_match_enc_control(const struct flow_rule *rule, 124 struct flow_match_control *out); 125 void flow_rule_match_enc_ipv4_addrs(const struct flow_rule *rule, 126 struct flow_match_ipv4_addrs *out); 127 void flow_rule_match_enc_ipv6_addrs(const struct flow_rule *rule, 128 struct flow_match_ipv6_addrs *out); 129 void flow_rule_match_enc_ip(const struct flow_rule *rule, 130 struct flow_match_ip *out); 131 void flow_rule_match_enc_ports(const struct flow_rule *rule, 132 struct flow_match_ports *out); 133 void flow_rule_match_enc_keyid(const struct flow_rule *rule, 134 struct flow_match_enc_keyid *out); 135 void flow_rule_match_enc_opts(const struct flow_rule *rule, 136 struct flow_match_enc_opts *out); 137 void flow_rule_match_ct(const struct flow_rule *rule, 138 struct flow_match_ct *out); 139 void flow_rule_match_pppoe(const struct flow_rule *rule, 140 struct flow_match_pppoe *out); 141 void flow_rule_match_l2tpv3(const struct flow_rule *rule, 142 struct flow_match_l2tpv3 *out); 143 144 enum flow_action_id { 145 FLOW_ACTION_ACCEPT = 0, 146 FLOW_ACTION_DROP, 147 FLOW_ACTION_TRAP, 148 FLOW_ACTION_GOTO, 149 FLOW_ACTION_REDIRECT, 150 FLOW_ACTION_MIRRED, 151 FLOW_ACTION_REDIRECT_INGRESS, 152 FLOW_ACTION_MIRRED_INGRESS, 153 FLOW_ACTION_VLAN_PUSH, 154 FLOW_ACTION_VLAN_POP, 155 FLOW_ACTION_VLAN_MANGLE, 156 FLOW_ACTION_TUNNEL_ENCAP, 157 FLOW_ACTION_TUNNEL_DECAP, 158 FLOW_ACTION_MANGLE, 159 FLOW_ACTION_ADD, 160 FLOW_ACTION_CSUM, 161 FLOW_ACTION_MARK, 162 FLOW_ACTION_PTYPE, 163 FLOW_ACTION_PRIORITY, 164 FLOW_ACTION_RX_QUEUE_MAPPING, 165 FLOW_ACTION_WAKE, 166 FLOW_ACTION_QUEUE, 167 FLOW_ACTION_SAMPLE, 168 FLOW_ACTION_POLICE, 169 FLOW_ACTION_CT, 170 FLOW_ACTION_CT_METADATA, 171 FLOW_ACTION_MPLS_PUSH, 172 FLOW_ACTION_MPLS_POP, 173 FLOW_ACTION_MPLS_MANGLE, 174 FLOW_ACTION_GATE, 175 FLOW_ACTION_PPPOE_PUSH, 176 FLOW_ACTION_JUMP, 177 FLOW_ACTION_PIPE, 178 FLOW_ACTION_VLAN_PUSH_ETH, 179 FLOW_ACTION_VLAN_POP_ETH, 180 FLOW_ACTION_CONTINUE, 181 NUM_FLOW_ACTIONS, 182 }; 183 184 /* This is mirroring enum pedit_header_type definition for easy mapping between 185 * tc pedit action. Legacy TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK is mapped to 186 * FLOW_ACT_MANGLE_UNSPEC, which is supported by no driver. 187 */ 188 enum flow_action_mangle_base { 189 FLOW_ACT_MANGLE_UNSPEC = 0, 190 FLOW_ACT_MANGLE_HDR_TYPE_ETH, 191 FLOW_ACT_MANGLE_HDR_TYPE_IP4, 192 FLOW_ACT_MANGLE_HDR_TYPE_IP6, 193 FLOW_ACT_MANGLE_HDR_TYPE_TCP, 194 FLOW_ACT_MANGLE_HDR_TYPE_UDP, 195 }; 196 197 enum flow_action_hw_stats_bit { 198 FLOW_ACTION_HW_STATS_IMMEDIATE_BIT, 199 FLOW_ACTION_HW_STATS_DELAYED_BIT, 200 FLOW_ACTION_HW_STATS_DISABLED_BIT, 201 202 FLOW_ACTION_HW_STATS_NUM_BITS 203 }; 204 205 enum flow_action_hw_stats { 206 FLOW_ACTION_HW_STATS_IMMEDIATE = 207 BIT(FLOW_ACTION_HW_STATS_IMMEDIATE_BIT), 208 FLOW_ACTION_HW_STATS_DELAYED = BIT(FLOW_ACTION_HW_STATS_DELAYED_BIT), 209 FLOW_ACTION_HW_STATS_ANY = FLOW_ACTION_HW_STATS_IMMEDIATE | 210 FLOW_ACTION_HW_STATS_DELAYED, 211 FLOW_ACTION_HW_STATS_DISABLED = 212 BIT(FLOW_ACTION_HW_STATS_DISABLED_BIT), 213 FLOW_ACTION_HW_STATS_DONT_CARE = BIT(FLOW_ACTION_HW_STATS_NUM_BITS) - 1, 214 }; 215 216 typedef void (*action_destr)(void *priv); 217 218 struct flow_action_cookie { 219 u32 cookie_len; 220 u8 cookie[]; 221 }; 222 223 struct flow_action_cookie *flow_action_cookie_create(void *data, 224 unsigned int len, 225 gfp_t gfp); 226 void flow_action_cookie_destroy(struct flow_action_cookie *cookie); 227 228 struct flow_action_entry { 229 enum flow_action_id id; 230 u32 hw_index; 231 enum flow_action_hw_stats hw_stats; 232 action_destr destructor; 233 void *destructor_priv; 234 union { 235 u32 chain_index; /* FLOW_ACTION_GOTO */ 236 struct net_device *dev; /* FLOW_ACTION_REDIRECT */ 237 struct { /* FLOW_ACTION_VLAN */ 238 u16 vid; 239 __be16 proto; 240 u8 prio; 241 } vlan; 242 struct { /* FLOW_ACTION_VLAN_PUSH_ETH */ 243 unsigned char dst[ETH_ALEN]; 244 unsigned char src[ETH_ALEN]; 245 } vlan_push_eth; 246 struct { /* FLOW_ACTION_MANGLE */ 247 /* FLOW_ACTION_ADD */ 248 enum flow_action_mangle_base htype; 249 u32 offset; 250 u32 mask; 251 u32 val; 252 } mangle; 253 struct ip_tunnel_info *tunnel; /* FLOW_ACTION_TUNNEL_ENCAP */ 254 u32 csum_flags; /* FLOW_ACTION_CSUM */ 255 u32 mark; /* FLOW_ACTION_MARK */ 256 u16 ptype; /* FLOW_ACTION_PTYPE */ 257 u16 rx_queue; /* FLOW_ACTION_RX_QUEUE_MAPPING */ 258 u32 priority; /* FLOW_ACTION_PRIORITY */ 259 struct { /* FLOW_ACTION_QUEUE */ 260 u32 ctx; 261 u32 index; 262 u8 vf; 263 } queue; 264 struct { /* FLOW_ACTION_SAMPLE */ 265 struct psample_group *psample_group; 266 u32 rate; 267 u32 trunc_size; 268 bool truncate; 269 } sample; 270 struct { /* FLOW_ACTION_POLICE */ 271 u32 burst; 272 u64 rate_bytes_ps; 273 u64 peakrate_bytes_ps; 274 u32 avrate; 275 u16 overhead; 276 u64 burst_pkt; 277 u64 rate_pkt_ps; 278 u32 mtu; 279 struct { 280 enum flow_action_id act_id; 281 u32 extval; 282 } exceed, notexceed; 283 } police; 284 struct { /* FLOW_ACTION_CT */ 285 int action; 286 u16 zone; 287 struct nf_flowtable *flow_table; 288 } ct; 289 struct { 290 unsigned long cookie; 291 u32 mark; 292 u32 labels[4]; 293 bool orig_dir; 294 } ct_metadata; 295 struct { /* FLOW_ACTION_MPLS_PUSH */ 296 u32 label; 297 __be16 proto; 298 u8 tc; 299 u8 bos; 300 u8 ttl; 301 } mpls_push; 302 struct { /* FLOW_ACTION_MPLS_POP */ 303 __be16 proto; 304 } mpls_pop; 305 struct { /* FLOW_ACTION_MPLS_MANGLE */ 306 u32 label; 307 u8 tc; 308 u8 bos; 309 u8 ttl; 310 } mpls_mangle; 311 struct { 312 s32 prio; 313 u64 basetime; 314 u64 cycletime; 315 u64 cycletimeext; 316 u32 num_entries; 317 struct action_gate_entry *entries; 318 } gate; 319 struct { /* FLOW_ACTION_PPPOE_PUSH */ 320 u16 sid; 321 } pppoe; 322 }; 323 struct flow_action_cookie *cookie; /* user defined action cookie */ 324 }; 325 326 struct flow_action { 327 unsigned int num_entries; 328 struct flow_action_entry entries[]; 329 }; 330 331 static inline bool flow_action_has_entries(const struct flow_action *action) 332 { 333 return action->num_entries; 334 } 335 336 /** 337 * flow_offload_has_one_action() - check if exactly one action is present 338 * @action: tc filter flow offload action 339 * 340 * Returns true if exactly one action is present. 341 */ 342 static inline bool flow_offload_has_one_action(const struct flow_action *action) 343 { 344 return action->num_entries == 1; 345 } 346 347 static inline bool flow_action_is_last_entry(const struct flow_action *action, 348 const struct flow_action_entry *entry) 349 { 350 return entry == &action->entries[action->num_entries - 1]; 351 } 352 353 #define flow_action_for_each(__i, __act, __actions) \ 354 for (__i = 0, __act = &(__actions)->entries[0]; \ 355 __i < (__actions)->num_entries; \ 356 __act = &(__actions)->entries[++__i]) 357 358 static inline bool 359 flow_action_mixed_hw_stats_check(const struct flow_action *action, 360 struct netlink_ext_ack *extack) 361 { 362 const struct flow_action_entry *action_entry; 363 u8 last_hw_stats; 364 int i; 365 366 if (flow_offload_has_one_action(action)) 367 return true; 368 369 flow_action_for_each(i, action_entry, action) { 370 if (i && action_entry->hw_stats != last_hw_stats) { 371 NL_SET_ERR_MSG_MOD(extack, "Mixing HW stats types for actions is not supported"); 372 return false; 373 } 374 last_hw_stats = action_entry->hw_stats; 375 } 376 return true; 377 } 378 379 static inline const struct flow_action_entry * 380 flow_action_first_entry_get(const struct flow_action *action) 381 { 382 WARN_ON(!flow_action_has_entries(action)); 383 return &action->entries[0]; 384 } 385 386 static inline bool 387 __flow_action_hw_stats_check(const struct flow_action *action, 388 struct netlink_ext_ack *extack, 389 bool check_allow_bit, 390 enum flow_action_hw_stats_bit allow_bit) 391 { 392 const struct flow_action_entry *action_entry; 393 394 if (!flow_action_has_entries(action)) 395 return true; 396 if (!flow_action_mixed_hw_stats_check(action, extack)) 397 return false; 398 399 action_entry = flow_action_first_entry_get(action); 400 401 /* Zero is not a legal value for hw_stats, catch anyone passing it */ 402 WARN_ON_ONCE(!action_entry->hw_stats); 403 404 if (!check_allow_bit && 405 ~action_entry->hw_stats & FLOW_ACTION_HW_STATS_ANY) { 406 NL_SET_ERR_MSG_MOD(extack, "Driver supports only default HW stats type \"any\""); 407 return false; 408 } else if (check_allow_bit && 409 !(action_entry->hw_stats & BIT(allow_bit))) { 410 NL_SET_ERR_MSG_MOD(extack, "Driver does not support selected HW stats type"); 411 return false; 412 } 413 return true; 414 } 415 416 static inline bool 417 flow_action_hw_stats_check(const struct flow_action *action, 418 struct netlink_ext_ack *extack, 419 enum flow_action_hw_stats_bit allow_bit) 420 { 421 return __flow_action_hw_stats_check(action, extack, true, allow_bit); 422 } 423 424 static inline bool 425 flow_action_basic_hw_stats_check(const struct flow_action *action, 426 struct netlink_ext_ack *extack) 427 { 428 return __flow_action_hw_stats_check(action, extack, false, 0); 429 } 430 431 struct flow_rule { 432 struct flow_match match; 433 struct flow_action action; 434 }; 435 436 struct flow_rule *flow_rule_alloc(unsigned int num_actions); 437 438 static inline bool flow_rule_match_key(const struct flow_rule *rule, 439 enum flow_dissector_key_id key) 440 { 441 return dissector_uses_key(rule->match.dissector, key); 442 } 443 444 struct flow_stats { 445 u64 pkts; 446 u64 bytes; 447 u64 drops; 448 u64 lastused; 449 enum flow_action_hw_stats used_hw_stats; 450 bool used_hw_stats_valid; 451 }; 452 453 static inline void flow_stats_update(struct flow_stats *flow_stats, 454 u64 bytes, u64 pkts, 455 u64 drops, u64 lastused, 456 enum flow_action_hw_stats used_hw_stats) 457 { 458 flow_stats->pkts += pkts; 459 flow_stats->bytes += bytes; 460 flow_stats->drops += drops; 461 flow_stats->lastused = max_t(u64, flow_stats->lastused, lastused); 462 463 /* The driver should pass value with a maximum of one bit set. 464 * Passing FLOW_ACTION_HW_STATS_ANY is invalid. 465 */ 466 WARN_ON(used_hw_stats == FLOW_ACTION_HW_STATS_ANY); 467 flow_stats->used_hw_stats |= used_hw_stats; 468 flow_stats->used_hw_stats_valid = true; 469 } 470 471 enum flow_block_command { 472 FLOW_BLOCK_BIND, 473 FLOW_BLOCK_UNBIND, 474 }; 475 476 enum flow_block_binder_type { 477 FLOW_BLOCK_BINDER_TYPE_UNSPEC, 478 FLOW_BLOCK_BINDER_TYPE_CLSACT_INGRESS, 479 FLOW_BLOCK_BINDER_TYPE_CLSACT_EGRESS, 480 FLOW_BLOCK_BINDER_TYPE_RED_EARLY_DROP, 481 FLOW_BLOCK_BINDER_TYPE_RED_MARK, 482 }; 483 484 struct flow_block { 485 struct list_head cb_list; 486 }; 487 488 struct netlink_ext_ack; 489 490 struct flow_block_offload { 491 enum flow_block_command command; 492 enum flow_block_binder_type binder_type; 493 bool block_shared; 494 bool unlocked_driver_cb; 495 struct net *net; 496 struct flow_block *block; 497 struct list_head cb_list; 498 struct list_head *driver_block_list; 499 struct netlink_ext_ack *extack; 500 struct Qdisc *sch; 501 struct list_head *cb_list_head; 502 }; 503 504 enum tc_setup_type; 505 typedef int flow_setup_cb_t(enum tc_setup_type type, void *type_data, 506 void *cb_priv); 507 508 struct flow_block_cb; 509 510 struct flow_block_indr { 511 struct list_head list; 512 struct net_device *dev; 513 struct Qdisc *sch; 514 enum flow_block_binder_type binder_type; 515 void *data; 516 void *cb_priv; 517 void (*cleanup)(struct flow_block_cb *block_cb); 518 }; 519 520 struct flow_block_cb { 521 struct list_head driver_list; 522 struct list_head list; 523 flow_setup_cb_t *cb; 524 void *cb_ident; 525 void *cb_priv; 526 void (*release)(void *cb_priv); 527 struct flow_block_indr indr; 528 unsigned int refcnt; 529 }; 530 531 struct flow_block_cb *flow_block_cb_alloc(flow_setup_cb_t *cb, 532 void *cb_ident, void *cb_priv, 533 void (*release)(void *cb_priv)); 534 struct flow_block_cb *flow_indr_block_cb_alloc(flow_setup_cb_t *cb, 535 void *cb_ident, void *cb_priv, 536 void (*release)(void *cb_priv), 537 struct flow_block_offload *bo, 538 struct net_device *dev, 539 struct Qdisc *sch, void *data, 540 void *indr_cb_priv, 541 void (*cleanup)(struct flow_block_cb *block_cb)); 542 void flow_block_cb_free(struct flow_block_cb *block_cb); 543 544 struct flow_block_cb *flow_block_cb_lookup(struct flow_block *block, 545 flow_setup_cb_t *cb, void *cb_ident); 546 547 void *flow_block_cb_priv(struct flow_block_cb *block_cb); 548 void flow_block_cb_incref(struct flow_block_cb *block_cb); 549 unsigned int flow_block_cb_decref(struct flow_block_cb *block_cb); 550 551 static inline void flow_block_cb_add(struct flow_block_cb *block_cb, 552 struct flow_block_offload *offload) 553 { 554 list_add_tail(&block_cb->list, &offload->cb_list); 555 } 556 557 static inline void flow_block_cb_remove(struct flow_block_cb *block_cb, 558 struct flow_block_offload *offload) 559 { 560 list_move(&block_cb->list, &offload->cb_list); 561 } 562 563 static inline void flow_indr_block_cb_remove(struct flow_block_cb *block_cb, 564 struct flow_block_offload *offload) 565 { 566 list_del(&block_cb->indr.list); 567 list_move(&block_cb->list, &offload->cb_list); 568 } 569 570 bool flow_block_cb_is_busy(flow_setup_cb_t *cb, void *cb_ident, 571 struct list_head *driver_block_list); 572 573 int flow_block_cb_setup_simple(struct flow_block_offload *f, 574 struct list_head *driver_list, 575 flow_setup_cb_t *cb, 576 void *cb_ident, void *cb_priv, bool ingress_only); 577 578 enum flow_cls_command { 579 FLOW_CLS_REPLACE, 580 FLOW_CLS_DESTROY, 581 FLOW_CLS_STATS, 582 FLOW_CLS_TMPLT_CREATE, 583 FLOW_CLS_TMPLT_DESTROY, 584 }; 585 586 struct flow_cls_common_offload { 587 u32 chain_index; 588 __be16 protocol; 589 u32 prio; 590 struct netlink_ext_ack *extack; 591 }; 592 593 struct flow_cls_offload { 594 struct flow_cls_common_offload common; 595 enum flow_cls_command command; 596 unsigned long cookie; 597 struct flow_rule *rule; 598 struct flow_stats stats; 599 u32 classid; 600 }; 601 602 enum offload_act_command { 603 FLOW_ACT_REPLACE, 604 FLOW_ACT_DESTROY, 605 FLOW_ACT_STATS, 606 }; 607 608 struct flow_offload_action { 609 struct netlink_ext_ack *extack; /* NULL in FLOW_ACT_STATS process*/ 610 enum offload_act_command command; 611 enum flow_action_id id; 612 u32 index; 613 struct flow_stats stats; 614 struct flow_action action; 615 }; 616 617 struct flow_offload_action *offload_action_alloc(unsigned int num_actions); 618 619 static inline struct flow_rule * 620 flow_cls_offload_flow_rule(struct flow_cls_offload *flow_cmd) 621 { 622 return flow_cmd->rule; 623 } 624 625 static inline void flow_block_init(struct flow_block *flow_block) 626 { 627 INIT_LIST_HEAD(&flow_block->cb_list); 628 } 629 630 typedef int flow_indr_block_bind_cb_t(struct net_device *dev, struct Qdisc *sch, void *cb_priv, 631 enum tc_setup_type type, void *type_data, 632 void *data, 633 void (*cleanup)(struct flow_block_cb *block_cb)); 634 635 int flow_indr_dev_register(flow_indr_block_bind_cb_t *cb, void *cb_priv); 636 void flow_indr_dev_unregister(flow_indr_block_bind_cb_t *cb, void *cb_priv, 637 void (*release)(void *cb_priv)); 638 int flow_indr_dev_setup_offload(struct net_device *dev, struct Qdisc *sch, 639 enum tc_setup_type type, void *data, 640 struct flow_block_offload *bo, 641 void (*cleanup)(struct flow_block_cb *block_cb)); 642 bool flow_indr_dev_exists(void); 643 644 #endif /* _NET_FLOW_OFFLOAD_H */ 645