1 /*
2  * Copyright (c) 2015, Mellanox Technologies. All rights reserved.
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and/or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  */
32 
33 #ifndef _MLX5_FS_
34 #define _MLX5_FS_
35 
36 #include <linux/mlx5/driver.h>
37 #include <linux/mlx5/mlx5_ifc.h>
38 
39 #define MLX5_FS_DEFAULT_FLOW_TAG 0x0
40 
41 #define MLX5_SET_CFG(p, f, v) MLX5_SET(create_flow_group_in, p, f, v)
42 
43 enum mlx5_flow_destination_type {
44 	MLX5_FLOW_DESTINATION_TYPE_NONE,
45 	MLX5_FLOW_DESTINATION_TYPE_VPORT,
46 	MLX5_FLOW_DESTINATION_TYPE_FLOW_TABLE,
47 	MLX5_FLOW_DESTINATION_TYPE_TIR,
48 	MLX5_FLOW_DESTINATION_TYPE_FLOW_SAMPLER,
49 	MLX5_FLOW_DESTINATION_TYPE_UPLINK,
50 	MLX5_FLOW_DESTINATION_TYPE_PORT,
51 	MLX5_FLOW_DESTINATION_TYPE_COUNTER,
52 	MLX5_FLOW_DESTINATION_TYPE_FLOW_TABLE_NUM,
53 	MLX5_FLOW_DESTINATION_TYPE_RANGE,
54 	MLX5_FLOW_DESTINATION_TYPE_TABLE_TYPE,
55 };
56 
57 enum {
58 	MLX5_FLOW_CONTEXT_ACTION_FWD_NEXT_PRIO	= 1 << 16,
59 	MLX5_FLOW_CONTEXT_ACTION_ENCRYPT	= 1 << 17,
60 	MLX5_FLOW_CONTEXT_ACTION_DECRYPT	= 1 << 18,
61 	MLX5_FLOW_CONTEXT_ACTION_FWD_NEXT_NS	= 1 << 19,
62 };
63 
64 enum {
65 	MLX5_FLOW_TABLE_TUNNEL_EN_REFORMAT = BIT(0),
66 	MLX5_FLOW_TABLE_TUNNEL_EN_DECAP = BIT(1),
67 	MLX5_FLOW_TABLE_TERMINATION = BIT(2),
68 	MLX5_FLOW_TABLE_UNMANAGED = BIT(3),
69 	MLX5_FLOW_TABLE_OTHER_VPORT = BIT(4),
70 };
71 
72 #define LEFTOVERS_RULE_NUM	 2
build_leftovers_ft_param(int * priority,int * n_ent,int * n_grp)73 static inline void build_leftovers_ft_param(int *priority,
74 					    int *n_ent,
75 					    int *n_grp)
76 {
77 	*priority = 0; /* Priority of leftovers_prio-0 */
78 	*n_ent = LEFTOVERS_RULE_NUM;
79 	*n_grp = LEFTOVERS_RULE_NUM;
80 }
81 
82 enum mlx5_flow_namespace_type {
83 	MLX5_FLOW_NAMESPACE_BYPASS,
84 	MLX5_FLOW_NAMESPACE_KERNEL_RX_MACSEC,
85 	MLX5_FLOW_NAMESPACE_LAG,
86 	MLX5_FLOW_NAMESPACE_OFFLOADS,
87 	MLX5_FLOW_NAMESPACE_ETHTOOL,
88 	MLX5_FLOW_NAMESPACE_KERNEL,
89 	MLX5_FLOW_NAMESPACE_LEFTOVERS,
90 	MLX5_FLOW_NAMESPACE_ANCHOR,
91 	MLX5_FLOW_NAMESPACE_FDB_BYPASS,
92 	MLX5_FLOW_NAMESPACE_FDB,
93 	MLX5_FLOW_NAMESPACE_ESW_EGRESS,
94 	MLX5_FLOW_NAMESPACE_ESW_INGRESS,
95 	MLX5_FLOW_NAMESPACE_SNIFFER_RX,
96 	MLX5_FLOW_NAMESPACE_SNIFFER_TX,
97 	MLX5_FLOW_NAMESPACE_EGRESS,
98 	MLX5_FLOW_NAMESPACE_EGRESS_IPSEC,
99 	MLX5_FLOW_NAMESPACE_EGRESS_MACSEC,
100 	MLX5_FLOW_NAMESPACE_RDMA_RX,
101 	MLX5_FLOW_NAMESPACE_RDMA_RX_KERNEL,
102 	MLX5_FLOW_NAMESPACE_RDMA_TX,
103 	MLX5_FLOW_NAMESPACE_PORT_SEL,
104 	MLX5_FLOW_NAMESPACE_RDMA_RX_COUNTERS,
105 	MLX5_FLOW_NAMESPACE_RDMA_TX_COUNTERS,
106 	MLX5_FLOW_NAMESPACE_RDMA_RX_IPSEC,
107 	MLX5_FLOW_NAMESPACE_RDMA_TX_IPSEC,
108 };
109 
110 enum {
111 	FDB_BYPASS_PATH,
112 	FDB_TC_OFFLOAD,
113 	FDB_FT_OFFLOAD,
114 	FDB_TC_MISS,
115 	FDB_BR_OFFLOAD,
116 	FDB_SLOW_PATH,
117 	FDB_PER_VPORT,
118 };
119 
120 struct mlx5_pkt_reformat;
121 struct mlx5_modify_hdr;
122 struct mlx5_flow_definer;
123 struct mlx5_flow_table;
124 struct mlx5_flow_group;
125 struct mlx5_flow_namespace;
126 struct mlx5_flow_handle;
127 
128 enum {
129 	FLOW_CONTEXT_HAS_TAG = BIT(0),
130 };
131 
132 struct mlx5_flow_context {
133 	u32 flags;
134 	u32 flow_tag;
135 	u32 flow_source;
136 };
137 
138 struct mlx5_flow_spec {
139 	u8   match_criteria_enable;
140 	u32  match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
141 	u32  match_value[MLX5_ST_SZ_DW(fte_match_param)];
142 	struct mlx5_flow_context flow_context;
143 };
144 
145 enum {
146 	MLX5_FLOW_DEST_VPORT_VHCA_ID      = BIT(0),
147 	MLX5_FLOW_DEST_VPORT_REFORMAT_ID  = BIT(1),
148 };
149 
150 enum mlx5_flow_dest_range_field {
151 	MLX5_FLOW_DEST_RANGE_FIELD_PKT_LEN = 0,
152 };
153 
154 struct mlx5_flow_destination {
155 	enum mlx5_flow_destination_type	type;
156 	union {
157 		u32			tir_num;
158 		u32			ft_num;
159 		struct mlx5_flow_table	*ft;
160 		u32			counter_id;
161 		struct {
162 			u16		num;
163 			u16		vhca_id;
164 			struct mlx5_pkt_reformat *pkt_reformat;
165 			u8		flags;
166 		} vport;
167 		struct {
168 			struct mlx5_flow_table         *hit_ft;
169 			struct mlx5_flow_table         *miss_ft;
170 			enum mlx5_flow_dest_range_field field;
171 			u32                             min;
172 			u32                             max;
173 		} range;
174 		u32			sampler_id;
175 	};
176 };
177 
178 struct mod_hdr_tbl {
179 	struct mutex lock; /* protects hlist */
180 	DECLARE_HASHTABLE(hlist, 8);
181 };
182 
183 struct mlx5_flow_namespace *
184 mlx5_get_fdb_sub_ns(struct mlx5_core_dev *dev, int n);
185 struct mlx5_flow_namespace *
186 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
187 			enum mlx5_flow_namespace_type type);
188 struct mlx5_flow_namespace *
189 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
190 				  enum mlx5_flow_namespace_type type,
191 				  int vport);
192 
193 struct mlx5_flow_table_attr {
194 	int prio;
195 	int max_fte;
196 	u32 level;
197 	u32 flags;
198 	u16 uid;
199 	struct mlx5_flow_table *next_ft;
200 
201 	struct {
202 		int max_num_groups;
203 		int num_reserved_entries;
204 	} autogroup;
205 };
206 
207 struct mlx5_flow_table *
208 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
209 		       struct mlx5_flow_table_attr *ft_attr);
210 
211 struct mlx5_flow_table *
212 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
213 				    struct mlx5_flow_table_attr *ft_attr);
214 
215 struct mlx5_flow_table *
216 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
217 			     struct mlx5_flow_table_attr *ft_attr, u16 vport);
218 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
219 					       struct mlx5_flow_namespace *ns,
220 					       int prio, u32 level);
221 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
222 
223 /* inbox should be set with the following values:
224  * start_flow_index
225  * end_flow_index
226  * match_criteria_enable
227  * match_criteria
228  */
229 struct mlx5_flow_group *
230 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
231 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
232 
233 struct mlx5_exe_aso {
234 	u32 object_id;
235 	u8 type;
236 	u8 return_reg_id;
237 	union {
238 		u32 ctrl_data;
239 		struct {
240 			u8 meter_idx;
241 			u8 init_color;
242 		} flow_meter;
243 	};
244 };
245 
246 struct mlx5_fs_vlan {
247         u16 ethtype;
248         u16 vid;
249         u8  prio;
250 };
251 
252 #define MLX5_FS_VLAN_DEPTH	2
253 
254 enum {
255 	FLOW_ACT_NO_APPEND = BIT(0),
256 	FLOW_ACT_IGNORE_FLOW_LEVEL = BIT(1),
257 };
258 
259 struct mlx5_flow_act {
260 	u32 action;
261 	struct mlx5_modify_hdr  *modify_hdr;
262 	struct mlx5_pkt_reformat *pkt_reformat;
263 	struct mlx5_flow_act_crypto_params {
264 		u8 type;
265 		u32 obj_id;
266 	} crypto;
267 	u32 flags;
268 	struct mlx5_fs_vlan vlan[MLX5_FS_VLAN_DEPTH];
269 	struct ib_counters *counters;
270 	struct mlx5_flow_group *fg;
271 	struct mlx5_exe_aso exe_aso;
272 };
273 
274 #define MLX5_DECLARE_FLOW_ACT(name) \
275 	struct mlx5_flow_act name = { .action = MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
276 				      .flags =  0, }
277 
278 /* Single destination per rule.
279  * Group ID is implied by the match criteria.
280  */
281 struct mlx5_flow_handle *
282 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
283 		    const struct mlx5_flow_spec *spec,
284 		    struct mlx5_flow_act *flow_act,
285 		    struct mlx5_flow_destination *dest,
286 		    int num_dest);
287 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
288 
289 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
290 				 struct mlx5_flow_destination *new_dest,
291 				 struct mlx5_flow_destination *old_dest);
292 
293 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
294 
295 /* As mlx5_fc_create() but doesn't queue stats refresh thread. */
296 struct mlx5_fc *mlx5_fc_create_ex(struct mlx5_core_dev *dev, bool aging);
297 
298 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
299 u64 mlx5_fc_query_lastuse(struct mlx5_fc *counter);
300 void mlx5_fc_query_cached(struct mlx5_fc *counter,
301 			  u64 *bytes, u64 *packets, u64 *lastuse);
302 void mlx5_fc_query_cached_raw(struct mlx5_fc *counter,
303 			      u64 *bytes, u64 *packets, u64 *lastuse);
304 int mlx5_fc_query(struct mlx5_core_dev *dev, struct mlx5_fc *counter,
305 		  u64 *packets, u64 *bytes);
306 u32 mlx5_fc_id(struct mlx5_fc *counter);
307 
308 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
309 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
310 
311 struct mlx5_modify_hdr *mlx5_modify_header_alloc(struct mlx5_core_dev *dev,
312 						 u8 ns_type, u8 num_actions,
313 						 void *modify_actions);
314 void mlx5_modify_header_dealloc(struct mlx5_core_dev *dev,
315 				struct mlx5_modify_hdr *modify_hdr);
316 struct mlx5_flow_definer *
317 mlx5_create_match_definer(struct mlx5_core_dev *dev,
318 			  enum mlx5_flow_namespace_type ns_type, u16 format_id,
319 			  u32 *match_mask);
320 void mlx5_destroy_match_definer(struct mlx5_core_dev *dev,
321 				struct mlx5_flow_definer *definer);
322 int mlx5_get_match_definer_id(struct mlx5_flow_definer *definer);
323 
324 struct mlx5_pkt_reformat_params {
325 	int type;
326 	u8 param_0;
327 	u8 param_1;
328 	size_t size;
329 	void *data;
330 };
331 
332 struct mlx5_pkt_reformat *mlx5_packet_reformat_alloc(struct mlx5_core_dev *dev,
333 						     struct mlx5_pkt_reformat_params *params,
334 						     enum mlx5_flow_namespace_type ns_type);
335 void mlx5_packet_reformat_dealloc(struct mlx5_core_dev *dev,
336 				  struct mlx5_pkt_reformat *reformat);
337 
338 u32 mlx5_flow_table_id(struct mlx5_flow_table *ft);
339 #endif
340