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