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