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