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