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