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