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/mlx5/fs.h>
37 
38 enum fs_node_type {
39 	FS_TYPE_NAMESPACE,
40 	FS_TYPE_PRIO,
41 	FS_TYPE_FLOW_TABLE,
42 	FS_TYPE_FLOW_GROUP,
43 	FS_TYPE_FLOW_ENTRY,
44 	FS_TYPE_FLOW_DEST
45 };
46 
47 enum fs_flow_table_type {
48 	FS_FT_NIC_RX          = 0x0,
49 	FS_FT_ESW_EGRESS_ACL  = 0x2,
50 	FS_FT_ESW_INGRESS_ACL = 0x3,
51 	FS_FT_FDB             = 0X4,
52 };
53 
54 enum fs_fte_status {
55 	FS_FTE_STATUS_EXISTING = 1UL << 0,
56 };
57 
58 struct mlx5_flow_steering {
59 	struct mlx5_core_dev *dev;
60 	struct mlx5_flow_root_namespace *root_ns;
61 	struct mlx5_flow_root_namespace *fdb_root_ns;
62 	struct mlx5_flow_root_namespace *esw_egress_root_ns;
63 	struct mlx5_flow_root_namespace *esw_ingress_root_ns;
64 };
65 
66 struct fs_node {
67 	struct list_head	list;
68 	struct list_head	children;
69 	enum fs_node_type	type;
70 	struct fs_node		*parent;
71 	struct fs_node		*root;
72 	/* lock the node for writing and traversing */
73 	struct mutex		lock;
74 	atomic_t		refcount;
75 	void			(*remove_func)(struct fs_node *);
76 };
77 
78 struct mlx5_flow_rule {
79 	struct fs_node				node;
80 	struct mlx5_flow_destination		dest_attr;
81 	/* next_ft should be accessed under chain_lock and only of
82 	 * destination type is FWD_NEXT_fT.
83 	 */
84 	struct list_head			next_ft;
85 	u32					sw_action;
86 };
87 
88 /* Type of children is mlx5_flow_group */
89 struct mlx5_flow_table {
90 	struct fs_node			node;
91 	u32				id;
92 	u16				vport;
93 	unsigned int			max_fte;
94 	unsigned int			level;
95 	enum fs_flow_table_type		type;
96 	struct {
97 		bool			active;
98 		unsigned int		required_groups;
99 		unsigned int		num_groups;
100 	} autogroup;
101 	/* Protect fwd_rules */
102 	struct mutex			lock;
103 	/* FWD rules that point on this flow table */
104 	struct list_head		fwd_rules;
105 };
106 
107 struct mlx5_fc_cache {
108 	u64 packets;
109 	u64 bytes;
110 	u64 lastuse;
111 };
112 
113 struct mlx5_fc {
114 	struct rb_node node;
115 	struct list_head list;
116 
117 	/* last{packets,bytes} members are used when calculating the delta since
118 	 * last reading
119 	 */
120 	u64 lastpackets;
121 	u64 lastbytes;
122 
123 	u16 id;
124 	bool deleted;
125 	bool aging;
126 
127 	struct mlx5_fc_cache cache ____cacheline_aligned_in_smp;
128 };
129 
130 /* Type of children is mlx5_flow_rule */
131 struct fs_fte {
132 	struct fs_node			node;
133 	u32				val[MLX5_ST_SZ_DW(fte_match_param)];
134 	u32				dests_size;
135 	u32				flow_tag;
136 	u32				index;
137 	u32				action;
138 	enum fs_fte_status		status;
139 	struct mlx5_fc			*counter;
140 };
141 
142 /* Type of children is mlx5_flow_table/namespace */
143 struct fs_prio {
144 	struct fs_node			node;
145 	unsigned int			num_levels;
146 	unsigned int			start_level;
147 	unsigned int			prio;
148 	unsigned int			num_ft;
149 };
150 
151 /* Type of children is fs_prio */
152 struct mlx5_flow_namespace {
153 	/* parent == NULL => root ns */
154 	struct	fs_node			node;
155 };
156 
157 struct mlx5_flow_group_mask {
158 	u8	match_criteria_enable;
159 	u32	match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
160 };
161 
162 /* Type of children is fs_fte */
163 struct mlx5_flow_group {
164 	struct fs_node			node;
165 	struct mlx5_flow_group_mask	mask;
166 	u32				start_index;
167 	u32				max_ftes;
168 	u32				num_ftes;
169 	u32				id;
170 };
171 
172 struct mlx5_flow_root_namespace {
173 	struct mlx5_flow_namespace	ns;
174 	enum   fs_flow_table_type	table_type;
175 	struct mlx5_core_dev		*dev;
176 	struct mlx5_flow_table		*root_ft;
177 	/* Should be held when chaining flow tables */
178 	struct mutex			chain_lock;
179 };
180 
181 int mlx5_init_fc_stats(struct mlx5_core_dev *dev);
182 void mlx5_cleanup_fc_stats(struct mlx5_core_dev *dev);
183 
184 int mlx5_init_fs(struct mlx5_core_dev *dev);
185 void mlx5_cleanup_fs(struct mlx5_core_dev *dev);
186 
187 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
188 
189 #define fs_list_for_each_entry(pos, root)		\
190 	list_for_each_entry(pos, root, node.list)
191 
192 #define fs_list_for_each_entry_safe(pos, tmp, root)		\
193 	list_for_each_entry_safe(pos, tmp, root, node.list)
194 
195 #define fs_for_each_ns_or_ft_reverse(pos, prio)				\
196 	list_for_each_entry_reverse(pos, &(prio)->node.children, list)
197 
198 #define fs_for_each_ns_or_ft(pos, prio)					\
199 	list_for_each_entry(pos, (&(prio)->node.children), list)
200 
201 #define fs_for_each_prio(pos, ns)			\
202 	fs_list_for_each_entry(pos, &(ns)->node.children)
203 
204 #define fs_for_each_ns(pos, prio)			\
205 	fs_list_for_each_entry(pos, &(prio)->node.children)
206 
207 #define fs_for_each_ft(pos, prio)			\
208 	fs_list_for_each_entry(pos, &(prio)->node.children)
209 
210 #define fs_for_each_ft_safe(pos, tmp, prio)			\
211 	fs_list_for_each_entry_safe(pos, tmp, &(prio)->node.children)
212 
213 #define fs_for_each_fg(pos, ft)			\
214 	fs_list_for_each_entry(pos, &(ft)->node.children)
215 
216 #define fs_for_each_fte(pos, fg)			\
217 	fs_list_for_each_entry(pos, &(fg)->node.children)
218 
219 #define fs_for_each_dst(pos, fte)			\
220 	fs_list_for_each_entry(pos, &(fte)->node.children)
221 
222 #endif
223