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