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