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