net/mlx5_core: Add flow steering lookup algorithms
[cascardo/linux.git] / drivers / net / ethernet / mellanox / mlx5 / core / fs_core.h
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 };
50
51 enum fs_fte_status {
52         FS_FTE_STATUS_EXISTING = 1UL << 0,
53 };
54
55 struct fs_node {
56         struct list_head        list;
57         struct list_head        children;
58         enum fs_node_type       type;
59         struct fs_node          *parent;
60         struct fs_node          *root;
61         /* lock the node for writing and traversing */
62         struct mutex            lock;
63         atomic_t                refcount;
64         void                    (*remove_func)(struct fs_node *);
65 };
66
67 struct mlx5_flow_rule {
68         struct fs_node                          node;
69         struct mlx5_flow_destination            dest_attr;
70 };
71
72 struct mlx5_flow_table {
73         struct fs_node                  node;
74         u32                             id;
75         unsigned int                    level;
76         enum fs_flow_table_type         type;
77 };
78
79 struct fs_fte {
80         struct fs_node                  node;
81         u32                             val[MLX5_ST_SZ_DW(fte_match_param)];
82         u32                             dests_size;
83         u32                             flow_tag;
84         u32                             index;
85         u32                             action;
86 };
87
88 struct fs_prio {
89         struct fs_node                  node;
90         unsigned int                    max_ft;
91         unsigned int                    start_level;
92         unsigned int                    prio;
93 };
94
95 struct mlx5_flow_namespace {
96         /* parent == NULL => root ns */
97         struct  fs_node                 node;
98 };
99
100 struct mlx5_flow_group_mask {
101         u8      match_criteria_enable;
102         u32     match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
103 };
104
105 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
106
107 #define fs_list_for_each_entry(pos, root)               \
108         list_for_each_entry(pos, root, node.list)
109
110 #define fs_for_each_ns_or_ft_reverse(pos, prio)                         \
111         list_for_each_entry_reverse(pos, &(prio)->node.children, list)
112
113 #define fs_for_each_ns_or_ft(pos, prio)                                 \
114         list_for_each_entry(pos, (&(prio)->node.children), list)
115
116 #define fs_for_each_prio(pos, ns)                       \
117         fs_list_for_each_entry(pos, &(ns)->node.children)
118
119 #define fs_for_each_fg(pos, ft)                 \
120         fs_list_for_each_entry(pos, &(ft)->node.children)
121
122 #define fs_for_each_fte(pos, fg)                        \
123         fs_list_for_each_entry(pos, &(fg)->node.children)
124
125 #define fs_for_each_dst(pos, fte)                       \
126         fs_list_for_each_entry(pos, &(fte)->node.children)
127
128 #endif