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