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 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 /* Type of children is mlx5_flow_rule */
 100 struct fs_fte {
 101         struct fs_node                  node;
 102         u32                             val[MLX5_ST_SZ_DW(fte_match_param)];
 103         u32                             dests_size;
 104         u32                             flow_tag;
 105         u32                             index;
 106         u32                             action;
 107         enum fs_fte_status              status;
 108 };
 109
 110 /* Type of children is mlx5_flow_table/namespace */
 111 struct fs_prio {
 112         struct fs_node                  node;
 113         unsigned int                    num_levels;
 114         unsigned int                    start_level;
 115         unsigned int                    prio;
 116         unsigned int                    num_ft;
 117 };
 118
 119 /* Type of children is fs_prio */
 120 struct mlx5_flow_namespace {
 121         /* parent == NULL => root ns */
 122         struct  fs_node                 node;
 123 };
 124
 125 struct mlx5_flow_group_mask {
 126         u8      match_criteria_enable;
 127         u32     match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
 128 };
 129
 130 /* Type of children is fs_fte */
 131 struct mlx5_flow_group {
 132         struct fs_node                  node;
 133         struct mlx5_flow_group_mask     mask;
 134         u32                             start_index;
 135         u32                             max_ftes;
 136         u32                             num_ftes;
 137         u32                             id;
 138 };
 139
 140 struct mlx5_flow_root_namespace {
 141         struct mlx5_flow_namespace      ns;
 142         enum   fs_flow_table_type       table_type;
 143         struct mlx5_core_dev            *dev;
 144         struct mlx5_flow_table          *root_ft;
 145         /* Should be held when chaining flow tables */
 146         struct mutex                    chain_lock;
 147 };
 148
 149 int mlx5_init_fs(struct mlx5_core_dev *dev);
 150 void mlx5_cleanup_fs(struct mlx5_core_dev *dev);
 151
 152 #define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }
 153
 154 #define fs_list_for_each_entry(pos, root)               \
 155         list_for_each_entry(pos, root, node.list)
 156
 157 #define fs_list_for_each_entry_safe(pos, tmp, root)             \
 158         list_for_each_entry_safe(pos, tmp, root, node.list)
 159
 160 #define fs_for_each_ns_or_ft_reverse(pos, prio)                         \
 161         list_for_each_entry_reverse(pos, &(prio)->node.children, list)
 162
 163 #define fs_for_each_ns_or_ft(pos, prio)                                 \
 164         list_for_each_entry(pos, (&(prio)->node.children), list)
 165
 166 #define fs_for_each_prio(pos, ns)                       \
 167         fs_list_for_each_entry(pos, &(ns)->node.children)
 168
 169 #define fs_for_each_ns(pos, prio)                       \
 170         fs_list_for_each_entry(pos, &(prio)->node.children)
 171
 172 #define fs_for_each_ft(pos, prio)                       \
 173         fs_list_for_each_entry(pos, &(prio)->node.children)
 174
 175 #define fs_for_each_ft_safe(pos, tmp, prio)                     \
 176         fs_list_for_each_entry_safe(pos, tmp, &(prio)->node.children)
 177
 178 #define fs_for_each_fg(pos, ft)                 \
 179         fs_list_for_each_entry(pos, &(ft)->node.children)
 180
 181 #define fs_for_each_fte(pos, fg)                        \
 182         fs_list_for_each_entry(pos, &(fg)->node.children)
 183
 184 #define fs_for_each_dst(pos, fte)                       \
 185         fs_list_for_each_entry(pos, &(fte)->node.children)
 186
 187 #endif