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