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