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