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 /* General pattern items bits. */
  47 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
  48
  49 /* Outer Masks. */
  50 #define MLX5_FLOW_LAYER_OUTER_L3 \
  51         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
  52 #define MLX5_FLOW_LAYER_OUTER_L4 \
  53         (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
  54 #define MLX5_FLOW_LAYER_OUTER \
  55         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
  56          MLX5_FLOW_LAYER_OUTER_L4)
  57
  58 /* Tunnel Masks. */
  59 #define MLX5_FLOW_LAYER_TUNNEL \
  60         (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
  61          MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_MPLS)
  62
  63 /* Inner Masks. */
  64 #define MLX5_FLOW_LAYER_INNER_L3 \
  65         (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
  66 #define MLX5_FLOW_LAYER_INNER_L4 \
  67         (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
  68 #define MLX5_FLOW_LAYER_INNER \
  69         (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
  70          MLX5_FLOW_LAYER_INNER_L4)
  71
  72 /* Actions */
  73 #define MLX5_FLOW_ACTION_DROP (1u << 0)
  74 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
  75 #define MLX5_FLOW_ACTION_RSS (1u << 2)
  76 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
  77 #define MLX5_FLOW_ACTION_MARK (1u << 4)
  78 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
  79 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
  80 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
  81 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
  82 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
  83 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
  84 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
  85 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
  86 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
  87 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
  88 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
  89 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
  90 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
  91 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
  92 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
  93 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
  94 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
  95 #define MLX5_FLOW_ACTION_VXLAN_ENCAP (1u << 22)
  96
  97 #define MLX5_FLOW_FATE_ACTIONS \
  98         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | MLX5_FLOW_ACTION_RSS)
  99
 100 #ifndef IPPROTO_MPLS
 101 #define IPPROTO_MPLS 137
 102 #endif
 103
 104 /* UDP port numbers for VxLAN. */
 105 #define MLX5_UDP_PORT_VXLAN 4789
 106 #define MLX5_UDP_PORT_VXLAN_GPE 4790
 107
 108 /* Priority reserved for default flows. */
 109 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
 110
 111 /*
 112  * Number of sub priorities.
 113  * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
 114  * matching on the NIC (firmware dependent) L4 most have the higher priority
 115  * followed by L3 and ending with L2.
 116  */
 117 #define MLX5_PRIORITY_MAP_L2 2
 118 #define MLX5_PRIORITY_MAP_L3 1
 119 #define MLX5_PRIORITY_MAP_L4 0
 120 #define MLX5_PRIORITY_MAP_MAX 3
 121
 122 /* Valid layer type for IPV4 RSS. */
 123 #define MLX5_IPV4_LAYER_TYPES \
 124         (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
 125          ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
 126          ETH_RSS_NONFRAG_IPV4_OTHER)
 127
 128 /* IBV hash source bits  for IPV4. */
 129 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
 130
 131 /* Valid layer type for IPV6 RSS. */
 132 #define MLX5_IPV6_LAYER_TYPES \
 133         (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
 134          ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX  | ETH_RSS_IPV6_TCP_EX | \
 135          ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
 136
 137 /* IBV hash source bits  for IPV6. */
 138 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
 139
 140 /* Max number of actions per DV flow. */
 141 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
 142
 143 enum mlx5_flow_drv_type {
 144         MLX5_FLOW_TYPE_MIN,
 145         MLX5_FLOW_TYPE_DV,
 146         MLX5_FLOW_TYPE_TCF,
 147         MLX5_FLOW_TYPE_VERBS,
 148         MLX5_FLOW_TYPE_MAX,
 149 };
 150
 151 /* Matcher PRM representation */
 152 struct mlx5_flow_dv_match_params {
 153         size_t size;
 154         /**< Size of match value. Do NOT split size and key! */
 155         uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
 156         /**< Matcher value. This value is used as the mask or as a key. */
 157 };
 158
 159 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
 160
 161 /* Matcher structure. */
 162 struct mlx5_flow_dv_matcher {
 163         LIST_ENTRY(mlx5_flow_dv_matcher) next;
 164         /* Pointer to the next element. */
 165         rte_atomic32_t refcnt; /**< Reference counter. */
 166         void *matcher_object; /**< Pointer to DV matcher */
 167         uint16_t crc; /**< CRC of key. */
 168         uint16_t priority; /**< Priority of matcher. */
 169         uint8_t egress; /**< Egress matcher. */
 170         struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
 171 };
 172
 173 /* DV flows structure. */
 174 struct mlx5_flow_dv {
 175         uint64_t hash_fields; /**< Fields that participate in the hash. */
 176         struct mlx5_hrxq *hrxq; /**< Hash Rx queues. */
 177         /* Flow DV api: */
 178         struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
 179         struct mlx5_flow_dv_match_params value;
 180         /**< Holds the value that the packet is compared to. */
 181         struct ibv_flow *flow; /**< Installed flow. */
 182 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 183         struct mlx5dv_flow_action_attr actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS];
 184         /**< Action list. */
 185         struct ibv_flow_action *encap_decap_verbs_action;
 186         /**< Verbs encap/decap object. */
 187 #endif
 188         int actions_n; /**< number of actions. */
 189 };
 190
 191 /** Linux TC flower driver for E-Switch flow. */
 192 struct mlx5_flow_tcf {
 193         struct nlmsghdr *nlh;
 194         struct tcmsg *tcm;
 195 };
 196
 197 /* Verbs specification header. */
 198 struct ibv_spec_header {
 199         enum ibv_flow_spec_type type;
 200         uint16_t size;
 201 };
 202
 203 /** Handles information leading to a drop fate. */
 204 struct mlx5_flow_verbs {
 205         LIST_ENTRY(mlx5_flow_verbs) next;
 206         unsigned int size; /**< Size of the attribute. */
 207         struct {
 208                 struct ibv_flow_attr *attr;
 209                 /**< Pointer to the Specification buffer. */
 210                 uint8_t *specs; /**< Pointer to the specifications. */
 211         };
 212         struct ibv_flow *flow; /**< Verbs flow pointer. */
 213         struct mlx5_hrxq *hrxq; /**< Hash Rx queue object. */
 214         uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
 215 };
 216
 217 /** Device flow structure. */
 218 struct mlx5_flow {
 219         LIST_ENTRY(mlx5_flow) next;
 220         struct rte_flow *flow; /**< Pointer to the main flow. */
 221         uint64_t layers;
 222         /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
 223         union {
 224 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 225                 struct mlx5_flow_dv dv;
 226 #endif
 227                 struct mlx5_flow_tcf tcf;
 228                 struct mlx5_flow_verbs verbs;
 229         };
 230 };
 231
 232 /* Counters information. */
 233 struct mlx5_flow_counter {
 234         LIST_ENTRY(mlx5_flow_counter) next; /**< Pointer to the next counter. */
 235         uint32_t shared:1; /**< Share counter ID with other flow rules. */
 236         uint32_t ref_cnt:31; /**< Reference counter. */
 237         uint32_t id; /**< Counter ID. */
 238 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42)
 239         struct ibv_counter_set *cs; /**< Holds the counters for the rule. */
 240 #elif defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
 241         struct ibv_counters *cs; /**< Holds the counters for the rule. */
 242 #endif
 243         uint64_t hits; /**< Number of packets matched by the rule. */
 244         uint64_t bytes; /**< Number of bytes matched by the rule. */
 245 };
 246
 247 /* Flow structure. */
 248 struct rte_flow {
 249         TAILQ_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */
 250         enum mlx5_flow_drv_type drv_type; /**< Drvier type. */
 251         struct mlx5_flow_counter *counter; /**< Holds flow counter. */
 252         struct rte_flow_action_rss rss;/**< RSS context. */
 253         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
 254         uint16_t (*queue)[]; /**< Destination queues to redirect traffic to. */
 255         LIST_HEAD(dev_flows, mlx5_flow) dev_flows;
 256         /**< Device flows that are part of the flow. */
 257         uint64_t actions;
 258         /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
 259         struct mlx5_fdir *fdir; /**< Pointer to associated FDIR if any. */
 260 };
 261
 262 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
 263                                     const struct rte_flow_attr *attr,
 264                                     const struct rte_flow_item items[],
 265                                     const struct rte_flow_action actions[],
 266                                     struct rte_flow_error *error);
 267 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
 268         (const struct rte_flow_attr *attr, const struct rte_flow_item items[],
 269          const struct rte_flow_action actions[], uint64_t *item_flags,
 270          uint64_t *action_flags, struct rte_flow_error *error);
 271 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
 272                                      struct mlx5_flow *dev_flow,
 273                                      const struct rte_flow_attr *attr,
 274                                      const struct rte_flow_item items[],
 275                                      const struct rte_flow_action actions[],
 276                                      struct rte_flow_error *error);
 277 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
 278                                  struct rte_flow_error *error);
 279 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
 280                                    struct rte_flow *flow);
 281 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
 282                                     struct rte_flow *flow);
 283 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
 284                                  struct rte_flow *flow,
 285                                  const struct rte_flow_action *actions,
 286                                  void *data,
 287                                  struct rte_flow_error *error);
 288 struct mlx5_flow_driver_ops {
 289         mlx5_flow_validate_t validate;
 290         mlx5_flow_prepare_t prepare;
 291         mlx5_flow_translate_t translate;
 292         mlx5_flow_apply_t apply;
 293         mlx5_flow_remove_t remove;
 294         mlx5_flow_destroy_t destroy;
 295         mlx5_flow_query_t query;
 296 };
 297
 298 /* mlx5_flow.c */
 299
 300 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow *dev_flow, int tunnel,
 301                                      uint64_t layer_types,
 302                                      uint64_t hash_fields);
 303 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
 304                                    uint32_t subpriority);
 305 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
 306                                     const struct rte_flow_attr *attr,
 307                                     struct rte_flow_error *error);
 308 int mlx5_flow_validate_action_drop(uint64_t action_flags,
 309                                    const struct rte_flow_attr *attr,
 310                                    struct rte_flow_error *error);
 311 int mlx5_flow_validate_action_flag(uint64_t action_flags,
 312                                    const struct rte_flow_attr *attr,
 313                                    struct rte_flow_error *error);
 314 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
 315                                    uint64_t action_flags,
 316                                    const struct rte_flow_attr *attr,
 317                                    struct rte_flow_error *error);
 318 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
 319                                     uint64_t action_flags,
 320                                     struct rte_eth_dev *dev,
 321                                     const struct rte_flow_attr *attr,
 322                                     struct rte_flow_error *error);
 323 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
 324                                   uint64_t action_flags,
 325                                   struct rte_eth_dev *dev,
 326                                   const struct rte_flow_attr *attr,
 327                                   struct rte_flow_error *error);
 328 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
 329                                   const struct rte_flow_attr *attributes,
 330                                   struct rte_flow_error *error);
 331 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
 332                               const uint8_t *mask,
 333                               const uint8_t *nic_mask,
 334                               unsigned int size,
 335                               struct rte_flow_error *error);
 336 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
 337                                 uint64_t item_flags,
 338                                 struct rte_flow_error *error);
 339 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
 340                                 uint64_t item_flags,
 341                                 uint8_t target_protocol,
 342                                 struct rte_flow_error *error);
 343 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
 344                                  uint64_t item_flags,
 345                                  struct rte_flow_error *error);
 346 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
 347                                  uint64_t item_flags,
 348                                  struct rte_flow_error *error);
 349 int mlx5_flow_validate_item_mpls(const struct rte_flow_item *item,
 350                                  uint64_t item_flags,
 351                                  uint8_t target_protocol,
 352                                  struct rte_flow_error *error);
 353 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
 354                                 uint64_t item_flags,
 355                                 uint8_t target_protocol,
 356                                 const struct rte_flow_item_tcp *flow_mask,
 357                                 struct rte_flow_error *error);
 358 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
 359                                 uint64_t item_flags,
 360                                 uint8_t target_protocol,
 361                                 struct rte_flow_error *error);
 362 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
 363                                  uint64_t item_flags,
 364                                  struct rte_flow_error *error);
 365 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
 366                                   uint64_t item_flags,
 367                                   struct rte_flow_error *error);
 368 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
 369                                       uint64_t item_flags,
 370                                       struct rte_eth_dev *dev,
 371                                       struct rte_flow_error *error);
 372
 373 /* mlx5_flow_tcf.c */
 374
 375 int mlx5_flow_tcf_init(struct mlx5_flow_tcf_context *ctx,
 376                        unsigned int ifindex, struct rte_flow_error *error);
 377 struct mlx5_flow_tcf_context *mlx5_flow_tcf_context_create(void);
 378 void mlx5_flow_tcf_context_destroy(struct mlx5_flow_tcf_context *ctx);
 379
 380 #endif /* RTE_PMD_MLX5_FLOW_H_ */