xref: /linux/drivers/net/ethernet/mellanox/mlx5/core/fs_core.h (revision 3fd6c59042dbba50391e30862beac979491145fe)
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_CORE_
34 #define _MLX5_FS_CORE_
35 
36 #include <linux/refcount.h>
37 #include <linux/mlx5/fs.h>
38 #include <linux/rhashtable.h>
39 #include <linux/llist.h>
40 #include <steering/sws/fs_dr.h>
41 
42 #define FDB_TC_MAX_CHAIN 3
43 #define FDB_FT_CHAIN (FDB_TC_MAX_CHAIN + 1)
44 #define FDB_TC_SLOW_PATH_CHAIN (FDB_FT_CHAIN + 1)
45 
46 /* The index of the last real chain (FT) + 1 as chain zero is valid as well */
47 #define FDB_NUM_CHAINS (FDB_FT_CHAIN + 1)
48 
49 #define FDB_TC_MAX_PRIO 16
50 #define FDB_TC_LEVELS_PER_PRIO 2
51 
52 struct mlx5_flow_definer {
53 	enum mlx5_flow_namespace_type ns_type;
54 	u32 id;
55 };
56 
57 enum mlx5_flow_resource_owner {
58 	MLX5_FLOW_RESOURCE_OWNER_FW,
59 	MLX5_FLOW_RESOURCE_OWNER_SW,
60 };
61 
62 struct mlx5_modify_hdr {
63 	enum mlx5_flow_namespace_type ns_type;
64 	enum mlx5_flow_resource_owner owner;
65 	union {
66 		struct mlx5_fs_dr_action fs_dr_action;
67 		u32 id;
68 	};
69 };
70 
71 struct mlx5_pkt_reformat {
72 	enum mlx5_flow_namespace_type ns_type;
73 	int reformat_type; /* from mlx5_ifc */
74 	enum mlx5_flow_resource_owner owner;
75 	union {
76 		struct mlx5_fs_dr_action fs_dr_action;
77 		u32 id;
78 	};
79 };
80 
81 /* FS_TYPE_PRIO_CHAINS is a PRIO that will have namespaces only,
82  * and those are in parallel to one another when going over them to connect
83  * a new flow table. Meaning the last flow table in a TYPE_PRIO prio in one
84  * parallel namespace will not automatically connect to the first flow table
85  * found in any prio in any next namespace, but skip the entire containing
86  * TYPE_PRIO_CHAINS prio.
87  *
88  * This is used to implement tc chains, each chain of prios is a different
89  * namespace inside a containing TYPE_PRIO_CHAINS prio.
90  */
91 
92 enum fs_node_type {
93 	FS_TYPE_NAMESPACE,
94 	FS_TYPE_PRIO,
95 	FS_TYPE_PRIO_CHAINS,
96 	FS_TYPE_FLOW_TABLE,
97 	FS_TYPE_FLOW_GROUP,
98 	FS_TYPE_FLOW_ENTRY,
99 	FS_TYPE_FLOW_DEST
100 };
101 
102 enum fs_flow_table_type {
103 	FS_FT_NIC_RX          = 0x0,
104 	FS_FT_NIC_TX          = 0x1,
105 	FS_FT_ESW_EGRESS_ACL  = 0x2,
106 	FS_FT_ESW_INGRESS_ACL = 0x3,
107 	FS_FT_FDB             = 0X4,
108 	FS_FT_SNIFFER_RX	= 0X5,
109 	FS_FT_SNIFFER_TX	= 0X6,
110 	FS_FT_RDMA_RX		= 0X7,
111 	FS_FT_RDMA_TX		= 0X8,
112 	FS_FT_PORT_SEL		= 0X9,
113 	FS_FT_FDB_RX		= 0xa,
114 	FS_FT_FDB_TX		= 0xb,
115 	FS_FT_MAX_TYPE = FS_FT_FDB_TX,
116 };
117 
118 enum fs_flow_table_op_mod {
119 	FS_FT_OP_MOD_NORMAL,
120 	FS_FT_OP_MOD_LAG_DEMUX,
121 };
122 
123 enum fs_fte_status {
124 	FS_FTE_STATUS_EXISTING = 1UL << 0,
125 };
126 
127 enum mlx5_flow_steering_mode {
128 	MLX5_FLOW_STEERING_MODE_DMFS,
129 	MLX5_FLOW_STEERING_MODE_SMFS
130 };
131 
132 enum mlx5_flow_steering_capabilty {
133 	MLX5_FLOW_STEERING_CAP_VLAN_PUSH_ON_RX = 1UL << 0,
134 	MLX5_FLOW_STEERING_CAP_VLAN_POP_ON_TX = 1UL << 1,
135 	MLX5_FLOW_STEERING_CAP_MATCH_RANGES = 1UL << 2,
136 	MLX5_FLOW_STEERING_CAP_DUPLICATE_MATCH = 1UL << 3,
137 };
138 
139 struct mlx5_flow_steering {
140 	struct mlx5_core_dev *dev;
141 	enum   mlx5_flow_steering_mode	mode;
142 	struct kmem_cache		*fgs_cache;
143 	struct kmem_cache               *ftes_cache;
144 	struct mlx5_flow_root_namespace *root_ns;
145 	struct mlx5_flow_root_namespace *fdb_root_ns;
146 	struct mlx5_flow_namespace	**fdb_sub_ns;
147 	struct mlx5_flow_root_namespace **esw_egress_root_ns;
148 	struct mlx5_flow_root_namespace **esw_ingress_root_ns;
149 	struct mlx5_flow_root_namespace	*sniffer_tx_root_ns;
150 	struct mlx5_flow_root_namespace	*sniffer_rx_root_ns;
151 	struct mlx5_flow_root_namespace	*rdma_rx_root_ns;
152 	struct mlx5_flow_root_namespace	*rdma_tx_root_ns;
153 	struct mlx5_flow_root_namespace	*egress_root_ns;
154 	struct mlx5_flow_root_namespace	*port_sel_root_ns;
155 	int esw_egress_acl_vports;
156 	int esw_ingress_acl_vports;
157 };
158 
159 struct fs_node {
160 	struct list_head	list;
161 	struct list_head	children;
162 	enum fs_node_type	type;
163 	struct fs_node		*parent;
164 	struct fs_node		*root;
165 	/* lock the node for writing and traversing */
166 	struct rw_semaphore	lock;
167 	refcount_t		refcount;
168 	bool			active;
169 	void			(*del_hw_func)(struct fs_node *);
170 	void			(*del_sw_func)(struct fs_node *);
171 	atomic_t		version;
172 };
173 
174 struct mlx5_flow_rule {
175 	struct fs_node				node;
176 	struct mlx5_flow_table			*ft;
177 	struct mlx5_flow_destination		dest_attr;
178 	/* next_ft should be accessed under chain_lock and only of
179 	 * destination type is FWD_NEXT_fT.
180 	 */
181 	struct list_head			next_ft;
182 	u32					sw_action;
183 };
184 
185 struct mlx5_flow_handle {
186 	int num_rules;
187 	struct mlx5_flow_rule *rule[] __counted_by(num_rules);
188 };
189 
190 /* Type of children is mlx5_flow_group */
191 struct mlx5_flow_table {
192 	struct fs_node			node;
193 	struct mlx5_fs_dr_table		fs_dr_table;
194 	u32				id;
195 	u16				vport;
196 	unsigned int			max_fte;
197 	unsigned int			level;
198 	enum fs_flow_table_type		type;
199 	enum fs_flow_table_op_mod	op_mod;
200 	struct {
201 		bool			active;
202 		unsigned int		required_groups;
203 		unsigned int		group_size;
204 		unsigned int		num_groups;
205 		unsigned int		max_fte;
206 	} autogroup;
207 	/* Protect fwd_rules */
208 	struct mutex			lock;
209 	/* FWD rules that point on this flow table */
210 	struct list_head		fwd_rules;
211 	u32				flags;
212 	struct rhltable			fgs_hash;
213 	enum mlx5_flow_table_miss_action def_miss_action;
214 	struct mlx5_flow_namespace	*ns;
215 };
216 
217 struct mlx5_ft_underlay_qp {
218 	struct list_head list;
219 	u32 qpn;
220 };
221 
222 #define MLX5_FTE_MATCH_PARAM_RESERVED	reserved_at_e00
223 /* Calculate the fte_match_param length and without the reserved length.
224  * Make sure the reserved field is the last.
225  */
226 #define MLX5_ST_SZ_DW_MATCH_PARAM					    \
227 	((MLX5_BYTE_OFF(fte_match_param, MLX5_FTE_MATCH_PARAM_RESERVED) / sizeof(u32)) + \
228 	 BUILD_BUG_ON_ZERO(MLX5_ST_SZ_BYTES(fte_match_param) !=		     \
229 			   MLX5_FLD_SZ_BYTES(fte_match_param,		     \
230 					     MLX5_FTE_MATCH_PARAM_RESERVED) +\
231 			   MLX5_BYTE_OFF(fte_match_param,		     \
232 					 MLX5_FTE_MATCH_PARAM_RESERVED)))
233 
234 struct fs_fte_action {
235 	int				modify_mask;
236 	u32				dests_size;
237 	u32				fwd_dests;
238 	struct mlx5_flow_context	flow_context;
239 	struct mlx5_flow_act		action;
240 };
241 
242 struct fs_fte_dup {
243 	struct list_head children;
244 	struct fs_fte_action act_dests;
245 };
246 
247 /* Type of children is mlx5_flow_rule */
248 struct fs_fte {
249 	struct fs_node			node;
250 	struct mlx5_fs_dr_rule		fs_dr_rule;
251 	u32				val[MLX5_ST_SZ_DW_MATCH_PARAM];
252 	struct fs_fte_action		act_dests;
253 	struct fs_fte_dup		*dup;
254 	u32				index;
255 	enum fs_fte_status		status;
256 	struct rhash_head		hash;
257 };
258 
259 /* Type of children is mlx5_flow_table/namespace */
260 struct fs_prio {
261 	struct fs_node			node;
262 	unsigned int			num_levels;
263 	unsigned int			start_level;
264 	unsigned int			prio;
265 	unsigned int			num_ft;
266 };
267 
268 /* Type of children is fs_prio */
269 struct mlx5_flow_namespace {
270 	/* parent == NULL => root ns */
271 	struct	fs_node			node;
272 	enum mlx5_flow_table_miss_action def_miss_action;
273 };
274 
275 struct mlx5_flow_group_mask {
276 	u8	match_criteria_enable;
277 	u32	match_criteria[MLX5_ST_SZ_DW_MATCH_PARAM];
278 };
279 
280 /* Type of children is fs_fte */
281 struct mlx5_flow_group {
282 	struct fs_node			node;
283 	struct mlx5_fs_dr_matcher	fs_dr_matcher;
284 	struct mlx5_flow_group_mask	mask;
285 	u32				start_index;
286 	u32				max_ftes;
287 	struct ida			fte_allocator;
288 	u32				id;
289 	struct rhashtable		ftes_hash;
290 	struct rhlist_head		hash;
291 };
292 
293 struct mlx5_flow_root_namespace {
294 	struct mlx5_flow_namespace	ns;
295 	enum   mlx5_flow_steering_mode	mode;
296 	struct mlx5_fs_dr_domain	fs_dr_domain;
297 	enum   fs_flow_table_type	table_type;
298 	struct mlx5_core_dev		*dev;
299 	struct mlx5_flow_table		*root_ft;
300 	/* Should be held when chaining flow tables */
301 	struct mutex			chain_lock;
302 	struct list_head		underlay_qpns;
303 	const struct mlx5_flow_cmds	*cmds;
304 };
305 
306 int mlx5_init_fc_stats(struct mlx5_core_dev *dev);
307 void mlx5_cleanup_fc_stats(struct mlx5_core_dev *dev);
308 void mlx5_fc_queue_stats_work(struct mlx5_core_dev *dev,
309 			      struct delayed_work *dwork,
310 			      unsigned long delay);
311 void mlx5_fc_update_sampling_interval(struct mlx5_core_dev *dev,
312 				      unsigned long interval);
313 
314 const struct mlx5_flow_cmds *mlx5_fs_cmd_get_fw_cmds(void);
315 
316 int mlx5_flow_namespace_set_peer(struct mlx5_flow_root_namespace *ns,
317 				 struct mlx5_flow_root_namespace *peer_ns,
318 				 u16 peer_vhca_id);
319 
320 int mlx5_flow_namespace_set_mode(struct mlx5_flow_namespace *ns,
321 				 enum mlx5_flow_steering_mode mode);
322 
323 int mlx5_fs_core_alloc(struct mlx5_core_dev *dev);
324 void mlx5_fs_core_free(struct mlx5_core_dev *dev);
325 int mlx5_fs_core_init(struct mlx5_core_dev *dev);
326 void mlx5_fs_core_cleanup(struct mlx5_core_dev *dev);
327 
328 int mlx5_fs_egress_acls_init(struct mlx5_core_dev *dev, int total_vports);
329 void mlx5_fs_egress_acls_cleanup(struct mlx5_core_dev *dev);
330 int mlx5_fs_ingress_acls_init(struct mlx5_core_dev *dev, int total_vports);
331 void mlx5_fs_ingress_acls_cleanup(struct mlx5_core_dev *dev);
332 
333 u32 mlx5_fs_get_capabilities(struct mlx5_core_dev *dev, enum mlx5_flow_namespace_type type);
334 
335 struct mlx5_flow_root_namespace *find_root(struct fs_node *node);
336 
337 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
338 
339 #define fs_list_for_each_entry(pos, root)		\
340 	list_for_each_entry(pos, root, node.list)
341 
342 #define fs_list_for_each_entry_safe(pos, tmp, root)		\
343 	list_for_each_entry_safe(pos, tmp, root, node.list)
344 
345 #define fs_for_each_ns_or_ft_reverse(pos, prio)				\
346 	list_for_each_entry_reverse(pos, &(prio)->node.children, list)
347 
348 #define fs_for_each_ns_or_ft(pos, prio)					\
349 	list_for_each_entry(pos, (&(prio)->node.children), list)
350 
351 #define fs_for_each_prio(pos, ns)			\
352 	fs_list_for_each_entry(pos, &(ns)->node.children)
353 
354 #define fs_for_each_ns(pos, prio)			\
355 	fs_list_for_each_entry(pos, &(prio)->node.children)
356 
357 #define fs_for_each_ft(pos, prio)			\
358 	fs_list_for_each_entry(pos, &(prio)->node.children)
359 
360 #define fs_for_each_ft_safe(pos, tmp, prio)			\
361 	fs_list_for_each_entry_safe(pos, tmp, &(prio)->node.children)
362 
363 #define fs_for_each_fg(pos, ft)			\
364 	fs_list_for_each_entry(pos, &(ft)->node.children)
365 
366 #define fs_for_each_fte(pos, fg)			\
367 	fs_list_for_each_entry(pos, &(fg)->node.children)
368 
369 #define fs_for_each_dst(pos, fte)			\
370 	fs_list_for_each_entry(pos, &(fte)->node.children)
371 
372 #define MLX5_CAP_FLOWTABLE_TYPE(mdev, cap, type) (		\
373 	(type == FS_FT_NIC_RX) ? MLX5_CAP_FLOWTABLE_NIC_RX(mdev, cap) :		\
374 	(type == FS_FT_NIC_TX) ? MLX5_CAP_FLOWTABLE_NIC_TX(mdev, cap) :		\
375 	(type == FS_FT_ESW_EGRESS_ACL) ? MLX5_CAP_ESW_EGRESS_ACL(mdev, cap) :		\
376 	(type == FS_FT_ESW_INGRESS_ACL) ? MLX5_CAP_ESW_INGRESS_ACL(mdev, cap) :		\
377 	(type == FS_FT_FDB) ? MLX5_CAP_ESW_FLOWTABLE_FDB(mdev, cap) :		\
378 	(type == FS_FT_SNIFFER_RX) ? MLX5_CAP_FLOWTABLE_SNIFFER_RX(mdev, cap) :		\
379 	(type == FS_FT_SNIFFER_TX) ? MLX5_CAP_FLOWTABLE_SNIFFER_TX(mdev, cap) :		\
380 	(type == FS_FT_RDMA_RX) ? MLX5_CAP_FLOWTABLE_RDMA_RX(mdev, cap) :		\
381 	(type == FS_FT_RDMA_TX) ? MLX5_CAP_FLOWTABLE_RDMA_TX(mdev, cap) :      \
382 	(type == FS_FT_PORT_SEL) ? MLX5_CAP_FLOWTABLE_PORT_SELECTION(mdev, cap) :      \
383 	(type == FS_FT_FDB_RX) ? MLX5_CAP_ESW_FLOWTABLE_FDB(mdev, cap) :      \
384 	(type == FS_FT_FDB_TX) ? MLX5_CAP_ESW_FLOWTABLE_FDB(mdev, cap) :      \
385 	(BUILD_BUG_ON_ZERO(FS_FT_FDB_TX != FS_FT_MAX_TYPE))\
386 	)
387 
388 #endif
389