xref: /linux/drivers/net/ethernet/netronome/nfp/flower/main.h (revision d96fc832bcb6269d96e33d506f33033d7ed08598)
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 
69 struct nfp_fl_mask_id {
70 	struct circ_buf mask_id_free_list;
71 	struct timespec64 *last_used;
72 	u8 init_unallocated;
73 };
74 
75 struct nfp_fl_stats_id {
76 	struct circ_buf free_list;
77 	u32 init_unalloc;
78 	u8 repeated_em_count;
79 };
80 
81 /**
82  * struct nfp_flower_priv - Flower APP per-vNIC priv data
83  * @app:		Back pointer to app
84  * @nn:			Pointer to vNIC
85  * @mask_id_seed:	Seed used for mask hash table
86  * @flower_version:	HW version of flower
87  * @flower_ext_feats:	Bitmap of extra features the HW supports
88  * @stats_ids:		List of free stats ids
89  * @mask_ids:		List of free mask ids
90  * @mask_table:		Hash table used to store masks
91  * @flow_table:		Hash table used to store flower rules
92  * @cmsg_work:		Workqueue for control messages processing
93  * @cmsg_skbs:		List of skbs for control message processing
94  * @nfp_mac_off_list:	List of MAC addresses to offload
95  * @nfp_mac_index_list:	List of unique 8-bit indexes for non NFP netdevs
96  * @nfp_ipv4_off_list:	List of IPv4 addresses to offload
97  * @nfp_neigh_off_list:	List of neighbour offloads
98  * @nfp_mac_off_lock:	Lock for the MAC address list
99  * @nfp_mac_index_lock:	Lock for the MAC index list
100  * @nfp_ipv4_off_lock:	Lock for the IPv4 address list
101  * @nfp_neigh_off_lock:	Lock for the neighbour address list
102  * @nfp_mac_off_ids:	IDA to manage id assignment for offloaded macs
103  * @nfp_mac_off_count:	Number of MACs in address list
104  * @nfp_tun_mac_nb:	Notifier to monitor link state
105  * @nfp_tun_neigh_nb:	Notifier to monitor neighbour state
106  * @reify_replies:	atomically stores the number of replies received
107  *			from firmware for repr reify
108  * @reify_wait_queue:	wait queue for repr reify response counting
109  */
110 struct nfp_flower_priv {
111 	struct nfp_app *app;
112 	struct nfp_net *nn;
113 	u32 mask_id_seed;
114 	u64 flower_version;
115 	u64 flower_ext_feats;
116 	struct nfp_fl_stats_id stats_ids;
117 	struct nfp_fl_mask_id mask_ids;
118 	DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
119 	DECLARE_HASHTABLE(flow_table, NFP_FLOWER_HASH_BITS);
120 	struct work_struct cmsg_work;
121 	struct sk_buff_head cmsg_skbs;
122 	struct list_head nfp_mac_off_list;
123 	struct list_head nfp_mac_index_list;
124 	struct list_head nfp_ipv4_off_list;
125 	struct list_head nfp_neigh_off_list;
126 	struct mutex nfp_mac_off_lock;
127 	struct mutex nfp_mac_index_lock;
128 	struct mutex nfp_ipv4_off_lock;
129 	spinlock_t nfp_neigh_off_lock;
130 	struct ida nfp_mac_off_ids;
131 	int nfp_mac_off_count;
132 	struct notifier_block nfp_tun_mac_nb;
133 	struct notifier_block nfp_tun_neigh_nb;
134 	atomic_t reify_replies;
135 	wait_queue_head_t reify_wait_queue;
136 };
137 
138 struct nfp_fl_key_ls {
139 	u32 key_layer_two;
140 	u8 key_layer;
141 	int key_size;
142 };
143 
144 struct nfp_fl_rule_metadata {
145 	u8 key_len;
146 	u8 mask_len;
147 	u8 act_len;
148 	u8 flags;
149 	__be32 host_ctx_id;
150 	__be64 host_cookie __packed;
151 	__be64 flow_version __packed;
152 	__be32 shortcut;
153 };
154 
155 struct nfp_fl_stats {
156 	u64 pkts;
157 	u64 bytes;
158 	u64 used;
159 };
160 
161 struct nfp_fl_payload {
162 	struct nfp_fl_rule_metadata meta;
163 	unsigned long tc_flower_cookie;
164 	struct hlist_node link;
165 	struct rcu_head rcu;
166 	spinlock_t lock; /* lock stats */
167 	struct nfp_fl_stats stats;
168 	__be32 nfp_tun_ipv4_addr;
169 	char *unmasked_data;
170 	char *mask_data;
171 	char *action_data;
172 };
173 
174 struct nfp_fl_stats_frame {
175 	__be32 stats_con_id;
176 	__be32 pkt_count;
177 	__be64 byte_count;
178 	__be64 stats_cookie;
179 };
180 
181 int nfp_flower_metadata_init(struct nfp_app *app);
182 void nfp_flower_metadata_cleanup(struct nfp_app *app);
183 
184 int nfp_flower_setup_tc(struct nfp_app *app, struct net_device *netdev,
185 			enum tc_setup_type type, void *type_data);
186 int nfp_flower_compile_flow_match(struct tc_cls_flower_offload *flow,
187 				  struct nfp_fl_key_ls *key_ls,
188 				  struct net_device *netdev,
189 				  struct nfp_fl_payload *nfp_flow,
190 				  enum nfp_flower_tun_type tun_type);
191 int nfp_flower_compile_action(struct tc_cls_flower_offload *flow,
192 			      struct net_device *netdev,
193 			      struct nfp_fl_payload *nfp_flow);
194 int nfp_compile_flow_metadata(struct nfp_app *app,
195 			      struct tc_cls_flower_offload *flow,
196 			      struct nfp_fl_payload *nfp_flow);
197 int nfp_modify_flow_metadata(struct nfp_app *app,
198 			     struct nfp_fl_payload *nfp_flow);
199 
200 struct nfp_fl_payload *
201 nfp_flower_search_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
202 struct nfp_fl_payload *
203 nfp_flower_remove_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
204 
205 void nfp_flower_rx_flow_stats(struct nfp_app *app, struct sk_buff *skb);
206 
207 int nfp_tunnel_config_start(struct nfp_app *app);
208 void nfp_tunnel_config_stop(struct nfp_app *app);
209 void nfp_tunnel_write_macs(struct nfp_app *app);
210 void nfp_tunnel_del_ipv4_off(struct nfp_app *app, __be32 ipv4);
211 void nfp_tunnel_add_ipv4_off(struct nfp_app *app, __be32 ipv4);
212 void nfp_tunnel_request_route(struct nfp_app *app, struct sk_buff *skb);
213 void nfp_tunnel_keep_alive(struct nfp_app *app, struct sk_buff *skb);
214 int nfp_flower_setup_tc_egress_cb(enum tc_setup_type type, void *type_data,
215 				  void *cb_priv);
216 
217 #endif
218