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 
41 /* FS_TYPE_PRIO_CHAINS is a PRIO that will have namespaces only,
42  * and those are in parallel to one another when going over them to connect
43  * a new flow table. Meaning the last flow table in a TYPE_PRIO prio in one
44  * parallel namespace will not automatically connect to the first flow table
45  * found in any prio in any next namespace, but skip the entire containing
46  * TYPE_PRIO_CHAINS prio.
47  *
48  * This is used to implement tc chains, each chain of prios is a different
49  * namespace inside a containing TYPE_PRIO_CHAINS prio.
50  */
51 
52 enum fs_node_type {
53 	FS_TYPE_NAMESPACE,
54 	FS_TYPE_PRIO,
55 	FS_TYPE_PRIO_CHAINS,
56 	FS_TYPE_FLOW_TABLE,
57 	FS_TYPE_FLOW_GROUP,
58 	FS_TYPE_FLOW_ENTRY,
59 	FS_TYPE_FLOW_DEST
60 };
61 
62 enum fs_flow_table_type {
63 	FS_FT_NIC_RX          = 0x0,
64 	FS_FT_NIC_TX          = 0x1,
65 	FS_FT_ESW_EGRESS_ACL  = 0x2,
66 	FS_FT_ESW_INGRESS_ACL = 0x3,
67 	FS_FT_FDB             = 0X4,
68 	FS_FT_SNIFFER_RX	= 0X5,
69 	FS_FT_SNIFFER_TX	= 0X6,
70 	FS_FT_RDMA_RX		= 0X7,
71 	FS_FT_MAX_TYPE = FS_FT_SNIFFER_TX,
72 };
73 
74 enum fs_flow_table_op_mod {
75 	FS_FT_OP_MOD_NORMAL,
76 	FS_FT_OP_MOD_LAG_DEMUX,
77 };
78 
79 enum fs_fte_status {
80 	FS_FTE_STATUS_EXISTING = 1UL << 0,
81 };
82 
83 struct mlx5_flow_steering {
84 	struct mlx5_core_dev *dev;
85 	struct kmem_cache               *fgs_cache;
86 	struct kmem_cache               *ftes_cache;
87 	struct mlx5_flow_root_namespace *root_ns;
88 	struct mlx5_flow_root_namespace *fdb_root_ns;
89 	struct mlx5_flow_namespace	**fdb_sub_ns;
90 	struct mlx5_flow_root_namespace **esw_egress_root_ns;
91 	struct mlx5_flow_root_namespace **esw_ingress_root_ns;
92 	struct mlx5_flow_root_namespace	*sniffer_tx_root_ns;
93 	struct mlx5_flow_root_namespace	*sniffer_rx_root_ns;
94 	struct mlx5_flow_root_namespace	*rdma_rx_root_ns;
95 	struct mlx5_flow_root_namespace	*egress_root_ns;
96 };
97 
98 struct fs_node {
99 	struct list_head	list;
100 	struct list_head	children;
101 	enum fs_node_type	type;
102 	struct fs_node		*parent;
103 	struct fs_node		*root;
104 	/* lock the node for writing and traversing */
105 	struct rw_semaphore	lock;
106 	refcount_t		refcount;
107 	bool			active;
108 	void			(*del_hw_func)(struct fs_node *);
109 	void			(*del_sw_func)(struct fs_node *);
110 	atomic_t		version;
111 };
112 
113 struct mlx5_flow_rule {
114 	struct fs_node				node;
115 	struct mlx5_flow_destination		dest_attr;
116 	/* next_ft should be accessed under chain_lock and only of
117 	 * destination type is FWD_NEXT_fT.
118 	 */
119 	struct list_head			next_ft;
120 	u32					sw_action;
121 };
122 
123 struct mlx5_flow_handle {
124 	int num_rules;
125 	struct mlx5_flow_rule *rule[];
126 };
127 
128 /* Type of children is mlx5_flow_group */
129 struct mlx5_flow_table {
130 	struct fs_node			node;
131 	u32				id;
132 	u16				vport;
133 	unsigned int			max_fte;
134 	unsigned int			level;
135 	enum fs_flow_table_type		type;
136 	enum fs_flow_table_op_mod	op_mod;
137 	struct {
138 		bool			active;
139 		unsigned int		required_groups;
140 		unsigned int		num_groups;
141 	} autogroup;
142 	/* Protect fwd_rules */
143 	struct mutex			lock;
144 	/* FWD rules that point on this flow table */
145 	struct list_head		fwd_rules;
146 	u32				flags;
147 	struct rhltable			fgs_hash;
148 };
149 
150 struct mlx5_ft_underlay_qp {
151 	struct list_head list;
152 	u32 qpn;
153 };
154 
155 #define MLX5_FTE_MATCH_PARAM_RESERVED	reserved_at_a00
156 /* Calculate the fte_match_param length and without the reserved length.
157  * Make sure the reserved field is the last.
158  */
159 #define MLX5_ST_SZ_DW_MATCH_PARAM					    \
160 	((MLX5_BYTE_OFF(fte_match_param, MLX5_FTE_MATCH_PARAM_RESERVED) / sizeof(u32)) + \
161 	 BUILD_BUG_ON_ZERO(MLX5_ST_SZ_BYTES(fte_match_param) !=		     \
162 			   MLX5_FLD_SZ_BYTES(fte_match_param,		     \
163 					     MLX5_FTE_MATCH_PARAM_RESERVED) +\
164 			   MLX5_BYTE_OFF(fte_match_param,		     \
165 					 MLX5_FTE_MATCH_PARAM_RESERVED)))
166 
167 /* Type of children is mlx5_flow_rule */
168 struct fs_fte {
169 	struct fs_node			node;
170 	u32				val[MLX5_ST_SZ_DW_MATCH_PARAM];
171 	u32				dests_size;
172 	u32				index;
173 	struct mlx5_flow_act		action;
174 	enum fs_fte_status		status;
175 	struct mlx5_fc			*counter;
176 	struct rhash_head		hash;
177 	int				modify_mask;
178 };
179 
180 /* Type of children is mlx5_flow_table/namespace */
181 struct fs_prio {
182 	struct fs_node			node;
183 	unsigned int			num_levels;
184 	unsigned int			start_level;
185 	unsigned int			prio;
186 	unsigned int			num_ft;
187 };
188 
189 /* Type of children is fs_prio */
190 struct mlx5_flow_namespace {
191 	/* parent == NULL => root ns */
192 	struct	fs_node			node;
193 };
194 
195 struct mlx5_flow_group_mask {
196 	u8	match_criteria_enable;
197 	u32	match_criteria[MLX5_ST_SZ_DW_MATCH_PARAM];
198 };
199 
200 /* Type of children is fs_fte */
201 struct mlx5_flow_group {
202 	struct fs_node			node;
203 	struct mlx5_flow_group_mask	mask;
204 	u32				start_index;
205 	u32				max_ftes;
206 	struct ida			fte_allocator;
207 	u32				id;
208 	struct rhashtable		ftes_hash;
209 	struct rhlist_head		hash;
210 };
211 
212 struct mlx5_flow_root_namespace {
213 	struct mlx5_flow_namespace	ns;
214 	enum   fs_flow_table_type	table_type;
215 	struct mlx5_core_dev		*dev;
216 	struct mlx5_flow_table		*root_ft;
217 	/* Should be held when chaining flow tables */
218 	struct mutex			chain_lock;
219 	struct list_head		underlay_qpns;
220 	const struct mlx5_flow_cmds	*cmds;
221 	enum mlx5_flow_table_miss_action def_miss_action;
222 };
223 
224 int mlx5_init_fc_stats(struct mlx5_core_dev *dev);
225 void mlx5_cleanup_fc_stats(struct mlx5_core_dev *dev);
226 void mlx5_fc_queue_stats_work(struct mlx5_core_dev *dev,
227 			      struct delayed_work *dwork,
228 			      unsigned long delay);
229 void mlx5_fc_update_sampling_interval(struct mlx5_core_dev *dev,
230 				      unsigned long interval);
231 
232 int mlx5_init_fs(struct mlx5_core_dev *dev);
233 void mlx5_cleanup_fs(struct mlx5_core_dev *dev);
234 
235 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
236 
237 #define fs_list_for_each_entry(pos, root)		\
238 	list_for_each_entry(pos, root, node.list)
239 
240 #define fs_list_for_each_entry_safe(pos, tmp, root)		\
241 	list_for_each_entry_safe(pos, tmp, root, node.list)
242 
243 #define fs_for_each_ns_or_ft_reverse(pos, prio)				\
244 	list_for_each_entry_reverse(pos, &(prio)->node.children, list)
245 
246 #define fs_for_each_ns_or_ft(pos, prio)					\
247 	list_for_each_entry(pos, (&(prio)->node.children), list)
248 
249 #define fs_for_each_prio(pos, ns)			\
250 	fs_list_for_each_entry(pos, &(ns)->node.children)
251 
252 #define fs_for_each_ns(pos, prio)			\
253 	fs_list_for_each_entry(pos, &(prio)->node.children)
254 
255 #define fs_for_each_ft(pos, prio)			\
256 	fs_list_for_each_entry(pos, &(prio)->node.children)
257 
258 #define fs_for_each_ft_safe(pos, tmp, prio)			\
259 	fs_list_for_each_entry_safe(pos, tmp, &(prio)->node.children)
260 
261 #define fs_for_each_fg(pos, ft)			\
262 	fs_list_for_each_entry(pos, &(ft)->node.children)
263 
264 #define fs_for_each_fte(pos, fg)			\
265 	fs_list_for_each_entry(pos, &(fg)->node.children)
266 
267 #define fs_for_each_dst(pos, fte)			\
268 	fs_list_for_each_entry(pos, &(fte)->node.children)
269 
270 #define MLX5_CAP_FLOWTABLE_TYPE(mdev, cap, type) (		\
271 	(type == FS_FT_NIC_RX) ? MLX5_CAP_FLOWTABLE_NIC_RX(mdev, cap) :		\
272 	(type == FS_FT_ESW_EGRESS_ACL) ? MLX5_CAP_ESW_EGRESS_ACL(mdev, cap) :		\
273 	(type == FS_FT_ESW_INGRESS_ACL) ? MLX5_CAP_ESW_INGRESS_ACL(mdev, cap) :		\
274 	(type == FS_FT_FDB) ? MLX5_CAP_ESW_FLOWTABLE_FDB(mdev, cap) :		\
275 	(type == FS_FT_SNIFFER_RX) ? MLX5_CAP_FLOWTABLE_SNIFFER_RX(mdev, cap) :		\
276 	(type == FS_FT_SNIFFER_TX) ? MLX5_CAP_FLOWTABLE_SNIFFER_TX(mdev, cap) :		\
277 	(BUILD_BUG_ON_ZERO(FS_FT_SNIFFER_TX != FS_FT_MAX_TYPE))\
278 	)
279 
280 #endif
281