drivers/net/ethernet/netronome/nfp/flower/main.h

   1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
   2 /* Copyright (C) 2017-2018 Netronome Systems, Inc. */
   3
   4 #ifndef __NFP_FLOWER_H__
   5 #define __NFP_FLOWER_H__ 1
   6
   7 #include "cmsg.h"
   8 #include "../nfp_net.h"
   9
  10 #include <linux/circ_buf.h>
  11 #include <linux/hashtable.h>
  12 #include <linux/rhashtable.h>
  13 #include <linux/time64.h>
  14 #include <linux/types.h>
  15 #include <net/pkt_cls.h>
  16 #include <net/tcp.h>
  17 #include <linux/workqueue.h>
  18 #include <linux/idr.h>
  19
  20 struct nfp_fl_pre_lag;
  21 struct net_device;
  22 struct nfp_app;
  23
  24 #define NFP_FL_STAT_ID_MU_NUM           GENMASK(31, 22)
  25 #define NFP_FL_STAT_ID_STAT             GENMASK(21, 0)
  26
  27 #define NFP_FL_STATS_ELEM_RS            sizeof_field(struct nfp_fl_stats_id, \
  28                                                      init_unalloc)
  29 #define NFP_FLOWER_MASK_ENTRY_RS        256
  30 #define NFP_FLOWER_MASK_ELEMENT_RS      1
  31 #define NFP_FLOWER_MASK_HASH_BITS       10
  32
  33 #define NFP_FL_META_FLAG_MANAGE_MASK    BIT(7)
  34
  35 #define NFP_FL_MASK_REUSE_TIME_NS       40000
  36 #define NFP_FL_MASK_ID_LOCATION         1
  37
  38 /* Extra features bitmap. */
  39 #define NFP_FL_FEATS_GENEVE             BIT(0)
  40 #define NFP_FL_NBI_MTU_SETTING          BIT(1)
  41 #define NFP_FL_FEATS_GENEVE_OPT         BIT(2)
  42 #define NFP_FL_FEATS_VLAN_PCP           BIT(3)
  43 #define NFP_FL_FEATS_VF_RLIM            BIT(4)
  44 #define NFP_FL_FEATS_FLOW_MOD           BIT(5)
  45 #define NFP_FL_FEATS_PRE_TUN_RULES      BIT(6)
  46 #define NFP_FL_FEATS_IPV6_TUN           BIT(7)
  47 #define NFP_FL_FEATS_HOST_ACK           BIT(31)
  48
  49 #define NFP_FL_ENABLE_FLOW_MERGE        BIT(0)
  50 #define NFP_FL_ENABLE_LAG               BIT(1)
  51
  52 #define NFP_FL_FEATS_HOST \
  53         (NFP_FL_FEATS_GENEVE | \
  54         NFP_FL_NBI_MTU_SETTING | \
  55         NFP_FL_FEATS_GENEVE_OPT | \
  56         NFP_FL_FEATS_VLAN_PCP | \
  57         NFP_FL_FEATS_VF_RLIM | \
  58         NFP_FL_FEATS_FLOW_MOD | \
  59         NFP_FL_FEATS_PRE_TUN_RULES | \
  60         NFP_FL_FEATS_IPV6_TUN)
  61
  62 struct nfp_fl_mask_id {
  63         struct circ_buf mask_id_free_list;
  64         ktime_t *last_used;
  65         u8 init_unallocated;
  66 };
  67
  68 struct nfp_fl_stats_id {
  69         struct circ_buf free_list;
  70         u32 init_unalloc;
  71         u8 repeated_em_count;
  72 };
  73
  74 /**
  75  * struct nfp_fl_tunnel_offloads - priv data for tunnel offloads
  76  * @offloaded_macs:     Hashtable of the offloaded MAC addresses
  77  * @ipv4_off_list:      List of IPv4 addresses to offload
  78  * @ipv6_off_list:      List of IPv6 addresses to offload
  79  * @neigh_off_list_v4:  List of IPv4 neighbour offloads
  80  * @neigh_off_list_v6:  List of IPv6 neighbour offloads
  81  * @ipv4_off_lock:      Lock for the IPv4 address list
  82  * @ipv6_off_lock:      Lock for the IPv6 address list
  83  * @neigh_off_lock_v4:  Lock for the IPv4 neighbour address list
  84  * @neigh_off_lock_v6:  Lock for the IPv6 neighbour address list
  85  * @mac_off_ids:        IDA to manage id assignment for offloaded MACs
  86  * @neigh_nb:           Notifier to monitor neighbour state
  87  */
  88 struct nfp_fl_tunnel_offloads {
  89         struct rhashtable offloaded_macs;
  90         struct list_head ipv4_off_list;
  91         struct list_head ipv6_off_list;
  92         struct list_head neigh_off_list_v4;
  93         struct list_head neigh_off_list_v6;
  94         struct mutex ipv4_off_lock;
  95         struct mutex ipv6_off_lock;
  96         spinlock_t neigh_off_lock_v4;
  97         spinlock_t neigh_off_lock_v6;
  98         struct ida mac_off_ids;
  99         struct notifier_block neigh_nb;
 100 };
 101
 102 /**
 103  * struct nfp_mtu_conf - manage MTU setting
 104  * @portnum:            NFP port number of repr with requested MTU change
 105  * @requested_val:      MTU value requested for repr
 106  * @ack:                Received ack that MTU has been correctly set
 107  * @wait_q:             Wait queue for MTU acknowledgements
 108  * @lock:               Lock for setting/reading MTU variables
 109  */
 110 struct nfp_mtu_conf {
 111         u32 portnum;
 112         unsigned int requested_val;
 113         bool ack;
 114         wait_queue_head_t wait_q;
 115         spinlock_t lock;
 116 };
 117
 118 /**
 119  * struct nfp_fl_lag - Flower APP priv data for link aggregation
 120  * @work:               Work queue for writing configs to the HW
 121  * @lock:               Lock to protect lag_group_list
 122  * @group_list:         List of all master/slave groups offloaded
 123  * @ida_handle:         IDA to handle group ids
 124  * @pkt_num:            Incremented for each config packet sent
 125  * @batch_ver:          Incremented for each batch of config packets
 126  * @global_inst:        Instance allocator for groups
 127  * @rst_cfg:            Marker to reset HW LAG config
 128  * @retrans_skbs:       Cmsgs that could not be processed by HW and require
 129  *                      retransmission
 130  */
 131 struct nfp_fl_lag {
 132         struct delayed_work work;
 133         struct mutex lock;
 134         struct list_head group_list;
 135         struct ida ida_handle;
 136         unsigned int pkt_num;
 137         unsigned int batch_ver;
 138         u8 global_inst;
 139         bool rst_cfg;
 140         struct sk_buff_head retrans_skbs;
 141 };
 142
 143 /**
 144  * struct nfp_fl_internal_ports - Flower APP priv data for additional ports
 145  * @port_ids:   Assignment of ids to any additional ports
 146  * @lock:       Lock for extra ports list
 147  */
 148 struct nfp_fl_internal_ports {
 149         struct idr port_ids;
 150         spinlock_t lock;
 151 };
 152
 153 /**
 154  * struct nfp_flower_priv - Flower APP per-vNIC priv data
 155  * @app:                Back pointer to app
 156  * @nn:                 Pointer to vNIC
 157  * @mask_id_seed:       Seed used for mask hash table
 158  * @flower_version:     HW version of flower
 159  * @flower_ext_feats:   Bitmap of extra features the HW supports
 160  * @flower_en_feats:    Bitmap of features enabled by HW
 161  * @stats_ids:          List of free stats ids
 162  * @mask_ids:           List of free mask ids
 163  * @mask_table:         Hash table used to store masks
 164  * @stats_ring_size:    Maximum number of allowed stats ids
 165  * @flow_table:         Hash table used to store flower rules
 166  * @stats:              Stored stats updates for flower rules
 167  * @stats_lock:         Lock for flower rule stats updates
 168  * @stats_ctx_table:    Hash table to map stats contexts to its flow rule
 169  * @cmsg_work:          Workqueue for control messages processing
 170  * @cmsg_skbs_high:     List of higher priority skbs for control message
 171  *                      processing
 172  * @cmsg_skbs_low:      List of lower priority skbs for control message
 173  *                      processing
 174  * @tun:                Tunnel offload data
 175  * @reify_replies:      atomically stores the number of replies received
 176  *                      from firmware for repr reify
 177  * @reify_wait_queue:   wait queue for repr reify response counting
 178  * @mtu_conf:           Configuration of repr MTU value
 179  * @nfp_lag:            Link aggregation data block
 180  * @indr_block_cb_priv: List of priv data passed to indirect block cbs
 181  * @non_repr_priv:      List of offloaded non-repr ports and their priv data
 182  * @active_mem_unit:    Current active memory unit for flower rules
 183  * @total_mem_units:    Total number of available memory units for flower rules
 184  * @internal_ports:     Internal port ids used in offloaded rules
 185  * @qos_stats_work:     Workqueue for qos stats processing
 186  * @qos_rate_limiters:  Current active qos rate limiters
 187  * @qos_stats_lock:     Lock on qos stats updates
 188  * @pre_tun_rule_cnt:   Number of pre-tunnel rules offloaded
 189  */
 190 struct nfp_flower_priv {
 191         struct nfp_app *app;
 192         struct nfp_net *nn;
 193         u32 mask_id_seed;
 194         u64 flower_version;
 195         u64 flower_ext_feats;
 196         u8 flower_en_feats;
 197         struct nfp_fl_stats_id stats_ids;
 198         struct nfp_fl_mask_id mask_ids;
 199         DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
 200         u32 stats_ring_size;
 201         struct rhashtable flow_table;
 202         struct nfp_fl_stats *stats;
 203         spinlock_t stats_lock; /* lock stats */
 204         struct rhashtable stats_ctx_table;
 205         struct work_struct cmsg_work;
 206         struct sk_buff_head cmsg_skbs_high;
 207         struct sk_buff_head cmsg_skbs_low;
 208         struct nfp_fl_tunnel_offloads tun;
 209         atomic_t reify_replies;
 210         wait_queue_head_t reify_wait_queue;
 211         struct nfp_mtu_conf mtu_conf;
 212         struct nfp_fl_lag nfp_lag;
 213         struct list_head indr_block_cb_priv;
 214         struct list_head non_repr_priv;
 215         unsigned int active_mem_unit;
 216         unsigned int total_mem_units;
 217         struct nfp_fl_internal_ports internal_ports;
 218         struct delayed_work qos_stats_work;
 219         unsigned int qos_rate_limiters;
 220         spinlock_t qos_stats_lock; /* Protect the qos stats */
 221         int pre_tun_rule_cnt;
 222 };
 223
 224 /**
 225  * struct nfp_fl_qos - Flower APP priv data for quality of service
 226  * @netdev_port_id:     NFP port number of repr with qos info
 227  * @curr_stats:         Currently stored stats updates for qos info
 228  * @prev_stats:         Previously stored updates for qos info
 229  * @last_update:        Stored time when last stats were updated
 230  */
 231 struct nfp_fl_qos {
 232         u32 netdev_port_id;
 233         struct nfp_stat_pair curr_stats;
 234         struct nfp_stat_pair prev_stats;
 235         u64 last_update;
 236 };
 237
 238 /**
 239  * struct nfp_flower_repr_priv - Flower APP per-repr priv data
 240  * @nfp_repr:           Back pointer to nfp_repr
 241  * @lag_port_flags:     Extended port flags to record lag state of repr
 242  * @mac_offloaded:      Flag indicating a MAC address is offloaded for repr
 243  * @offloaded_mac_addr: MAC address that has been offloaded for repr
 244  * @block_shared:       Flag indicating if offload applies to shared blocks
 245  * @mac_list:           List entry of reprs that share the same offloaded MAC
 246  * @qos_table:          Stored info on filters implementing qos
 247  * @on_bridge:          Indicates if the repr is attached to a bridge
 248  */
 249 struct nfp_flower_repr_priv {
 250         struct nfp_repr *nfp_repr;
 251         unsigned long lag_port_flags;
 252         bool mac_offloaded;
 253         u8 offloaded_mac_addr[ETH_ALEN];
 254         bool block_shared;
 255         struct list_head mac_list;
 256         struct nfp_fl_qos qos_table;
 257         bool on_bridge;
 258 };
 259
 260 /**
 261  * struct nfp_flower_non_repr_priv - Priv data for non-repr offloaded ports
 262  * @list:               List entry of offloaded reprs
 263  * @netdev:             Pointer to non-repr net_device
 264  * @ref_count:          Number of references held for this priv data
 265  * @mac_offloaded:      Flag indicating a MAC address is offloaded for device
 266  * @offloaded_mac_addr: MAC address that has been offloaded for dev
 267  */
 268 struct nfp_flower_non_repr_priv {
 269         struct list_head list;
 270         struct net_device *netdev;
 271         int ref_count;
 272         bool mac_offloaded;
 273         u8 offloaded_mac_addr[ETH_ALEN];
 274 };
 275
 276 struct nfp_fl_key_ls {
 277         u32 key_layer_two;
 278         u8 key_layer;
 279         int key_size;
 280 };
 281
 282 struct nfp_fl_rule_metadata {
 283         u8 key_len;
 284         u8 mask_len;
 285         u8 act_len;
 286         u8 flags;
 287         __be32 host_ctx_id;
 288         __be64 host_cookie __packed;
 289         __be64 flow_version __packed;
 290         __be32 shortcut;
 291 };
 292
 293 struct nfp_fl_stats {
 294         u64 pkts;
 295         u64 bytes;
 296         u64 used;
 297 };
 298
 299 /**
 300  * struct nfp_ipv6_addr_entry - cached IPv6 addresses
 301  * @ipv6_addr:  IP address
 302  * @ref_count:  number of rules currently using this IP
 303  * @list:       list pointer
 304  */
 305 struct nfp_ipv6_addr_entry {
 306         struct in6_addr ipv6_addr;
 307         int ref_count;
 308         struct list_head list;
 309 };
 310
 311 struct nfp_fl_payload {
 312         struct nfp_fl_rule_metadata meta;
 313         unsigned long tc_flower_cookie;
 314         struct rhash_head fl_node;
 315         struct rcu_head rcu;
 316         __be32 nfp_tun_ipv4_addr;
 317         struct nfp_ipv6_addr_entry *nfp_tun_ipv6;
 318         struct net_device *ingress_dev;
 319         char *unmasked_data;
 320         char *mask_data;
 321         char *action_data;
 322         struct list_head linked_flows;
 323         bool in_hw;
 324         struct {
 325                 struct net_device *dev;
 326                 __be16 vlan_tci;
 327                 __be16 port_idx;
 328         } pre_tun_rule;
 329 };
 330
 331 struct nfp_fl_payload_link {
 332         /* A link contains a pointer to a merge flow and an associated sub_flow.
 333          * Each merge flow will feature in 2 links to its underlying sub_flows.
 334          * A sub_flow will have at least 1 link to a merge flow or more if it
 335          * has been used to create multiple merge flows.
 336          *
 337          * For a merge flow, 'linked_flows' in its nfp_fl_payload struct lists
 338          * all links to sub_flows (sub_flow.flow) via merge.list.
 339          * For a sub_flow, 'linked_flows' gives all links to merge flows it has
 340          * formed (merge_flow.flow) via sub_flow.list.
 341          */
 342         struct {
 343                 struct list_head list;
 344                 struct nfp_fl_payload *flow;
 345         } merge_flow, sub_flow;
 346 };
 347
 348 extern const struct rhashtable_params nfp_flower_table_params;
 349
 350 struct nfp_fl_stats_frame {
 351         __be32 stats_con_id;
 352         __be32 pkt_count;
 353         __be64 byte_count;
 354         __be64 stats_cookie;
 355 };
 356
 357 static inline bool
 358 nfp_flower_internal_port_can_offload(struct nfp_app *app,
 359                                      struct net_device *netdev)
 360 {
 361         struct nfp_flower_priv *app_priv = app->priv;
 362
 363         if (!(app_priv->flower_en_feats & NFP_FL_ENABLE_FLOW_MERGE))
 364                 return false;
 365         if (!netdev->rtnl_link_ops)
 366                 return false;
 367         if (!strcmp(netdev->rtnl_link_ops->kind, "openvswitch"))
 368                 return true;
 369
 370         return false;
 371 }
 372
 373 /* The address of the merged flow acts as its cookie.
 374  * Cookies supplied to us by TC flower are also addresses to allocated
 375  * memory and thus this scheme should not generate any collisions.
 376  */
 377 static inline bool nfp_flower_is_merge_flow(struct nfp_fl_payload *flow_pay)
 378 {
 379         return flow_pay->tc_flower_cookie == (unsigned long)flow_pay;
 380 }
 381
 382 static inline bool nfp_flower_is_supported_bridge(struct net_device *netdev)
 383 {
 384         return netif_is_ovs_master(netdev);
 385 }
 386
 387 int nfp_flower_metadata_init(struct nfp_app *app, u64 host_ctx_count,
 388                              unsigned int host_ctx_split);
 389 void nfp_flower_metadata_cleanup(struct nfp_app *app);
 390
 391 int nfp_flower_setup_tc(struct nfp_app *app, struct net_device *netdev,
 392                         enum tc_setup_type type, void *type_data);
 393 int nfp_flower_merge_offloaded_flows(struct nfp_app *app,
 394                                      struct nfp_fl_payload *sub_flow1,
 395                                      struct nfp_fl_payload *sub_flow2);
 396 int nfp_flower_compile_flow_match(struct nfp_app *app,
 397                                   struct flow_cls_offload *flow,
 398                                   struct nfp_fl_key_ls *key_ls,
 399                                   struct net_device *netdev,
 400                                   struct nfp_fl_payload *nfp_flow,
 401                                   enum nfp_flower_tun_type tun_type,
 402                                   struct netlink_ext_ack *extack);
 403 int nfp_flower_compile_action(struct nfp_app *app,
 404                               struct flow_cls_offload *flow,
 405                               struct net_device *netdev,
 406                               struct nfp_fl_payload *nfp_flow,
 407                               struct netlink_ext_ack *extack);
 408 int nfp_compile_flow_metadata(struct nfp_app *app,
 409                               struct flow_cls_offload *flow,
 410                               struct nfp_fl_payload *nfp_flow,
 411                               struct net_device *netdev,
 412                               struct netlink_ext_ack *extack);
 413 void __nfp_modify_flow_metadata(struct nfp_flower_priv *priv,
 414                                 struct nfp_fl_payload *nfp_flow);
 415 int nfp_modify_flow_metadata(struct nfp_app *app,
 416                              struct nfp_fl_payload *nfp_flow);
 417
 418 struct nfp_fl_payload *
 419 nfp_flower_search_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie,
 420                            struct net_device *netdev);
 421 struct nfp_fl_payload *
 422 nfp_flower_get_fl_payload_from_ctx(struct nfp_app *app, u32 ctx_id);
 423 struct nfp_fl_payload *
 424 nfp_flower_remove_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
 425
 426 void nfp_flower_rx_flow_stats(struct nfp_app *app, struct sk_buff *skb);
 427
 428 int nfp_tunnel_config_start(struct nfp_app *app);
 429 void nfp_tunnel_config_stop(struct nfp_app *app);
 430 int nfp_tunnel_mac_event_handler(struct nfp_app *app,
 431                                  struct net_device *netdev,
 432                                  unsigned long event, void *ptr);
 433 void nfp_tunnel_del_ipv4_off(struct nfp_app *app, __be32 ipv4);
 434 void nfp_tunnel_add_ipv4_off(struct nfp_app *app, __be32 ipv4);
 435 void
 436 nfp_tunnel_put_ipv6_off(struct nfp_app *app, struct nfp_ipv6_addr_entry *entry);
 437 struct nfp_ipv6_addr_entry *
 438 nfp_tunnel_add_ipv6_off(struct nfp_app *app, struct in6_addr *ipv6);
 439 void nfp_tunnel_request_route_v4(struct nfp_app *app, struct sk_buff *skb);
 440 void nfp_tunnel_request_route_v6(struct nfp_app *app, struct sk_buff *skb);
 441 void nfp_tunnel_keep_alive(struct nfp_app *app, struct sk_buff *skb);
 442 void nfp_tunnel_keep_alive_v6(struct nfp_app *app, struct sk_buff *skb);
 443 void nfp_flower_lag_init(struct nfp_fl_lag *lag);
 444 void nfp_flower_lag_cleanup(struct nfp_fl_lag *lag);
 445 int nfp_flower_lag_reset(struct nfp_fl_lag *lag);
 446 int nfp_flower_lag_netdev_event(struct nfp_flower_priv *priv,
 447                                 struct net_device *netdev,
 448                                 unsigned long event, void *ptr);
 449 bool nfp_flower_lag_unprocessed_msg(struct nfp_app *app, struct sk_buff *skb);
 450 int nfp_flower_lag_populate_pre_action(struct nfp_app *app,
 451                                        struct net_device *master,
 452                                        struct nfp_fl_pre_lag *pre_act,
 453                                        struct netlink_ext_ack *extack);
 454 int nfp_flower_lag_get_output_id(struct nfp_app *app,
 455                                  struct net_device *master);
 456 void nfp_flower_qos_init(struct nfp_app *app);
 457 void nfp_flower_qos_cleanup(struct nfp_app *app);
 458 int nfp_flower_setup_qos_offload(struct nfp_app *app, struct net_device *netdev,
 459                                  struct tc_cls_matchall_offload *flow);
 460 void nfp_flower_stats_rlim_reply(struct nfp_app *app, struct sk_buff *skb);
 461 int nfp_flower_indr_setup_tc_cb(struct net_device *netdev, void *cb_priv,
 462                                 enum tc_setup_type type, void *type_data);
 463 int nfp_flower_setup_indr_block_cb(enum tc_setup_type type, void *type_data,
 464                                    void *cb_priv);
 465
 466 void
 467 __nfp_flower_non_repr_priv_get(struct nfp_flower_non_repr_priv *non_repr_priv);
 468 struct nfp_flower_non_repr_priv *
 469 nfp_flower_non_repr_priv_get(struct nfp_app *app, struct net_device *netdev);
 470 void
 471 __nfp_flower_non_repr_priv_put(struct nfp_flower_non_repr_priv *non_repr_priv);
 472 void
 473 nfp_flower_non_repr_priv_put(struct nfp_app *app, struct net_device *netdev);
 474 u32 nfp_flower_get_port_id_from_netdev(struct nfp_app *app,
 475                                        struct net_device *netdev);
 476 int nfp_flower_xmit_pre_tun_flow(struct nfp_app *app,
 477                                  struct nfp_fl_payload *flow);
 478 int nfp_flower_xmit_pre_tun_del_flow(struct nfp_app *app,
 479                                      struct nfp_fl_payload *flow);
 480 #endif