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         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 list_head list;
 115
 116         /* last{packets,bytes} members are used when calculating the delta since
 117          * last reading
 118          */
 119         u64 lastpackets;
 120         u64 lastbytes;
 121
 122         u16 id;
 123         bool deleted;
 124         bool aging;
 125
 126         struct mlx5_fc_cache cache ____cacheline_aligned_in_smp;
 127 };
 128
 129 /* Type of children is mlx5_flow_rule */
 130 struct fs_fte {
 131         struct fs_node                  node;
 132         u32                             val[MLX5_ST_SZ_DW(fte_match_param)];
 133         u32                             dests_size;
 134         u32                             flow_tag;
 135         u32                             index;
 136         u32                             action;
 137         enum fs_fte_status              status;
 138         struct mlx5_fc                  *counter;
 139 };
 140
 141 /* Type of children is mlx5_flow_table/namespace */
 142 struct fs_prio {
 143         struct fs_node                  node;
 144         unsigned int                    num_levels;
 145         unsigned int                    start_level;
 146         unsigned int                    prio;
 147         unsigned int                    num_ft;
 148 };
 149
 150 /* Type of children is fs_prio */
 151 struct mlx5_flow_namespace {
 152         /* parent == NULL => root ns */
 153         struct  fs_node                 node;
 154 };
 155
 156 struct mlx5_flow_group_mask {
 157         u8      match_criteria_enable;
 158         u32     match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
 159 };
 160
 161 /* Type of children is fs_fte */
 162 struct mlx5_flow_group {
 163         struct fs_node                  node;
 164         struct mlx5_flow_group_mask     mask;
 165         u32                             start_index;
 166         u32                             max_ftes;
 167         u32                             num_ftes;
 168         u32                             id;
 169 };
 170
 171 struct mlx5_flow_root_namespace {
 172         struct mlx5_flow_namespace      ns;
 173         enum   fs_flow_table_type       table_type;
 174         struct mlx5_core_dev            *dev;
 175         struct mlx5_flow_table          *root_ft;
 176         /* Should be held when chaining flow tables */
 177         struct mutex                    chain_lock;
 178 };
 179
 180 int mlx5_init_fc_stats(struct mlx5_core_dev *dev);
 181 void mlx5_cleanup_fc_stats(struct mlx5_core_dev *dev);
 182
 183 int mlx5_init_fs(struct mlx5_core_dev *dev);
 184 void mlx5_cleanup_fs(struct mlx5_core_dev *dev);
 185
 186 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
 187
 188 #define fs_list_for_each_entry(pos, root)               \
 189         list_for_each_entry(pos, root, node.list)
 190
 191 #define fs_list_for_each_entry_safe(pos, tmp, root)             \
 192         list_for_each_entry_safe(pos, tmp, root, node.list)
 193
 194 #define fs_for_each_ns_or_ft_reverse(pos, prio)                         \
 195         list_for_each_entry_reverse(pos, &(prio)->node.children, list)
 196
 197 #define fs_for_each_ns_or_ft(pos, prio)                                 \
 198         list_for_each_entry(pos, (&(prio)->node.children), list)
 199
 200 #define fs_for_each_prio(pos, ns)                       \
 201         fs_list_for_each_entry(pos, &(ns)->node.children)
 202
 203 #define fs_for_each_ns(pos, prio)                       \
 204         fs_list_for_each_entry(pos, &(prio)->node.children)
 205
 206 #define fs_for_each_ft(pos, prio)                       \
 207         fs_list_for_each_entry(pos, &(prio)->node.children)
 208
 209 #define fs_for_each_ft_safe(pos, tmp, prio)                     \
 210         fs_list_for_each_entry_safe(pos, tmp, &(prio)->node.children)
 211
 212 #define fs_for_each_fg(pos, ft)                 \
 213         fs_list_for_each_entry(pos, &(ft)->node.children)
 214
 215 #define fs_for_each_fte(pos, fg)                        \
 216         fs_list_for_each_entry(pos, &(fg)->node.children)
 217
 218 #define fs_for_each_dst(pos, fte)                       \
 219         fs_list_for_each_entry(pos, &(fte)->node.children)
 220
 221 #endif