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