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

   1 /*
   2  * Copyright (C) 2017 Netronome Systems, Inc.
   3  *
   4  * This software is dual licensed under the GNU General License Version 2,
   5  * June 1991 as shown in the file COPYING in the top-level directory of this
   6  * source tree or the BSD 2-Clause License provided below.  You have the
   7  * option to license this software under the complete terms of either license.
   8  *
   9  * The BSD 2-Clause License:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      1. Redistributions of source code must retain the above
  16  *         copyright notice, this list of conditions and the following
  17  *         disclaimer.
  18  *
  19  *      2. Redistributions in binary form must reproduce the above
  20  *         copyright notice, this list of conditions and the following
  21  *         disclaimer in the documentation and/or other materials
  22  *         provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 #ifndef __NFP_FLOWER_H__
  35 #define __NFP_FLOWER_H__ 1
  36
  37 #include "cmsg.h"
  38
  39 #include <linux/circ_buf.h>
  40 #include <linux/hashtable.h>
  41 #include <linux/time64.h>
  42 #include <linux/types.h>
  43 #include <net/pkt_cls.h>
  44 #include <net/tcp.h>
  45 #include <linux/workqueue.h>
  46
  47 struct net_device;
  48 struct nfp_app;
  49
  50 #define NFP_FL_STATS_ENTRY_RS           BIT(20)
  51 #define NFP_FL_STATS_ELEM_RS            4
  52 #define NFP_FL_REPEATED_HASH_MAX        BIT(17)
  53 #define NFP_FLOWER_HASH_BITS            19
  54 #define NFP_FLOWER_MASK_ENTRY_RS        256
  55 #define NFP_FLOWER_MASK_ELEMENT_RS      1
  56 #define NFP_FLOWER_MASK_HASH_BITS       10
  57
  58 #define NFP_FL_META_FLAG_MANAGE_MASK    BIT(7)
  59
  60 #define NFP_FL_MASK_REUSE_TIME_NS       40000
  61 #define NFP_FL_MASK_ID_LOCATION         1
  62
  63 #define NFP_FL_VXLAN_PORT               4789
  64 #define NFP_FL_GENEVE_PORT              6081
  65
  66 /* Extra features bitmap. */
  67 #define NFP_FL_FEATS_GENEVE             BIT(0)
  68 #define NFP_FL_NBI_MTU_SETTING          BIT(1)
  69
  70 struct nfp_fl_mask_id {
  71         struct circ_buf mask_id_free_list;
  72         struct timespec64 *last_used;
  73         u8 init_unallocated;
  74 };
  75
  76 struct nfp_fl_stats_id {
  77         struct circ_buf free_list;
  78         u32 init_unalloc;
  79         u8 repeated_em_count;
  80 };
  81
  82 /**
  83  * struct nfp_mtu_conf - manage MTU setting
  84  * @portnum:            NFP port number of repr with requested MTU change
  85  * @requested_val:      MTU value requested for repr
  86  * @ack:                Received ack that MTU has been correctly set
  87  * @wait_q:             Wait queue for MTU acknowledgements
  88  * @lock:               Lock for setting/reading MTU variables
  89  */
  90 struct nfp_mtu_conf {
  91         u32 portnum;
  92         unsigned int requested_val;
  93         bool ack;
  94         wait_queue_head_t wait_q;
  95         spinlock_t lock;
  96 };
  97
  98 /**
  99  * struct nfp_flower_priv - Flower APP per-vNIC priv data
 100  * @app:                Back pointer to app
 101  * @nn:                 Pointer to vNIC
 102  * @mask_id_seed:       Seed used for mask hash table
 103  * @flower_version:     HW version of flower
 104  * @flower_ext_feats:   Bitmap of extra features the HW supports
 105  * @stats_ids:          List of free stats ids
 106  * @mask_ids:           List of free mask ids
 107  * @mask_table:         Hash table used to store masks
 108  * @flow_table:         Hash table used to store flower rules
 109  * @cmsg_work:          Workqueue for control messages processing
 110  * @cmsg_skbs:          List of skbs for control message processing
 111  * @nfp_mac_off_list:   List of MAC addresses to offload
 112  * @nfp_mac_index_list: List of unique 8-bit indexes for non NFP netdevs
 113  * @nfp_ipv4_off_list:  List of IPv4 addresses to offload
 114  * @nfp_neigh_off_list: List of neighbour offloads
 115  * @nfp_mac_off_lock:   Lock for the MAC address list
 116  * @nfp_mac_index_lock: Lock for the MAC index list
 117  * @nfp_ipv4_off_lock:  Lock for the IPv4 address list
 118  * @nfp_neigh_off_lock: Lock for the neighbour address list
 119  * @nfp_mac_off_ids:    IDA to manage id assignment for offloaded macs
 120  * @nfp_mac_off_count:  Number of MACs in address list
 121  * @nfp_tun_mac_nb:     Notifier to monitor link state
 122  * @nfp_tun_neigh_nb:   Notifier to monitor neighbour state
 123  * @reify_replies:      atomically stores the number of replies received
 124  *                      from firmware for repr reify
 125  * @reify_wait_queue:   wait queue for repr reify response counting
 126  * @mtu_conf:           Configuration of repr MTU value
 127  */
 128 struct nfp_flower_priv {
 129         struct nfp_app *app;
 130         struct nfp_net *nn;
 131         u32 mask_id_seed;
 132         u64 flower_version;
 133         u64 flower_ext_feats;
 134         struct nfp_fl_stats_id stats_ids;
 135         struct nfp_fl_mask_id mask_ids;
 136         DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
 137         DECLARE_HASHTABLE(flow_table, NFP_FLOWER_HASH_BITS);
 138         struct work_struct cmsg_work;
 139         struct sk_buff_head cmsg_skbs;
 140         struct list_head nfp_mac_off_list;
 141         struct list_head nfp_mac_index_list;
 142         struct list_head nfp_ipv4_off_list;
 143         struct list_head nfp_neigh_off_list;
 144         struct mutex nfp_mac_off_lock;
 145         struct mutex nfp_mac_index_lock;
 146         struct mutex nfp_ipv4_off_lock;
 147         spinlock_t nfp_neigh_off_lock;
 148         struct ida nfp_mac_off_ids;
 149         int nfp_mac_off_count;
 150         struct notifier_block nfp_tun_mac_nb;
 151         struct notifier_block nfp_tun_neigh_nb;
 152         atomic_t reify_replies;
 153         wait_queue_head_t reify_wait_queue;
 154         struct nfp_mtu_conf mtu_conf;
 155 };
 156
 157 struct nfp_fl_key_ls {
 158         u32 key_layer_two;
 159         u8 key_layer;
 160         int key_size;
 161 };
 162
 163 struct nfp_fl_rule_metadata {
 164         u8 key_len;
 165         u8 mask_len;
 166         u8 act_len;
 167         u8 flags;
 168         __be32 host_ctx_id;
 169         __be64 host_cookie __packed;
 170         __be64 flow_version __packed;
 171         __be32 shortcut;
 172 };
 173
 174 struct nfp_fl_stats {
 175         u64 pkts;
 176         u64 bytes;
 177         u64 used;
 178 };
 179
 180 struct nfp_fl_payload {
 181         struct nfp_fl_rule_metadata meta;
 182         unsigned long tc_flower_cookie;
 183         struct hlist_node link;
 184         struct rcu_head rcu;
 185         spinlock_t lock; /* lock stats */
 186         struct nfp_fl_stats stats;
 187         __be32 nfp_tun_ipv4_addr;
 188         char *unmasked_data;
 189         char *mask_data;
 190         char *action_data;
 191 };
 192
 193 struct nfp_fl_stats_frame {
 194         __be32 stats_con_id;
 195         __be32 pkt_count;
 196         __be64 byte_count;
 197         __be64 stats_cookie;
 198 };
 199
 200 int nfp_flower_metadata_init(struct nfp_app *app);
 201 void nfp_flower_metadata_cleanup(struct nfp_app *app);
 202
 203 int nfp_flower_setup_tc(struct nfp_app *app, struct net_device *netdev,
 204                         enum tc_setup_type type, void *type_data);
 205 int nfp_flower_compile_flow_match(struct tc_cls_flower_offload *flow,
 206                                   struct nfp_fl_key_ls *key_ls,
 207                                   struct net_device *netdev,
 208                                   struct nfp_fl_payload *nfp_flow,
 209                                   enum nfp_flower_tun_type tun_type);
 210 int nfp_flower_compile_action(struct tc_cls_flower_offload *flow,
 211                               struct net_device *netdev,
 212                               struct nfp_fl_payload *nfp_flow);
 213 int nfp_compile_flow_metadata(struct nfp_app *app,
 214                               struct tc_cls_flower_offload *flow,
 215                               struct nfp_fl_payload *nfp_flow);
 216 int nfp_modify_flow_metadata(struct nfp_app *app,
 217                              struct nfp_fl_payload *nfp_flow);
 218
 219 struct nfp_fl_payload *
 220 nfp_flower_search_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
 221 struct nfp_fl_payload *
 222 nfp_flower_remove_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
 223
 224 void nfp_flower_rx_flow_stats(struct nfp_app *app, struct sk_buff *skb);
 225
 226 int nfp_tunnel_config_start(struct nfp_app *app);
 227 void nfp_tunnel_config_stop(struct nfp_app *app);
 228 void nfp_tunnel_write_macs(struct nfp_app *app);
 229 void nfp_tunnel_del_ipv4_off(struct nfp_app *app, __be32 ipv4);
 230 void nfp_tunnel_add_ipv4_off(struct nfp_app *app, __be32 ipv4);
 231 void nfp_tunnel_request_route(struct nfp_app *app, struct sk_buff *skb);
 232 void nfp_tunnel_keep_alive(struct nfp_app *app, struct sk_buff *skb);
 233 int nfp_flower_setup_tc_egress_cb(enum tc_setup_type type, void *type_data,
 234                                   void *cb_priv);
 235
 236 #endif