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