drivers/net/mlx5/mlx5_flow.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2018 Mellanox Technologies, Ltd
   3  */
   4
   5 #ifndef RTE_PMD_MLX5_FLOW_H_
   6 #define RTE_PMD_MLX5_FLOW_H_
   7
   8 #include <netinet/in.h>
   9 #include <sys/queue.h>
  10 #include <stdalign.h>
  11 #include <stdint.h>
  12 #include <string.h>
  13
  14 /* Verbs header. */
  15 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  16 #ifdef PEDANTIC
  17 #pragma GCC diagnostic ignored "-Wpedantic"
  18 #endif
  19 #include <infiniband/verbs.h>
  20 #ifdef PEDANTIC
  21 #pragma GCC diagnostic error "-Wpedantic"
  22 #endif
  23
  24 /* Pattern outer Layer bits. */
  25 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
  26 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
  27 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
  28 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
  29 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
  30 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
  31
  32 /* Pattern inner Layer bits. */
  33 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
  34 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
  35 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
  36 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
  37 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
  38 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
  39
  40 /* Pattern tunnel Layer bits. */
  41 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
  42 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
  43 #define MLX5_FLOW_LAYER_GRE (1u << 14)
  44 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
  45
  46 /* Outer Masks. */
  47 #define MLX5_FLOW_LAYER_OUTER_L3 \
  48         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
  49 #define MLX5_FLOW_LAYER_OUTER_L4 \
  50         (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
  51 #define MLX5_FLOW_LAYER_OUTER \
  52         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
  53          MLX5_FLOW_LAYER_OUTER_L4)
  54
  55 /* Tunnel Masks. */
  56 #define MLX5_FLOW_LAYER_TUNNEL \
  57         (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
  58          MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_MPLS)
  59
  60 /* Inner Masks. */
  61 #define MLX5_FLOW_LAYER_INNER_L3 \
  62         (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
  63 #define MLX5_FLOW_LAYER_INNER_L4 \
  64         (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
  65 #define MLX5_FLOW_LAYER_INNER \
  66         (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
  67          MLX5_FLOW_LAYER_INNER_L4)
  68
  69 /* Actions */
  70 #define MLX5_FLOW_ACTION_DROP (1u << 0)
  71 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
  72 #define MLX5_FLOW_ACTION_RSS (1u << 2)
  73 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
  74 #define MLX5_FLOW_ACTION_MARK (1u << 4)
  75 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
  76
  77 #define MLX5_FLOW_FATE_ACTIONS \
  78         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | MLX5_FLOW_ACTION_RSS)
  79
  80 #ifndef IPPROTO_MPLS
  81 #define IPPROTO_MPLS 137
  82 #endif
  83
  84 /* UDP port numbers for VxLAN. */
  85 #define MLX5_UDP_PORT_VXLAN 4789
  86 #define MLX5_UDP_PORT_VXLAN_GPE 4790
  87
  88 /* Priority reserved for default flows. */
  89 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
  90
  91 /*
  92  * Number of sub priorities.
  93  * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
  94  * matching on the NIC (firmware dependent) L4 most have the higher priority
  95  * followed by L3 and ending with L2.
  96  */
  97 #define MLX5_PRIORITY_MAP_L2 2
  98 #define MLX5_PRIORITY_MAP_L3 1
  99 #define MLX5_PRIORITY_MAP_L4 0
 100 #define MLX5_PRIORITY_MAP_MAX 3
 101
 102 /* Valid layer type for IPV4 RSS. */
 103 #define MLX5_IPV4_LAYER_TYPES \
 104         (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
 105          ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
 106          ETH_RSS_NONFRAG_IPV4_OTHER)
 107
 108 /* IBV hash source bits  for IPV4. */
 109 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
 110
 111 /* Valid layer type for IPV6 RSS. */
 112 #define MLX5_IPV6_LAYER_TYPES \
 113         (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
 114          ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX  | ETH_RSS_IPV6_TCP_EX | \
 115          ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
 116
 117 /* IBV hash source bits  for IPV6. */
 118 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
 119
 120 /* Max number of actions per DV flow. */
 121 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
 122
 123 /* Matcher PRM representation */
 124 struct mlx5_flow_dv_match_params {
 125         size_t size;
 126         /**< Size of match value. Do NOT split size and key! */
 127         uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
 128         /**< Matcher value. This value is used as the mask or as a key. */
 129 };
 130
 131 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
 132
 133 /* Matcher structure. */
 134 struct mlx5_flow_dv_matcher {
 135         LIST_ENTRY(mlx5_flow_dv_matcher) next;
 136         /* Pointer to the next element. */
 137         rte_atomic32_t refcnt; /**< Reference counter. */
 138         void *matcher_object; /**< Pointer to DV matcher */
 139         uint16_t crc; /**< CRC of key. */
 140         uint16_t priority; /**< Priority of matcher. */
 141         uint8_t egress; /**< Egress matcher. */
 142         struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
 143 };
 144
 145 /* DV flows structure. */
 146 struct mlx5_flow_dv {
 147         uint64_t hash_fields; /**< Fields that participate in the hash. */
 148         struct mlx5_hrxq *hrxq; /**< Hash Rx queues. */
 149         /* Flow DV api: */
 150         struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
 151         struct mlx5_flow_dv_match_params value;
 152         /**< Holds the value that the packet is compared to. */
 153         struct ibv_flow *flow; /**< Installed flow. */
 154 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 155         struct mlx5dv_flow_action_attr actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS];
 156         /**< Action list. */
 157 #endif
 158         int actions_n; /**< number of actions. */
 159 };
 160
 161 /* Verbs specification header. */
 162 struct ibv_spec_header {
 163         enum ibv_flow_spec_type type;
 164         uint16_t size;
 165 };
 166
 167 /** Handles information leading to a drop fate. */
 168 struct mlx5_flow_verbs {
 169         LIST_ENTRY(mlx5_flow_verbs) next;
 170         unsigned int size; /**< Size of the attribute. */
 171         struct {
 172                 struct ibv_flow_attr *attr;
 173                 /**< Pointer to the Specification buffer. */
 174                 uint8_t *specs; /**< Pointer to the specifications. */
 175         };
 176         struct ibv_flow *flow; /**< Verbs flow pointer. */
 177         struct mlx5_hrxq *hrxq; /**< Hash Rx queue object. */
 178         uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
 179 };
 180
 181 /** Device flow structure. */
 182 struct mlx5_flow {
 183         LIST_ENTRY(mlx5_flow) next;
 184         struct rte_flow *flow; /**< Pointer to the main flow. */
 185         uint32_t layers; /**< Bit-fields that holds the detected layers. */
 186         union {
 187 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 188                 struct mlx5_flow_dv dv;
 189 #endif
 190                 struct mlx5_flow_verbs verbs;
 191         };
 192 };
 193
 194 /* Counters information. */
 195 struct mlx5_flow_counter {
 196         LIST_ENTRY(mlx5_flow_counter) next; /**< Pointer to the next counter. */
 197         uint32_t shared:1; /**< Share counter ID with other flow rules. */
 198         uint32_t ref_cnt:31; /**< Reference counter. */
 199         uint32_t id; /**< Counter ID. */
 200         struct ibv_counter_set *cs; /**< Holds the counters for the rule. */
 201         uint64_t hits; /**< Number of packets matched by the rule. */
 202         uint64_t bytes; /**< Number of bytes matched by the rule. */
 203 };
 204
 205 /* Flow structure. */
 206 struct rte_flow {
 207         TAILQ_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */
 208         struct rte_flow_attr attributes; /**< User flow attribute. */
 209         uint32_t layers;
 210         /**< Bit-fields of present layers see MLX5_FLOW_LAYER_*. */
 211         struct mlx5_flow_counter *counter; /**< Holds flow counter. */
 212         struct rte_flow_action_rss rss;/**< RSS context. */
 213         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
 214         uint16_t (*queue)[]; /**< Destination queues to redirect traffic to. */
 215         void *nl_flow; /**< Netlink flow buffer if relevant. */
 216         LIST_HEAD(dev_flows, mlx5_flow) dev_flows;
 217         /**< Device flows that are part of the flow. */
 218         uint32_t actions; /**< Bit-fields which mark all detected actions. */
 219 };
 220 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
 221                                     const struct rte_flow_attr *attr,
 222                                     const struct rte_flow_item items[],
 223                                     const struct rte_flow_action actions[],
 224                                     struct rte_flow_error *error);
 225 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
 226         (const struct rte_flow_attr *attr, const struct rte_flow_item items[],
 227          const struct rte_flow_action actions[], uint64_t *item_flags,
 228          uint64_t *action_flags, struct rte_flow_error *error);
 229 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
 230                                      struct mlx5_flow *dev_flow,
 231                                      const struct rte_flow_attr *attr,
 232                                      const struct rte_flow_item items[],
 233                                      const struct rte_flow_action actions[],
 234                                      struct rte_flow_error *error);
 235 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
 236                                  struct rte_flow_error *error);
 237 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
 238                                    struct rte_flow *flow);
 239 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
 240                                     struct rte_flow *flow);
 241 struct mlx5_flow_driver_ops {
 242         mlx5_flow_validate_t validate;
 243         mlx5_flow_prepare_t prepare;
 244         mlx5_flow_translate_t translate;
 245         mlx5_flow_apply_t apply;
 246         mlx5_flow_remove_t remove;
 247         mlx5_flow_destroy_t destroy;
 248 };
 249
 250 /* mlx5_flow.c */
 251
 252 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow *dev_flow, int tunnel,
 253                                      uint32_t layer_types,
 254                                      uint64_t hash_fields);
 255 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
 256                                    uint32_t subpriority);
 257 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
 258                                     struct rte_flow_error *error);
 259 int mlx5_flow_validate_action_drop(uint64_t action_flags,
 260                                    struct rte_flow_error *error);
 261 int mlx5_flow_validate_action_flag(uint64_t action_flags,
 262                                    struct rte_flow_error *error);
 263 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
 264                                    uint64_t action_flags,
 265                                    struct rte_flow_error *error);
 266 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
 267                                     uint64_t action_flags,
 268                                     struct rte_eth_dev *dev,
 269                                     struct rte_flow_error *error);
 270 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
 271                                   uint64_t action_flags,
 272                                   struct rte_eth_dev *dev,
 273                                   struct rte_flow_error *error);
 274 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
 275                                   const struct rte_flow_attr *attributes,
 276                                   struct rte_flow_error *error);
 277 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
 278                                 uint64_t item_flags,
 279                                 struct rte_flow_error *error);
 280 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
 281                                 uint64_t item_flags,
 282                                 uint8_t target_protocol,
 283                                 struct rte_flow_error *error);
 284 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
 285                                  int64_t item_flags,
 286                                  struct rte_flow_error *error);
 287 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
 288                                  uint64_t item_flags,
 289                                  struct rte_flow_error *error);
 290 int mlx5_flow_validate_item_mpls(const struct rte_flow_item *item,
 291                                  uint64_t item_flags,
 292                                  uint8_t target_protocol,
 293                                  struct rte_flow_error *error);
 294 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
 295                                 uint64_t item_flags,
 296                                 uint8_t target_protocol,
 297                                 struct rte_flow_error *error);
 298 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
 299                                 uint64_t item_flags,
 300                                 uint8_t target_protocol,
 301                                 struct rte_flow_error *error);
 302 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
 303                                  int64_t item_flags,
 304                                  struct rte_flow_error *error);
 305 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
 306                                   uint64_t item_flags,
 307                                   struct rte_flow_error *error);
 308 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
 309                                       uint64_t item_flags,
 310                                       struct rte_eth_dev *dev,
 311                                       struct rte_flow_error *error);
 312 void mlx5_flow_init_driver_ops(struct rte_eth_dev *dev);
 313
 314 /* mlx5_flow_dv.c */
 315 void mlx5_flow_dv_get_driver_ops(struct mlx5_flow_driver_ops *flow_ops);
 316
 317 /* mlx5_flow_verbs.c */
 318
 319 void mlx5_flow_verbs_get_driver_ops(struct mlx5_flow_driver_ops *flow_ops);
 320
 321 #endif /* RTE_PMD_MLX5_FLOW_H_ */