xref: /linux-6.15/include/linux/mlx5/fs.h (revision 4a8d2879)
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
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_CRYPTO_INGRESS,
113 	FDB_TC_OFFLOAD,
114 	FDB_FT_OFFLOAD,
115 	FDB_TC_MISS,
116 	FDB_BR_OFFLOAD,
117 	FDB_SLOW_PATH,
118 	FDB_CRYPTO_EGRESS,
119 	FDB_PER_VPORT,
120 };
121 
122 struct mlx5_pkt_reformat;
123 struct mlx5_modify_hdr;
124 struct mlx5_flow_definer;
125 struct mlx5_flow_table;
126 struct mlx5_flow_group;
127 struct mlx5_flow_namespace;
128 struct mlx5_flow_handle;
129 
130 enum {
131 	FLOW_CONTEXT_HAS_TAG = BIT(0),
132 };
133 
134 struct mlx5_flow_context {
135 	u32 flags;
136 	u32 flow_tag;
137 	u32 flow_source;
138 };
139 
140 struct mlx5_flow_spec {
141 	u8   match_criteria_enable;
142 	u32  match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
143 	u32  match_value[MLX5_ST_SZ_DW(fte_match_param)];
144 	struct mlx5_flow_context flow_context;
145 };
146 
147 enum {
148 	MLX5_FLOW_DEST_VPORT_VHCA_ID      = BIT(0),
149 	MLX5_FLOW_DEST_VPORT_REFORMAT_ID  = BIT(1),
150 };
151 
152 enum mlx5_flow_dest_range_field {
153 	MLX5_FLOW_DEST_RANGE_FIELD_PKT_LEN = 0,
154 };
155 
156 struct mlx5_flow_destination {
157 	enum mlx5_flow_destination_type	type;
158 	union {
159 		u32			tir_num;
160 		u32			ft_num;
161 		struct mlx5_flow_table	*ft;
162 		u32			counter_id;
163 		struct {
164 			u16		num;
165 			u16		vhca_id;
166 			struct mlx5_pkt_reformat *pkt_reformat;
167 			u8		flags;
168 		} vport;
169 		struct {
170 			struct mlx5_flow_table         *hit_ft;
171 			struct mlx5_flow_table         *miss_ft;
172 			enum mlx5_flow_dest_range_field field;
173 			u32                             min;
174 			u32                             max;
175 		} range;
176 		u32			sampler_id;
177 	};
178 };
179 
180 struct mod_hdr_tbl {
181 	struct mutex lock; /* protects hlist */
182 	DECLARE_HASHTABLE(hlist, 8);
183 };
184 
185 struct mlx5_flow_namespace *
186 mlx5_get_fdb_sub_ns(struct mlx5_core_dev *dev, int n);
187 struct mlx5_flow_namespace *
188 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
189 			enum mlx5_flow_namespace_type type);
190 struct mlx5_flow_namespace *
191 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
192 				  enum mlx5_flow_namespace_type type,
193 				  int vport);
194 
195 struct mlx5_flow_table_attr {
196 	int prio;
197 	int max_fte;
198 	u32 level;
199 	u32 flags;
200 	u16 uid;
201 	struct mlx5_flow_table *next_ft;
202 
203 	struct {
204 		int max_num_groups;
205 		int num_reserved_entries;
206 	} autogroup;
207 };
208 
209 struct mlx5_flow_table *
210 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
211 		       struct mlx5_flow_table_attr *ft_attr);
212 
213 struct mlx5_flow_table *
214 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
215 				    struct mlx5_flow_table_attr *ft_attr);
216 
217 struct mlx5_flow_table *
218 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
219 			     struct mlx5_flow_table_attr *ft_attr, u16 vport);
220 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
221 					       struct mlx5_flow_namespace *ns,
222 					       int prio, u32 level);
223 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
224 
225 /* inbox should be set with the following values:
226  * start_flow_index
227  * end_flow_index
228  * match_criteria_enable
229  * match_criteria
230  */
231 struct mlx5_flow_group *
232 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
233 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
234 
235 struct mlx5_exe_aso {
236 	u32 object_id;
237 	u8 type;
238 	u8 return_reg_id;
239 	union {
240 		u32 ctrl_data;
241 		struct {
242 			u8 meter_idx;
243 			u8 init_color;
244 		} flow_meter;
245 	};
246 };
247 
248 struct mlx5_fs_vlan {
249         u16 ethtype;
250         u16 vid;
251         u8  prio;
252 };
253 
254 #define MLX5_FS_VLAN_DEPTH	2
255 
256 enum {
257 	FLOW_ACT_NO_APPEND = BIT(0),
258 	FLOW_ACT_IGNORE_FLOW_LEVEL = BIT(1),
259 };
260 
261 struct mlx5_flow_act {
262 	u32 action;
263 	struct mlx5_modify_hdr  *modify_hdr;
264 	struct mlx5_pkt_reformat *pkt_reformat;
265 	struct mlx5_flow_act_crypto_params {
266 		u8 type;
267 		u32 obj_id;
268 	} crypto;
269 	u32 flags;
270 	struct mlx5_fs_vlan vlan[MLX5_FS_VLAN_DEPTH];
271 	struct ib_counters *counters;
272 	struct mlx5_flow_group *fg;
273 	struct mlx5_exe_aso exe_aso;
274 };
275 
276 #define MLX5_DECLARE_FLOW_ACT(name) \
277 	struct mlx5_flow_act name = { .action = MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
278 				      .flags =  0, }
279 
280 /* Single destination per rule.
281  * Group ID is implied by the match criteria.
282  */
283 struct mlx5_flow_handle *
284 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
285 		    const struct mlx5_flow_spec *spec,
286 		    struct mlx5_flow_act *flow_act,
287 		    struct mlx5_flow_destination *dest,
288 		    int num_dest);
289 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
290 
291 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
292 				 struct mlx5_flow_destination *new_dest,
293 				 struct mlx5_flow_destination *old_dest);
294 
295 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
296 
297 /* As mlx5_fc_create() but doesn't queue stats refresh thread. */
298 struct mlx5_fc *mlx5_fc_create_ex(struct mlx5_core_dev *dev, bool aging);
299 
300 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
301 u64 mlx5_fc_query_lastuse(struct mlx5_fc *counter);
302 void mlx5_fc_query_cached(struct mlx5_fc *counter,
303 			  u64 *bytes, u64 *packets, u64 *lastuse);
304 void mlx5_fc_query_cached_raw(struct mlx5_fc *counter,
305 			      u64 *bytes, u64 *packets, u64 *lastuse);
306 int mlx5_fc_query(struct mlx5_core_dev *dev, struct mlx5_fc *counter,
307 		  u64 *packets, u64 *bytes);
308 u32 mlx5_fc_id(struct mlx5_fc *counter);
309 
310 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
311 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
312 
313 struct mlx5_modify_hdr *mlx5_modify_header_alloc(struct mlx5_core_dev *dev,
314 						 u8 ns_type, u8 num_actions,
315 						 void *modify_actions);
316 void mlx5_modify_header_dealloc(struct mlx5_core_dev *dev,
317 				struct mlx5_modify_hdr *modify_hdr);
318 struct mlx5_flow_definer *
319 mlx5_create_match_definer(struct mlx5_core_dev *dev,
320 			  enum mlx5_flow_namespace_type ns_type, u16 format_id,
321 			  u32 *match_mask);
322 void mlx5_destroy_match_definer(struct mlx5_core_dev *dev,
323 				struct mlx5_flow_definer *definer);
324 int mlx5_get_match_definer_id(struct mlx5_flow_definer *definer);
325 
326 struct mlx5_pkt_reformat_params {
327 	int type;
328 	u8 param_0;
329 	u8 param_1;
330 	size_t size;
331 	void *data;
332 };
333 
334 struct mlx5_pkt_reformat *mlx5_packet_reformat_alloc(struct mlx5_core_dev *dev,
335 						     struct mlx5_pkt_reformat_params *params,
336 						     enum mlx5_flow_namespace_type ns_type);
337 void mlx5_packet_reformat_dealloc(struct mlx5_core_dev *dev,
338 				  struct mlx5_pkt_reformat *reformat);
339 
340 u32 mlx5_flow_table_id(struct mlx5_flow_table *ft);
341 #endif
342