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