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 };
54 
55 enum {
56 	MLX5_FLOW_CONTEXT_ACTION_FWD_NEXT_PRIO	= 1 << 16,
57 	MLX5_FLOW_CONTEXT_ACTION_ENCRYPT	= 1 << 17,
58 	MLX5_FLOW_CONTEXT_ACTION_DECRYPT	= 1 << 18,
59 	MLX5_FLOW_CONTEXT_ACTION_FWD_NEXT_NS	= 1 << 19,
60 };
61 
62 enum {
63 	MLX5_FLOW_TABLE_TUNNEL_EN_REFORMAT = BIT(0),
64 	MLX5_FLOW_TABLE_TUNNEL_EN_DECAP = BIT(1),
65 	MLX5_FLOW_TABLE_TERMINATION = BIT(2),
66 	MLX5_FLOW_TABLE_UNMANAGED = BIT(3),
67 	MLX5_FLOW_TABLE_OTHER_VPORT = BIT(4),
68 };
69 
70 #define LEFTOVERS_RULE_NUM	 2
build_leftovers_ft_param(int * priority,int * n_ent,int * n_grp)71 static inline void build_leftovers_ft_param(int *priority,
72 					    int *n_ent,
73 					    int *n_grp)
74 {
75 	*priority = 0; /* Priority of leftovers_prio-0 */
76 	*n_ent = LEFTOVERS_RULE_NUM;
77 	*n_grp = LEFTOVERS_RULE_NUM;
78 }
79 
80 enum mlx5_flow_namespace_type {
81 	MLX5_FLOW_NAMESPACE_BYPASS,
82 	MLX5_FLOW_NAMESPACE_KERNEL_RX_MACSEC,
83 	MLX5_FLOW_NAMESPACE_LAG,
84 	MLX5_FLOW_NAMESPACE_OFFLOADS,
85 	MLX5_FLOW_NAMESPACE_ETHTOOL,
86 	MLX5_FLOW_NAMESPACE_KERNEL,
87 	MLX5_FLOW_NAMESPACE_LEFTOVERS,
88 	MLX5_FLOW_NAMESPACE_ANCHOR,
89 	MLX5_FLOW_NAMESPACE_FDB_BYPASS,
90 	MLX5_FLOW_NAMESPACE_FDB,
91 	MLX5_FLOW_NAMESPACE_ESW_EGRESS,
92 	MLX5_FLOW_NAMESPACE_ESW_INGRESS,
93 	MLX5_FLOW_NAMESPACE_SNIFFER_RX,
94 	MLX5_FLOW_NAMESPACE_SNIFFER_TX,
95 	MLX5_FLOW_NAMESPACE_EGRESS,
96 	MLX5_FLOW_NAMESPACE_EGRESS_IPSEC,
97 	MLX5_FLOW_NAMESPACE_EGRESS_MACSEC,
98 	MLX5_FLOW_NAMESPACE_RDMA_RX,
99 	MLX5_FLOW_NAMESPACE_RDMA_RX_KERNEL,
100 	MLX5_FLOW_NAMESPACE_RDMA_TX,
101 	MLX5_FLOW_NAMESPACE_PORT_SEL,
102 	MLX5_FLOW_NAMESPACE_RDMA_RX_COUNTERS,
103 	MLX5_FLOW_NAMESPACE_RDMA_TX_COUNTERS,
104 };
105 
106 enum {
107 	FDB_BYPASS_PATH,
108 	FDB_TC_OFFLOAD,
109 	FDB_FT_OFFLOAD,
110 	FDB_TC_MISS,
111 	FDB_BR_OFFLOAD,
112 	FDB_SLOW_PATH,
113 	FDB_PER_VPORT,
114 };
115 
116 struct mlx5_pkt_reformat;
117 struct mlx5_modify_hdr;
118 struct mlx5_flow_definer;
119 struct mlx5_flow_table;
120 struct mlx5_flow_group;
121 struct mlx5_flow_namespace;
122 struct mlx5_flow_handle;
123 
124 enum {
125 	FLOW_CONTEXT_HAS_TAG = BIT(0),
126 };
127 
128 struct mlx5_flow_context {
129 	u32 flags;
130 	u32 flow_tag;
131 	u32 flow_source;
132 };
133 
134 struct mlx5_flow_spec {
135 	u8   match_criteria_enable;
136 	u32  match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
137 	u32  match_value[MLX5_ST_SZ_DW(fte_match_param)];
138 	struct mlx5_flow_context flow_context;
139 };
140 
141 enum {
142 	MLX5_FLOW_DEST_VPORT_VHCA_ID      = BIT(0),
143 	MLX5_FLOW_DEST_VPORT_REFORMAT_ID  = BIT(1),
144 };
145 
146 struct mlx5_flow_destination {
147 	enum mlx5_flow_destination_type	type;
148 	union {
149 		u32			tir_num;
150 		u32			ft_num;
151 		struct mlx5_flow_table	*ft;
152 		u32			counter_id;
153 		struct {
154 			u16		num;
155 			u16		vhca_id;
156 			struct mlx5_pkt_reformat *pkt_reformat;
157 			u8		flags;
158 		} vport;
159 		u32			sampler_id;
160 	};
161 };
162 
163 struct mod_hdr_tbl {
164 	struct mutex lock; /* protects hlist */
165 	DECLARE_HASHTABLE(hlist, 8);
166 };
167 
168 struct mlx5_flow_namespace *
169 mlx5_get_fdb_sub_ns(struct mlx5_core_dev *dev, int n);
170 struct mlx5_flow_namespace *
171 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
172 			enum mlx5_flow_namespace_type type);
173 struct mlx5_flow_namespace *
174 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
175 				  enum mlx5_flow_namespace_type type,
176 				  int vport);
177 
178 struct mlx5_flow_table_attr {
179 	int prio;
180 	int max_fte;
181 	u32 level;
182 	u32 flags;
183 	u16 uid;
184 	struct mlx5_flow_table *next_ft;
185 
186 	struct {
187 		int max_num_groups;
188 		int num_reserved_entries;
189 	} autogroup;
190 };
191 
192 struct mlx5_flow_table *
193 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
194 		       struct mlx5_flow_table_attr *ft_attr);
195 
196 struct mlx5_flow_table *
197 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
198 				    struct mlx5_flow_table_attr *ft_attr);
199 
200 struct mlx5_flow_table *
201 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
202 			     struct mlx5_flow_table_attr *ft_attr, u16 vport);
203 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
204 					       struct mlx5_flow_namespace *ns,
205 					       int prio, u32 level);
206 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
207 
208 /* inbox should be set with the following values:
209  * start_flow_index
210  * end_flow_index
211  * match_criteria_enable
212  * match_criteria
213  */
214 struct mlx5_flow_group *
215 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
216 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
217 
218 struct mlx5_exe_aso {
219 	u32 object_id;
220 	u8 type;
221 	u8 return_reg_id;
222 	union {
223 		u32 ctrl_data;
224 		struct {
225 			u8 meter_idx;
226 			u8 init_color;
227 		} flow_meter;
228 	};
229 };
230 
231 struct mlx5_fs_vlan {
232         u16 ethtype;
233         u16 vid;
234         u8  prio;
235 };
236 
237 #define MLX5_FS_VLAN_DEPTH	2
238 
239 enum {
240 	FLOW_ACT_NO_APPEND = BIT(0),
241 	FLOW_ACT_IGNORE_FLOW_LEVEL = BIT(1),
242 };
243 
244 struct mlx5_flow_act {
245 	u32 action;
246 	struct mlx5_modify_hdr  *modify_hdr;
247 	struct mlx5_pkt_reformat *pkt_reformat;
248 	struct mlx5_flow_act_crypto_params {
249 		u8 type;
250 		u32 obj_id;
251 	} crypto;
252 	u32 flags;
253 	struct mlx5_fs_vlan vlan[MLX5_FS_VLAN_DEPTH];
254 	struct ib_counters *counters;
255 	struct mlx5_flow_group *fg;
256 	struct mlx5_exe_aso exe_aso;
257 };
258 
259 #define MLX5_DECLARE_FLOW_ACT(name) \
260 	struct mlx5_flow_act name = { .action = MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
261 				      .flags =  0, }
262 
263 /* Single destination per rule.
264  * Group ID is implied by the match criteria.
265  */
266 struct mlx5_flow_handle *
267 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
268 		    const struct mlx5_flow_spec *spec,
269 		    struct mlx5_flow_act *flow_act,
270 		    struct mlx5_flow_destination *dest,
271 		    int num_dest);
272 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
273 
274 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
275 				 struct mlx5_flow_destination *new_dest,
276 				 struct mlx5_flow_destination *old_dest);
277 
278 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
279 
280 /* As mlx5_fc_create() but doesn't queue stats refresh thread. */
281 struct mlx5_fc *mlx5_fc_create_ex(struct mlx5_core_dev *dev, bool aging);
282 
283 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
284 u64 mlx5_fc_query_lastuse(struct mlx5_fc *counter);
285 void mlx5_fc_query_cached(struct mlx5_fc *counter,
286 			  u64 *bytes, u64 *packets, u64 *lastuse);
287 int mlx5_fc_query(struct mlx5_core_dev *dev, struct mlx5_fc *counter,
288 		  u64 *packets, u64 *bytes);
289 u32 mlx5_fc_id(struct mlx5_fc *counter);
290 
291 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
292 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
293 
294 struct mlx5_modify_hdr *mlx5_modify_header_alloc(struct mlx5_core_dev *dev,
295 						 u8 ns_type, u8 num_actions,
296 						 void *modify_actions);
297 void mlx5_modify_header_dealloc(struct mlx5_core_dev *dev,
298 				struct mlx5_modify_hdr *modify_hdr);
299 struct mlx5_flow_definer *
300 mlx5_create_match_definer(struct mlx5_core_dev *dev,
301 			  enum mlx5_flow_namespace_type ns_type, u16 format_id,
302 			  u32 *match_mask);
303 void mlx5_destroy_match_definer(struct mlx5_core_dev *dev,
304 				struct mlx5_flow_definer *definer);
305 int mlx5_get_match_definer_id(struct mlx5_flow_definer *definer);
306 
307 struct mlx5_pkt_reformat_params {
308 	int type;
309 	u8 param_0;
310 	u8 param_1;
311 	size_t size;
312 	void *data;
313 };
314 
315 struct mlx5_pkt_reformat *mlx5_packet_reformat_alloc(struct mlx5_core_dev *dev,
316 						     struct mlx5_pkt_reformat_params *params,
317 						     enum mlx5_flow_namespace_type ns_type);
318 void mlx5_packet_reformat_dealloc(struct mlx5_core_dev *dev,
319 				  struct mlx5_pkt_reformat *reformat);
320 
321 u32 mlx5_flow_table_id(struct mlx5_flow_table *ft);
322 #endif
323