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 #include <rte_alarm.h>
  15 #include <rte_mtr.h>
  16
  17 #include <mlx5_glue.h>
  18 #include <mlx5_prm.h>
  19
  20 #include "mlx5.h"
  21
  22 /* Private rte flow items. */
  23 enum mlx5_rte_flow_item_type {
  24         MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
  25         MLX5_RTE_FLOW_ITEM_TYPE_TAG,
  26         MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
  27         MLX5_RTE_FLOW_ITEM_TYPE_VLAN,
  28         MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL,
  29 };
  30
  31 /* Private (internal) rte flow actions. */
  32 enum mlx5_rte_flow_action_type {
  33         MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
  34         MLX5_RTE_FLOW_ACTION_TYPE_TAG,
  35         MLX5_RTE_FLOW_ACTION_TYPE_MARK,
  36         MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
  37         MLX5_RTE_FLOW_ACTION_TYPE_DEFAULT_MISS,
  38         MLX5_RTE_FLOW_ACTION_TYPE_SHARED_RSS,
  39         MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET,
  40 };
  41
  42 /* Matches on selected register. */
  43 struct mlx5_rte_flow_item_tag {
  44         enum modify_reg id;
  45         uint32_t data;
  46 };
  47
  48 /* Modify selected register. */
  49 struct mlx5_rte_flow_action_set_tag {
  50         enum modify_reg id;
  51         uint32_t data;
  52 };
  53
  54 struct mlx5_flow_action_copy_mreg {
  55         enum modify_reg dst;
  56         enum modify_reg src;
  57 };
  58
  59 /* Matches on source queue. */
  60 struct mlx5_rte_flow_item_tx_queue {
  61         uint32_t queue;
  62 };
  63
  64 /* Feature name to allocate metadata register. */
  65 enum mlx5_feature_name {
  66         MLX5_HAIRPIN_RX,
  67         MLX5_HAIRPIN_TX,
  68         MLX5_METADATA_RX,
  69         MLX5_METADATA_TX,
  70         MLX5_METADATA_FDB,
  71         MLX5_FLOW_MARK,
  72         MLX5_APP_TAG,
  73         MLX5_COPY_MARK,
  74         MLX5_MTR_COLOR,
  75         MLX5_MTR_SFX,
  76 };
  77
  78 /* Default queue number. */
  79 #define MLX5_RSSQ_DEFAULT_NUM 16
  80
  81 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
  82 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
  83 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
  84 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
  85 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
  86 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
  87
  88 /* Pattern inner Layer bits. */
  89 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
  90 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
  91 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
  92 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
  93 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
  94 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
  95
  96 /* Pattern tunnel Layer bits. */
  97 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
  98 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
  99 #define MLX5_FLOW_LAYER_GRE (1u << 14)
 100 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
 101 /* List of tunnel Layer bits continued below. */
 102
 103 /* General pattern items bits. */
 104 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
 105 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
 106 #define MLX5_FLOW_ITEM_TAG (1u << 18)
 107 #define MLX5_FLOW_ITEM_MARK (1u << 19)
 108
 109 /* Pattern MISC bits. */
 110 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
 111 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
 112 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
 113
 114 /* Pattern tunnel Layer bits (continued). */
 115 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
 116 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
 117 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
 118 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
 119
 120 /* Queue items. */
 121 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
 122
 123 /* Pattern tunnel Layer bits (continued). */
 124 #define MLX5_FLOW_LAYER_GTP (1u << 28)
 125
 126 /* Pattern eCPRI Layer bit. */
 127 #define MLX5_FLOW_LAYER_ECPRI (UINT64_C(1) << 29)
 128
 129 /* IPv6 Fragment Extension Header bit. */
 130 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6_FRAG_EXT (1u << 30)
 131 #define MLX5_FLOW_LAYER_INNER_L3_IPV6_FRAG_EXT (1u << 31)
 132
 133 /* Outer Masks. */
 134 #define MLX5_FLOW_LAYER_OUTER_L3 \
 135         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
 136 #define MLX5_FLOW_LAYER_OUTER_L4 \
 137         (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
 138 #define MLX5_FLOW_LAYER_OUTER \
 139         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
 140          MLX5_FLOW_LAYER_OUTER_L4)
 141
 142 /* Tunnel Masks. */
 143 #define MLX5_FLOW_LAYER_TUNNEL \
 144         (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
 145          MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
 146          MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
 147          MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
 148
 149 /* Inner Masks. */
 150 #define MLX5_FLOW_LAYER_INNER_L3 \
 151         (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
 152 #define MLX5_FLOW_LAYER_INNER_L4 \
 153         (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
 154 #define MLX5_FLOW_LAYER_INNER \
 155         (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
 156          MLX5_FLOW_LAYER_INNER_L4)
 157
 158 /* Layer Masks. */
 159 #define MLX5_FLOW_LAYER_L2 \
 160         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
 161 #define MLX5_FLOW_LAYER_L3_IPV4 \
 162         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
 163 #define MLX5_FLOW_LAYER_L3_IPV6 \
 164         (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
 165 #define MLX5_FLOW_LAYER_L3 \
 166         (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
 167 #define MLX5_FLOW_LAYER_L4 \
 168         (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
 169
 170 /* Actions */
 171 #define MLX5_FLOW_ACTION_DROP (1u << 0)
 172 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
 173 #define MLX5_FLOW_ACTION_RSS (1u << 2)
 174 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
 175 #define MLX5_FLOW_ACTION_MARK (1u << 4)
 176 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
 177 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
 178 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
 179 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
 180 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
 181 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
 182 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
 183 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
 184 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
 185 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
 186 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
 187 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
 188 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
 189 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
 190 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
 191 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
 192 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
 193 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
 194 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
 195 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
 196 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
 197 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
 198 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
 199 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
 200 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
 201 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
 202 #define MLX5_FLOW_ACTION_METER (1ull << 31)
 203 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
 204 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
 205 #define MLX5_FLOW_ACTION_AGE (1ull << 34)
 206 #define MLX5_FLOW_ACTION_DEFAULT_MISS (1ull << 35)
 207 #define MLX5_FLOW_ACTION_SAMPLE (1ull << 36)
 208 #define MLX5_FLOW_ACTION_TUNNEL_SET (1ull << 37)
 209 #define MLX5_FLOW_ACTION_TUNNEL_MATCH (1ull << 38)
 210
 211 #define MLX5_FLOW_FATE_ACTIONS \
 212         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
 213          MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP | \
 214          MLX5_FLOW_ACTION_DEFAULT_MISS)
 215
 216 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
 217         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
 218          MLX5_FLOW_ACTION_JUMP)
 219
 220
 221 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
 222                                       MLX5_FLOW_ACTION_SET_IPV4_DST | \
 223                                       MLX5_FLOW_ACTION_SET_IPV6_SRC | \
 224                                       MLX5_FLOW_ACTION_SET_IPV6_DST | \
 225                                       MLX5_FLOW_ACTION_SET_TP_SRC | \
 226                                       MLX5_FLOW_ACTION_SET_TP_DST | \
 227                                       MLX5_FLOW_ACTION_SET_TTL | \
 228                                       MLX5_FLOW_ACTION_DEC_TTL | \
 229                                       MLX5_FLOW_ACTION_SET_MAC_SRC | \
 230                                       MLX5_FLOW_ACTION_SET_MAC_DST | \
 231                                       MLX5_FLOW_ACTION_INC_TCP_SEQ | \
 232                                       MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
 233                                       MLX5_FLOW_ACTION_INC_TCP_ACK | \
 234                                       MLX5_FLOW_ACTION_DEC_TCP_ACK | \
 235                                       MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
 236                                       MLX5_FLOW_ACTION_SET_TAG | \
 237                                       MLX5_FLOW_ACTION_MARK_EXT | \
 238                                       MLX5_FLOW_ACTION_SET_META | \
 239                                       MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
 240                                       MLX5_FLOW_ACTION_SET_IPV6_DSCP)
 241
 242 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
 243                                 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
 244
 245 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
 246
 247 #ifndef IPPROTO_MPLS
 248 #define IPPROTO_MPLS 137
 249 #endif
 250
 251 /* UDP port number for MPLS */
 252 #define MLX5_UDP_PORT_MPLS 6635
 253
 254 /* UDP port numbers for VxLAN. */
 255 #define MLX5_UDP_PORT_VXLAN 4789
 256 #define MLX5_UDP_PORT_VXLAN_GPE 4790
 257
 258 /* UDP port numbers for GENEVE. */
 259 #define MLX5_UDP_PORT_GENEVE 6081
 260
 261 /* Priority reserved for default flows. */
 262 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
 263
 264 /*
 265  * Number of sub priorities.
 266  * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
 267  * matching on the NIC (firmware dependent) L4 most have the higher priority
 268  * followed by L3 and ending with L2.
 269  */
 270 #define MLX5_PRIORITY_MAP_L2 2
 271 #define MLX5_PRIORITY_MAP_L3 1
 272 #define MLX5_PRIORITY_MAP_L4 0
 273 #define MLX5_PRIORITY_MAP_MAX 3
 274
 275 /* Valid layer type for IPV4 RSS. */
 276 #define MLX5_IPV4_LAYER_TYPES \
 277         (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
 278          ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
 279          ETH_RSS_NONFRAG_IPV4_OTHER)
 280
 281 /* IBV hash source bits  for IPV4. */
 282 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
 283
 284 /* Valid layer type for IPV6 RSS. */
 285 #define MLX5_IPV6_LAYER_TYPES \
 286         (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
 287          ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX  | ETH_RSS_IPV6_TCP_EX | \
 288          ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
 289
 290 /* IBV hash source bits  for IPV6. */
 291 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
 292
 293 /* IBV hash bits for L3 SRC. */
 294 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
 295
 296 /* IBV hash bits for L3 DST. */
 297 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
 298
 299 /* IBV hash bits for TCP. */
 300 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
 301                               IBV_RX_HASH_DST_PORT_TCP)
 302
 303 /* IBV hash bits for UDP. */
 304 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
 305                               IBV_RX_HASH_DST_PORT_UDP)
 306
 307 /* IBV hash bits for L4 SRC. */
 308 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
 309                                  IBV_RX_HASH_SRC_PORT_UDP)
 310
 311 /* IBV hash bits for L4 DST. */
 312 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
 313                                  IBV_RX_HASH_DST_PORT_UDP)
 314
 315 /* Geneve header first 16Bit */
 316 #define MLX5_GENEVE_VER_MASK 0x3
 317 #define MLX5_GENEVE_VER_SHIFT 14
 318 #define MLX5_GENEVE_VER_VAL(a) \
 319                 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
 320 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
 321 #define MLX5_GENEVE_OPTLEN_SHIFT 7
 322 #define MLX5_GENEVE_OPTLEN_VAL(a) \
 323             (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
 324 #define MLX5_GENEVE_OAMF_MASK 0x1
 325 #define MLX5_GENEVE_OAMF_SHIFT 7
 326 #define MLX5_GENEVE_OAMF_VAL(a) \
 327                 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
 328 #define MLX5_GENEVE_CRITO_MASK 0x1
 329 #define MLX5_GENEVE_CRITO_SHIFT 6
 330 #define MLX5_GENEVE_CRITO_VAL(a) \
 331                 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
 332 #define MLX5_GENEVE_RSVD_MASK 0x3F
 333 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
 334 /*
 335  * The length of the Geneve options fields, expressed in four byte multiples,
 336  * not including the eight byte fixed tunnel.
 337  */
 338 #define MLX5_GENEVE_OPT_LEN_0 14
 339 #define MLX5_GENEVE_OPT_LEN_1 63
 340
 341 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_flow_item_eth) + \
 342                                           sizeof(struct rte_flow_item_ipv4))
 343
 344 /* IPv4 fragment_offset field contains relevant data in bits 2 to 15. */
 345 #define MLX5_IPV4_FRAG_OFFSET_MASK \
 346                 (RTE_IPV4_HDR_OFFSET_MASK | RTE_IPV4_HDR_MF_FLAG)
 347
 348 /* Specific item's fields can accept a range of values (using spec and last). */
 349 #define MLX5_ITEM_RANGE_NOT_ACCEPTED    false
 350 #define MLX5_ITEM_RANGE_ACCEPTED        true
 351
 352 /* Software header modify action numbers of a flow. */
 353 #define MLX5_ACT_NUM_MDF_IPV4           1
 354 #define MLX5_ACT_NUM_MDF_IPV6           4
 355 #define MLX5_ACT_NUM_MDF_MAC            2
 356 #define MLX5_ACT_NUM_MDF_VID            1
 357 #define MLX5_ACT_NUM_MDF_PORT           2
 358 #define MLX5_ACT_NUM_MDF_TTL            1
 359 #define MLX5_ACT_NUM_DEC_TTL            MLX5_ACT_NUM_MDF_TTL
 360 #define MLX5_ACT_NUM_MDF_TCPSEQ         1
 361 #define MLX5_ACT_NUM_MDF_TCPACK         1
 362 #define MLX5_ACT_NUM_SET_REG            1
 363 #define MLX5_ACT_NUM_SET_TAG            1
 364 #define MLX5_ACT_NUM_CPY_MREG           MLX5_ACT_NUM_SET_TAG
 365 #define MLX5_ACT_NUM_SET_MARK           MLX5_ACT_NUM_SET_TAG
 366 #define MLX5_ACT_NUM_SET_META           MLX5_ACT_NUM_SET_TAG
 367 #define MLX5_ACT_NUM_SET_DSCP           1
 368
 369 enum mlx5_flow_drv_type {
 370         MLX5_FLOW_TYPE_MIN,
 371         MLX5_FLOW_TYPE_DV,
 372         MLX5_FLOW_TYPE_VERBS,
 373         MLX5_FLOW_TYPE_MAX,
 374 };
 375
 376 /* Fate action type. */
 377 enum mlx5_flow_fate_type {
 378         MLX5_FLOW_FATE_NONE, /* Egress flow. */
 379         MLX5_FLOW_FATE_QUEUE,
 380         MLX5_FLOW_FATE_JUMP,
 381         MLX5_FLOW_FATE_PORT_ID,
 382         MLX5_FLOW_FATE_DROP,
 383         MLX5_FLOW_FATE_DEFAULT_MISS,
 384         MLX5_FLOW_FATE_MAX,
 385 };
 386
 387 /* Matcher PRM representation */
 388 struct mlx5_flow_dv_match_params {
 389         size_t size;
 390         /**< Size of match value. Do NOT split size and key! */
 391         uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
 392         /**< Matcher value. This value is used as the mask or as a key. */
 393 };
 394
 395 /* Matcher structure. */
 396 struct mlx5_flow_dv_matcher {
 397         LIST_ENTRY(mlx5_flow_dv_matcher) next;
 398         /**< Pointer to the next element. */
 399         struct mlx5_flow_tbl_resource *tbl;
 400         /**< Pointer to the table(group) the matcher associated with. */
 401         uint32_t refcnt; /**< Reference counter. */
 402         void *matcher_object; /**< Pointer to DV matcher */
 403         uint16_t crc; /**< CRC of key. */
 404         uint16_t priority; /**< Priority of matcher. */
 405         struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
 406 };
 407
 408 #define MLX5_ENCAP_MAX_LEN 132
 409
 410 /* Encap/decap resource key of the hash organization. */
 411 union mlx5_flow_encap_decap_key {
 412         struct {
 413                 uint32_t ft_type:8;     /**< Flow table type, Rx or Tx. */
 414                 uint32_t refmt_type:8;  /**< Header reformat type. */
 415                 uint32_t buf_size:8;    /**< Encap buf size. */
 416                 uint32_t table_level:8; /**< Root table or not. */
 417                 uint32_t cksum;         /**< Encap buf check sum. */
 418         };
 419         uint64_t v64;                   /**< full 64bits value of key */
 420 };
 421
 422 /* Encap/decap resource structure. */
 423 struct mlx5_flow_dv_encap_decap_resource {
 424         struct mlx5_hlist_entry entry;
 425         /* Pointer to next element. */
 426         uint32_t refcnt; /**< Reference counter. */
 427         void *action;
 428         /**< Encap/decap action object. */
 429         uint8_t buf[MLX5_ENCAP_MAX_LEN];
 430         size_t size;
 431         uint8_t reformat_type;
 432         uint8_t ft_type;
 433         uint64_t flags; /**< Flags for RDMA API. */
 434         uint32_t idx; /**< Index for the index memory pool. */
 435 };
 436
 437 /* Tag resource structure. */
 438 struct mlx5_flow_dv_tag_resource {
 439         struct mlx5_hlist_entry entry;
 440         /**< hash list entry for tag resource, tag value as the key. */
 441         void *action;
 442         /**< Tag action object. */
 443         uint32_t refcnt; /**< Reference counter. */
 444         uint32_t idx; /**< Index for the index memory pool. */
 445 };
 446
 447 /*
 448  * Number of modification commands.
 449  * The maximal actions amount in FW is some constant, and it is 16 in the
 450  * latest releases. In some old releases, it will be limited to 8.
 451  * Since there is no interface to query the capacity, the maximal value should
 452  * be used to allow PMD to create the flow. The validation will be done in the
 453  * lower driver layer or FW. A failure will be returned if exceeds the maximal
 454  * supported actions number on the root table.
 455  * On non-root tables, there is no limitation, but 32 is enough right now.
 456  */
 457 #define MLX5_MAX_MODIFY_NUM                     32
 458 #define MLX5_ROOT_TBL_MODIFY_NUM                16
 459
 460 /* Modify resource structure */
 461 struct mlx5_flow_dv_modify_hdr_resource {
 462         struct mlx5_hlist_entry entry;
 463         /* Pointer to next element. */
 464         uint32_t refcnt; /**< Reference counter. */
 465         void *action;
 466         /**< Modify header action object. */
 467         uint8_t ft_type; /**< Flow table type, Rx or Tx. */
 468         uint32_t actions_num; /**< Number of modification actions. */
 469         uint64_t flags; /**< Flags for RDMA API. */
 470         struct mlx5_modification_cmd actions[];
 471         /**< Modification actions. */
 472 };
 473
 474 /* Modify resource key of the hash organization. */
 475 union mlx5_flow_modify_hdr_key {
 476         struct {
 477                 uint32_t ft_type:8;     /**< Flow table type, Rx or Tx. */
 478                 uint32_t actions_num:5; /**< Number of modification actions. */
 479                 uint32_t group:19;      /**< Flow group id. */
 480                 uint32_t cksum;         /**< Actions check sum. */
 481         };
 482         uint64_t v64;                   /**< full 64bits value of key */
 483 };
 484
 485 /* Jump action resource structure. */
 486 struct mlx5_flow_dv_jump_tbl_resource {
 487         void *action; /**< Pointer to the rdma core action. */
 488 };
 489
 490 /* Port ID resource structure. */
 491 struct mlx5_flow_dv_port_id_action_resource {
 492         ILIST_ENTRY(uint32_t)next;
 493         /* Pointer to next element. */
 494         uint32_t refcnt; /**< Reference counter. */
 495         void *action;
 496         /**< Action object. */
 497         uint32_t port_id; /**< Port ID value. */
 498 };
 499
 500 /* Push VLAN action resource structure */
 501 struct mlx5_flow_dv_push_vlan_action_resource {
 502         ILIST_ENTRY(uint32_t)next;
 503         /* Pointer to next element. */
 504         uint32_t refcnt; /**< Reference counter. */
 505         void *action; /**< Action object. */
 506         uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
 507         rte_be32_t vlan_tag; /**< VLAN tag value. */
 508 };
 509
 510 /* Metadata register copy table entry. */
 511 struct mlx5_flow_mreg_copy_resource {
 512         /*
 513          * Hash list entry for copy table.
 514          *  - Key is 32/64-bit MARK action ID.
 515          *  - MUST be the first entry.
 516          */
 517         struct mlx5_hlist_entry hlist_ent;
 518         LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
 519         /* List entry for device flows. */
 520         uint32_t refcnt; /* Reference counter. */
 521         uint32_t appcnt; /* Apply/Remove counter. */
 522         uint32_t idx;
 523         uint32_t rix_flow; /* Built flow for copy. */
 524 };
 525
 526 /* Table data structure of the hash organization. */
 527 struct mlx5_flow_tbl_data_entry {
 528         struct mlx5_hlist_entry entry;
 529         /**< hash list entry, 64-bits key inside. */
 530         struct mlx5_flow_tbl_resource tbl;
 531         /**< flow table resource. */
 532         LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
 533         /**< matchers' header associated with the flow table. */
 534         struct mlx5_flow_dv_jump_tbl_resource jump;
 535         /**< jump resource, at most one for each table created. */
 536         uint32_t idx; /**< index for the indexed mempool. */
 537         /**< tunnel offload */
 538         const struct mlx5_flow_tunnel *tunnel;
 539         uint32_t group_id;
 540         bool external;
 541         bool tunnel_offload; /* Tunnel offlod table or not. */
 542 };
 543
 544 /* Sub rdma-core actions list. */
 545 struct mlx5_flow_sub_actions_list {
 546         uint32_t actions_num; /**< Number of sample actions. */
 547         uint64_t action_flags;
 548         void *dr_queue_action;
 549         void *dr_tag_action;
 550         void *dr_cnt_action;
 551         void *dr_port_id_action;
 552         void *dr_encap_action;
 553 };
 554
 555 /* Sample sub-actions resource list. */
 556 struct mlx5_flow_sub_actions_idx {
 557         uint32_t rix_hrxq; /**< Hash Rx queue object index. */
 558         uint32_t rix_tag; /**< Index to the tag action. */
 559         uint32_t cnt;
 560         uint32_t rix_port_id_action; /**< Index to port ID action resource. */
 561         uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
 562 };
 563
 564 /* Sample action resource structure. */
 565 struct mlx5_flow_dv_sample_resource {
 566         ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
 567         uint32_t refcnt; /**< Reference counter. */
 568         void *verbs_action; /**< Verbs sample action object. */
 569         uint8_t ft_type; /** Flow Table Type */
 570         uint32_t ft_id; /** Flow Table Level */
 571         uint32_t ratio;   /** Sample Ratio */
 572         uint64_t set_action; /** Restore reg_c0 value */
 573         void *normal_path_tbl; /** Flow Table pointer */
 574         void *default_miss; /** default_miss dr_action. */
 575         struct mlx5_flow_sub_actions_idx sample_idx;
 576         /**< Action index resources. */
 577         struct mlx5_flow_sub_actions_list sample_act;
 578         /**< Action resources. */
 579 };
 580
 581 #define MLX5_MAX_DEST_NUM       2
 582
 583 /* Destination array action resource structure. */
 584 struct mlx5_flow_dv_dest_array_resource {
 585         ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
 586         uint32_t refcnt; /**< Reference counter. */
 587         uint8_t ft_type; /** Flow Table Type */
 588         uint8_t num_of_dest; /**< Number of destination actions. */
 589         void *action; /**< Pointer to the rdma core action. */
 590         struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
 591         /**< Action index resources. */
 592         struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
 593         /**< Action resources. */
 594 };
 595
 596 /* Verbs specification header. */
 597 struct ibv_spec_header {
 598         enum ibv_flow_spec_type type;
 599         uint16_t size;
 600 };
 601
 602 /* RSS description. */
 603 struct mlx5_flow_rss_desc {
 604         uint32_t level;
 605         uint32_t queue_num; /**< Number of entries in @p queue. */
 606         uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
 607         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
 608         uint16_t *queue; /**< Destination queues. */
 609 };
 610
 611 /* PMD flow priority for tunnel */
 612 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
 613         ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
 614
 615
 616 /** Device flow handle structure for DV mode only. */
 617 struct mlx5_flow_handle_dv {
 618         /* Flow DV api: */
 619         struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
 620         struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
 621         /**< Pointer to modify header resource in cache. */
 622         uint32_t rix_encap_decap;
 623         /**< Index to encap/decap resource in cache. */
 624         uint32_t rix_push_vlan;
 625         /**< Index to push VLAN action resource in cache. */
 626         uint32_t rix_tag;
 627         /**< Index to the tag action. */
 628         uint32_t rix_sample;
 629         /**< Index to sample action resource in cache. */
 630         uint32_t rix_dest_array;
 631         /**< Index to destination array resource in cache. */
 632 } __rte_packed;
 633
 634 /** Device flow handle structure: used both for creating & destroying. */
 635 struct mlx5_flow_handle {
 636         SILIST_ENTRY(uint32_t)next;
 637         struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
 638         /**< Index to next device flow handle. */
 639         uint64_t layers;
 640         /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
 641         void *drv_flow; /**< pointer to driver flow object. */
 642         uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
 643         uint32_t mark:1; /**< Metadate rxq mark flag. */
 644         uint32_t fate_action:3; /**< Fate action type. */
 645         union {
 646                 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
 647                 uint32_t rix_jump; /**< Index to the jump action resource. */
 648                 uint32_t rix_port_id_action;
 649                 /**< Index to port ID action resource. */
 650                 uint32_t rix_fate;
 651                 /**< Generic value indicates the fate action. */
 652                 uint32_t rix_default_fate;
 653                 /**< Indicates default miss fate action. */
 654         };
 655 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 656         struct mlx5_flow_handle_dv dvh;
 657 #endif
 658 } __rte_packed;
 659
 660 /*
 661  * Size for Verbs device flow handle structure only. Do not use the DV only
 662  * structure in Verbs. No DV flows attributes will be accessed.
 663  * Macro offsetof() could also be used here.
 664  */
 665 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 666 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
 667         (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
 668 #else
 669 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
 670 #endif
 671
 672 /*
 673  * Max number of actions per DV flow.
 674  * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
 675  * in rdma-core file providers/mlx5/verbs.c.
 676  */
 677 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
 678
 679 /** Device flow structure only for DV flow creation. */
 680 struct mlx5_flow_dv_workspace {
 681         uint32_t group; /**< The group index. */
 682         uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
 683         int actions_n; /**< number of actions. */
 684         void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
 685         struct mlx5_flow_dv_encap_decap_resource *encap_decap;
 686         /**< Pointer to encap/decap resource in cache. */
 687         struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
 688         /**< Pointer to push VLAN action resource in cache. */
 689         struct mlx5_flow_dv_tag_resource *tag_resource;
 690         /**< pointer to the tag action. */
 691         struct mlx5_flow_dv_port_id_action_resource *port_id_action;
 692         /**< Pointer to port ID action resource. */
 693         struct mlx5_flow_dv_jump_tbl_resource *jump;
 694         /**< Pointer to the jump action resource. */
 695         struct mlx5_flow_dv_match_params value;
 696         /**< Holds the value that the packet is compared to. */
 697         struct mlx5_flow_dv_sample_resource *sample_res;
 698         /**< Pointer to the sample action resource. */
 699         struct mlx5_flow_dv_dest_array_resource *dest_array_res;
 700         /**< Pointer to the destination array resource. */
 701 };
 702
 703 /*
 704  * Maximal Verbs flow specifications & actions size.
 705  * Some elements are mutually exclusive, but enough space should be allocated.
 706  * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
 707  *               2. One tunnel header (exception: GRE + MPLS),
 708  *                  SPEC length: GRE == tunnel.
 709  * Actions: 1. 1 Mark OR Flag.
 710  *          2. 1 Drop (if any).
 711  *          3. No limitation for counters, but it makes no sense to support too
 712  *             many counters in a single device flow.
 713  */
 714 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
 715 #define MLX5_VERBS_MAX_SPEC_SIZE \
 716                 ( \
 717                         (2 * (sizeof(struct ibv_flow_spec_eth) + \
 718                               sizeof(struct ibv_flow_spec_ipv6) + \
 719                               sizeof(struct ibv_flow_spec_tcp_udp)) + \
 720                         sizeof(struct ibv_flow_spec_gre) + \
 721                         sizeof(struct ibv_flow_spec_mpls)) \
 722                 )
 723 #else
 724 #define MLX5_VERBS_MAX_SPEC_SIZE \
 725                 ( \
 726                         (2 * (sizeof(struct ibv_flow_spec_eth) + \
 727                               sizeof(struct ibv_flow_spec_ipv6) + \
 728                               sizeof(struct ibv_flow_spec_tcp_udp)) + \
 729                         sizeof(struct ibv_flow_spec_tunnel)) \
 730                 )
 731 #endif
 732
 733 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
 734         defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
 735 #define MLX5_VERBS_MAX_ACT_SIZE \
 736                 ( \
 737                         sizeof(struct ibv_flow_spec_action_tag) + \
 738                         sizeof(struct ibv_flow_spec_action_drop) + \
 739                         sizeof(struct ibv_flow_spec_counter_action) * 4 \
 740                 )
 741 #else
 742 #define MLX5_VERBS_MAX_ACT_SIZE \
 743                 ( \
 744                         sizeof(struct ibv_flow_spec_action_tag) + \
 745                         sizeof(struct ibv_flow_spec_action_drop) \
 746                 )
 747 #endif
 748
 749 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
 750                 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
 751
 752 /** Device flow structure only for Verbs flow creation. */
 753 struct mlx5_flow_verbs_workspace {
 754         unsigned int size; /**< Size of the attribute. */
 755         struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
 756         uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
 757         /**< Specifications & actions buffer of verbs flow. */
 758 };
 759
 760 /** Maximal number of device sub-flows supported. */
 761 #define MLX5_NUM_MAX_DEV_FLOWS 32
 762
 763 /** Device flow structure. */
 764 struct mlx5_flow {
 765         struct rte_flow *flow; /**< Pointer to the main flow. */
 766         uint32_t flow_idx; /**< The memory pool index to the main flow. */
 767         uint64_t hash_fields; /**< Hash Rx queue hash fields. */
 768         uint64_t act_flags;
 769         /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
 770         bool external; /**< true if the flow is created external to PMD. */
 771         uint8_t ingress; /**< 1 if the flow is ingress. */
 772         union {
 773 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
 774                 struct mlx5_flow_dv_workspace dv;
 775 #endif
 776                 struct mlx5_flow_verbs_workspace verbs;
 777         };
 778         struct mlx5_flow_handle *handle;
 779         uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
 780         const struct mlx5_flow_tunnel *tunnel;
 781 };
 782
 783 /* Flow meter state. */
 784 #define MLX5_FLOW_METER_DISABLE 0
 785 #define MLX5_FLOW_METER_ENABLE 1
 786
 787 #define MLX5_MAN_WIDTH 8
 788 /* Modify this value if enum rte_mtr_color changes. */
 789 #define RTE_MTR_DROPPED RTE_COLORS
 790
 791 /* Meter policer statistics */
 792 struct mlx5_flow_policer_stats {
 793         uint32_t cnt[RTE_COLORS + 1];
 794         /**< Color counter, extra for drop. */
 795         uint64_t stats_mask;
 796         /**< Statistics mask for the colors. */
 797 };
 798
 799 /* Meter table structure. */
 800 struct mlx5_meter_domain_info {
 801         struct mlx5_flow_tbl_resource *tbl;
 802         /**< Meter table. */
 803         struct mlx5_flow_tbl_resource *sfx_tbl;
 804         /**< Meter suffix table. */
 805         void *any_matcher;
 806         /**< Meter color not match default criteria. */
 807         void *color_matcher;
 808         /**< Meter color match criteria. */
 809         void *jump_actn;
 810         /**< Meter match action. */
 811         void *policer_rules[RTE_MTR_DROPPED + 1];
 812         /**< Meter policer for the match. */
 813 };
 814
 815 /* Meter table set for TX RX FDB. */
 816 struct mlx5_meter_domains_infos {
 817         uint32_t ref_cnt;
 818         /**< Table user count. */
 819         struct mlx5_meter_domain_info egress;
 820         /**< TX meter table. */
 821         struct mlx5_meter_domain_info ingress;
 822         /**< RX meter table. */
 823         struct mlx5_meter_domain_info transfer;
 824         /**< FDB meter table. */
 825         void *drop_actn;
 826         /**< Drop action as not matched. */
 827         void *count_actns[RTE_MTR_DROPPED + 1];
 828         /**< Counters for match and unmatched statistics. */
 829         uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
 830         /**< Flow meter parameter. */
 831         size_t fmp_size;
 832         /**< Flow meter parameter size. */
 833         void *meter_action;
 834         /**< Flow meter action. */
 835 };
 836
 837 /* Meter parameter structure. */
 838 struct mlx5_flow_meter {
 839         TAILQ_ENTRY(mlx5_flow_meter) next;
 840         /**< Pointer to the next flow meter structure. */
 841         uint32_t idx; /* Index to meter object. */
 842         uint32_t meter_id;
 843         /**< Meter id. */
 844         struct mlx5_flow_meter_profile *profile;
 845         /**< Meter profile parameters. */
 846
 847         rte_spinlock_t sl; /**< Meter action spinlock. */
 848
 849         /** Policer actions (per meter output color). */
 850         enum rte_mtr_policer_action action[RTE_COLORS];
 851
 852         /** Set of stats counters to be enabled.
 853          * @see enum rte_mtr_stats_type
 854          */
 855         uint64_t stats_mask;
 856
 857         /**< Rule applies to ingress traffic. */
 858         uint32_t ingress:1;
 859
 860         /**< Rule applies to egress traffic. */
 861         uint32_t egress:1;
 862         /**
 863          * Instead of simply matching the properties of traffic as it would
 864          * appear on a given DPDK port ID, enabling this attribute transfers
 865          * a flow rule to the lowest possible level of any device endpoints
 866          * found in the pattern.
 867          *
 868          * When supported, this effectively enables an application to
 869          * re-route traffic not necessarily intended for it (e.g. coming
 870          * from or addressed to different physical ports, VFs or
 871          * applications) at the device level.
 872          *
 873          * It complements the behavior of some pattern items such as
 874          * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
 875          *
 876          * When transferring flow rules, ingress and egress attributes keep
 877          * their original meaning, as if processing traffic emitted or
 878          * received by the application.
 879          */
 880         uint32_t transfer:1;
 881         struct mlx5_meter_domains_infos *mfts;
 882         /**< Flow table created for this meter. */
 883         struct mlx5_flow_policer_stats policer_stats;
 884         /**< Meter policer statistics. */
 885         uint32_t ref_cnt;
 886         /**< Use count. */
 887         uint32_t active_state:1;
 888         /**< Meter state. */
 889         uint32_t shared:1;
 890         /**< Meter shared or not. */
 891 };
 892
 893 /* RFC2697 parameter structure. */
 894 struct mlx5_flow_meter_srtcm_rfc2697_prm {
 895         /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
 896         uint32_t cbs_exponent:5;
 897         uint32_t cbs_mantissa:8;
 898         /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
 899         uint32_t cir_exponent:5;
 900         uint32_t cir_mantissa:8;
 901         /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
 902         uint32_t ebs_exponent:5;
 903         uint32_t ebs_mantissa:8;
 904 };
 905
 906 /* Flow meter profile structure. */
 907 struct mlx5_flow_meter_profile {
 908         TAILQ_ENTRY(mlx5_flow_meter_profile) next;
 909         /**< Pointer to the next flow meter structure. */
 910         uint32_t meter_profile_id; /**< Profile id. */
 911         struct rte_mtr_meter_profile profile; /**< Profile detail. */
 912         union {
 913                 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
 914                 /**< srtcm_rfc2697 struct. */
 915         };
 916         uint32_t ref_cnt; /**< Use count. */
 917 };
 918
 919 /* Fdir flow structure */
 920 struct mlx5_fdir_flow {
 921         LIST_ENTRY(mlx5_fdir_flow) next; /* Pointer to the next element. */
 922         struct mlx5_fdir *fdir; /* Pointer to fdir. */
 923         uint32_t rix_flow; /* Index to flow. */
 924 };
 925
 926 #define MLX5_MAX_TUNNELS 256
 927 #define MLX5_TNL_MISS_RULE_PRIORITY 3
 928 #define MLX5_TNL_MISS_FDB_JUMP_GRP  0x1234faac
 929
 930 /*
 931  * When tunnel offload is active, all JUMP group ids are converted
 932  * using the same method. That conversion is applied both to tunnel and
 933  * regular rule types.
 934  * Group ids used in tunnel rules are relative to it's tunnel (!).
 935  * Application can create number of steer rules, using the same
 936  * tunnel, with different group id in each rule.
 937  * Each tunnel stores its groups internally in PMD tunnel object.
 938  * Groups used in regular rules do not belong to any tunnel and are stored
 939  * in tunnel hub.
 940  */
 941
 942 struct mlx5_flow_tunnel {
 943         LIST_ENTRY(mlx5_flow_tunnel) chain;
 944         struct rte_flow_tunnel app_tunnel;      /** app tunnel copy */
 945         uint32_t tunnel_id;                     /** unique tunnel ID */
 946         uint32_t refctn;
 947         struct rte_flow_action action;
 948         struct rte_flow_item item;
 949         struct mlx5_hlist *groups;              /** tunnel groups */
 950 };
 951
 952 /** PMD tunnel related context */
 953 struct mlx5_flow_tunnel_hub {
 954         LIST_HEAD(, mlx5_flow_tunnel) tunnels;
 955         struct mlx5_hlist *groups;              /** non tunnel groups */
 956 };
 957
 958 /* convert jump group to flow table ID in tunnel rules */
 959 struct tunnel_tbl_entry {
 960         struct mlx5_hlist_entry hash;
 961         uint32_t flow_table;
 962 };
 963
 964 static inline uint32_t
 965 tunnel_id_to_flow_tbl(uint32_t id)
 966 {
 967         return id | (1u << 16);
 968 }
 969
 970 static inline uint32_t
 971 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
 972 {
 973         return flow_tbl & ~(1u << 16);
 974 }
 975
 976 union tunnel_tbl_key {
 977         uint64_t val;
 978         struct {
 979                 uint32_t tunnel_id;
 980                 uint32_t group;
 981         };
 982 };
 983
 984 static inline struct mlx5_flow_tunnel_hub *
 985 mlx5_tunnel_hub(struct rte_eth_dev *dev)
 986 {
 987         struct mlx5_priv *priv = dev->data->dev_private;
 988         return priv->sh->tunnel_hub;
 989 }
 990
 991 static inline bool
 992 is_tunnel_offload_active(struct rte_eth_dev *dev)
 993 {
 994         struct mlx5_priv *priv = dev->data->dev_private;
 995         return !!priv->config.dv_miss_info;
 996 }
 997
 998 static inline bool
 999 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
1000                           __rte_unused const struct rte_flow_attr *attr,
1001                           __rte_unused const struct rte_flow_item items[],
1002                           __rte_unused const struct rte_flow_action actions[])
1003 {
1004         return (items[0].type == (typeof(items[0].type))
1005                                  MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
1006 }
1007
1008 static inline bool
1009 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
1010                           __rte_unused const struct rte_flow_attr *attr,
1011                           __rte_unused const struct rte_flow_item items[],
1012                           __rte_unused const struct rte_flow_action actions[])
1013 {
1014         return (actions[0].type == (typeof(actions[0].type))
1015                                    MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
1016 }
1017
1018 static inline const struct mlx5_flow_tunnel *
1019 flow_actions_to_tunnel(const struct rte_flow_action actions[])
1020 {
1021         return actions[0].conf;
1022 }
1023
1024 static inline const struct mlx5_flow_tunnel *
1025 flow_items_to_tunnel(const struct rte_flow_item items[])
1026 {
1027         return items[0].spec;
1028 }
1029
1030 /* Flow structure. */
1031 struct rte_flow {
1032         ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
1033         struct mlx5_shared_action_rss *shared_rss; /** < Shred RSS action. */
1034         uint32_t dev_handles;
1035         /**< Device flow handles that are part of the flow. */
1036         uint32_t drv_type:2; /**< Driver type. */
1037         uint32_t fdir:1; /**< Identifier of associated FDIR if any. */
1038         uint32_t tunnel:1;
1039         uint32_t copy_applied:1; /**< The MARK copy Flow os applied. */
1040         uint32_t meter:16; /**< Holds flow meter id. */
1041         uint32_t rix_mreg_copy;
1042         /**< Index to metadata register copy table resource. */
1043         uint32_t counter; /**< Holds flow counter. */
1044         uint32_t tunnel_id;  /**< Tunnel id */
1045 } __rte_packed;
1046
1047 /*
1048  * Define list of valid combinations of RX Hash fields
1049  * (see enum ibv_rx_hash_fields).
1050  */
1051 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
1052 #define MLX5_RSS_HASH_IPV4_TCP \
1053         (MLX5_RSS_HASH_IPV4 | \
1054          IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1055 #define MLX5_RSS_HASH_IPV4_UDP \
1056         (MLX5_RSS_HASH_IPV4 | \
1057          IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1058 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
1059 #define MLX5_RSS_HASH_IPV6_TCP \
1060         (MLX5_RSS_HASH_IPV6 | \
1061          IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1062 #define MLX5_RSS_HASH_IPV6_UDP \
1063         (MLX5_RSS_HASH_IPV6 | \
1064          IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1065 #define MLX5_RSS_HASH_NONE 0ULL
1066
1067 /* array of valid combinations of RX Hash fields for RSS */
1068 static const uint64_t mlx5_rss_hash_fields[] = {
1069         MLX5_RSS_HASH_IPV4,
1070         MLX5_RSS_HASH_IPV4_TCP,
1071         MLX5_RSS_HASH_IPV4_UDP,
1072         MLX5_RSS_HASH_IPV6,
1073         MLX5_RSS_HASH_IPV6_TCP,
1074         MLX5_RSS_HASH_IPV6_UDP,
1075         MLX5_RSS_HASH_NONE,
1076 };
1077
1078 #define MLX5_RSS_HASH_FIELDS_LEN RTE_DIM(mlx5_rss_hash_fields)
1079
1080 /* Shared RSS action structure */
1081 struct mlx5_shared_action_rss {
1082         struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1083         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1084         uint16_t *queue; /**< Queue indices to use. */
1085         uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1086         /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1087         uint32_t hrxq_tunnel[MLX5_RSS_HASH_FIELDS_LEN];
1088         /**< Hash RX queue indexes for tunneled RSS */
1089 };
1090
1091 struct rte_flow_shared_action {
1092         LIST_ENTRY(rte_flow_shared_action) next;
1093                 /**< Pointer to the next element. */
1094         uint32_t refcnt; /**< Atomically accessed refcnt. */
1095         uint64_t type;
1096                 /**< Shared action type (see MLX5_FLOW_ACTION_SHARED_*). */
1097         union {
1098                 struct mlx5_shared_action_rss rss;
1099                         /**< Shared RSS action. */
1100         };
1101 };
1102
1103 /* Thread specific flow workspace intermediate data. */
1104 struct mlx5_flow_workspace {
1105         struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1106         struct mlx5_flow_rss_desc rss_desc[2];
1107         uint32_t rssq_num[2]; /* Allocated queue num in rss_desc. */
1108         int flow_idx; /* Intermediate device flow index. */
1109         int flow_nested_idx; /* Intermediate device flow index, nested. */
1110 };
1111
1112 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1113                                     const struct rte_flow_attr *attr,
1114                                     const struct rte_flow_item items[],
1115                                     const struct rte_flow_action actions[],
1116                                     bool external,
1117                                     int hairpin,
1118                                     struct rte_flow_error *error);
1119 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1120         (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1121          const struct rte_flow_item items[],
1122          const struct rte_flow_action actions[], struct rte_flow_error *error);
1123 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1124                                      struct mlx5_flow *dev_flow,
1125                                      const struct rte_flow_attr *attr,
1126                                      const struct rte_flow_item items[],
1127                                      const struct rte_flow_action actions[],
1128                                      struct rte_flow_error *error);
1129 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1130                                  struct rte_flow_error *error);
1131 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1132                                    struct rte_flow *flow);
1133 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1134                                     struct rte_flow *flow);
1135 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1136                                  struct rte_flow *flow,
1137                                  const struct rte_flow_action *actions,
1138                                  void *data,
1139                                  struct rte_flow_error *error);
1140 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1141                                             (struct rte_eth_dev *dev,
1142                                              const struct mlx5_flow_meter *fm);
1143 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1144                                         struct mlx5_meter_domains_infos *tbls);
1145 typedef int (*mlx5_flow_create_policer_rules_t)
1146                                         (struct rte_eth_dev *dev,
1147                                          struct mlx5_flow_meter *fm,
1148                                          const struct rte_flow_attr *attr);
1149 typedef int (*mlx5_flow_destroy_policer_rules_t)
1150                                         (struct rte_eth_dev *dev,
1151                                          const struct mlx5_flow_meter *fm,
1152                                          const struct rte_flow_attr *attr);
1153 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1154                                    (struct rte_eth_dev *dev);
1155 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1156                                          uint32_t cnt);
1157 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1158                                          uint32_t cnt,
1159                                          bool clear, uint64_t *pkts,
1160                                          uint64_t *bytes);
1161 typedef int (*mlx5_flow_get_aged_flows_t)
1162                                         (struct rte_eth_dev *dev,
1163                                          void **context,
1164                                          uint32_t nb_contexts,
1165                                          struct rte_flow_error *error);
1166 typedef int (*mlx5_flow_action_validate_t)
1167                                 (struct rte_eth_dev *dev,
1168                                  const struct rte_flow_shared_action_conf *conf,
1169                                  const struct rte_flow_action *action,
1170                                  struct rte_flow_error *error);
1171 typedef struct rte_flow_shared_action *(*mlx5_flow_action_create_t)
1172                                 (struct rte_eth_dev *dev,
1173                                  const struct rte_flow_shared_action_conf *conf,
1174                                  const struct rte_flow_action *action,
1175                                  struct rte_flow_error *error);
1176 typedef int (*mlx5_flow_action_destroy_t)
1177                                 (struct rte_eth_dev *dev,
1178                                  struct rte_flow_shared_action *action,
1179                                  struct rte_flow_error *error);
1180 typedef int (*mlx5_flow_action_update_t)
1181                         (struct rte_eth_dev *dev,
1182                          struct rte_flow_shared_action *action,
1183                          const void *action_conf,
1184                          struct rte_flow_error *error);
1185 typedef int (*mlx5_flow_sync_domain_t)
1186                         (struct rte_eth_dev *dev,
1187                          uint32_t domains,
1188                          uint32_t flags);
1189 struct mlx5_flow_driver_ops {
1190         mlx5_flow_validate_t validate;
1191         mlx5_flow_prepare_t prepare;
1192         mlx5_flow_translate_t translate;
1193         mlx5_flow_apply_t apply;
1194         mlx5_flow_remove_t remove;
1195         mlx5_flow_destroy_t destroy;
1196         mlx5_flow_query_t query;
1197         mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1198         mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1199         mlx5_flow_create_policer_rules_t create_policer_rules;
1200         mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1201         mlx5_flow_counter_alloc_t counter_alloc;
1202         mlx5_flow_counter_free_t counter_free;
1203         mlx5_flow_counter_query_t counter_query;
1204         mlx5_flow_get_aged_flows_t get_aged_flows;
1205         mlx5_flow_action_validate_t action_validate;
1206         mlx5_flow_action_create_t action_create;
1207         mlx5_flow_action_destroy_t action_destroy;
1208         mlx5_flow_action_update_t action_update;
1209         mlx5_flow_sync_domain_t sync_domain;
1210 };
1211
1212 /* mlx5_flow.c */
1213
1214 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1215 __extension__
1216 struct flow_grp_info {
1217         uint64_t external:1;
1218         uint64_t transfer:1;
1219         uint64_t fdb_def_rule:1;
1220         /* force standard group translation */
1221         uint64_t std_tbl_fix:1;
1222 };
1223
1224 static inline bool
1225 tunnel_use_standard_attr_group_translate
1226                     (struct rte_eth_dev *dev,
1227                      const struct mlx5_flow_tunnel *tunnel,
1228                      const struct rte_flow_attr *attr,
1229                      const struct rte_flow_item items[],
1230                      const struct rte_flow_action actions[])
1231 {
1232         bool verdict;
1233
1234         if (!is_tunnel_offload_active(dev))
1235                 /* no tunnel offload API */
1236                 verdict = true;
1237         else if (tunnel) {
1238                 /*
1239                  * OvS will use jump to group 0 in tunnel steer rule.
1240                  * If tunnel steer rule starts from group 0 (attr.group == 0)
1241                  * that 0 group must be translated with standard method.
1242                  * attr.group == 0 in tunnel match rule translated with tunnel
1243                  * method
1244                  */
1245                 verdict = !attr->group &&
1246                           is_flow_tunnel_steer_rule(dev, attr, items, actions);
1247         } else {
1248                 /*
1249                  * non-tunnel group translation uses standard method for
1250                  * root group only: attr.group == 0
1251                  */
1252                 verdict = !attr->group;
1253         }
1254
1255         return verdict;
1256 }
1257
1258 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1259                              const struct mlx5_flow_tunnel *tunnel,
1260                              uint32_t group, uint32_t *table,
1261                              struct flow_grp_info flags,
1262                                  struct rte_flow_error *error);
1263 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1264                                      int tunnel, uint64_t layer_types,
1265                                      uint64_t hash_fields);
1266 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1267 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1268                                    uint32_t subpriority);
1269 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1270                                      enum mlx5_feature_name feature,
1271                                      uint32_t id,
1272                                      struct rte_flow_error *error);
1273 const struct rte_flow_action *mlx5_flow_find_action
1274                                         (const struct rte_flow_action *actions,
1275                                          enum rte_flow_action_type action);
1276 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1277                              const struct rte_flow_action *action,
1278                              struct rte_flow_error *error);
1279 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1280                                     const struct rte_flow_attr *attr,
1281                                     struct rte_flow_error *error);
1282 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1283                                    const struct rte_flow_attr *attr,
1284                                    struct rte_flow_error *error);
1285 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1286                                    const struct rte_flow_attr *attr,
1287                                    struct rte_flow_error *error);
1288 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1289                                    uint64_t action_flags,
1290                                    const struct rte_flow_attr *attr,
1291                                    struct rte_flow_error *error);
1292 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1293                                     uint64_t action_flags,
1294                                     struct rte_eth_dev *dev,
1295                                     const struct rte_flow_attr *attr,
1296                                     struct rte_flow_error *error);
1297 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1298                                   uint64_t action_flags,
1299                                   struct rte_eth_dev *dev,
1300                                   const struct rte_flow_attr *attr,
1301                                   uint64_t item_flags,
1302                                   struct rte_flow_error *error);
1303 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1304                                 const struct rte_flow_attr *attr,
1305                                 struct rte_flow_error *error);
1306 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1307                                   const struct rte_flow_attr *attributes,
1308                                   struct rte_flow_error *error);
1309 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1310                               const uint8_t *mask,
1311                               const uint8_t *nic_mask,
1312                               unsigned int size,
1313                               bool range_accepted,
1314                               struct rte_flow_error *error);
1315 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1316                                 uint64_t item_flags, bool ext_vlan_sup,
1317                                 struct rte_flow_error *error);
1318 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1319                                 uint64_t item_flags,
1320                                 uint8_t target_protocol,
1321                                 struct rte_flow_error *error);
1322 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1323                                     uint64_t item_flags,
1324                                     const struct rte_flow_item *gre_item,
1325                                     struct rte_flow_error *error);
1326 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1327                                  uint64_t item_flags,
1328                                  uint64_t last_item,
1329                                  uint16_t ether_type,
1330                                  const struct rte_flow_item_ipv4 *acc_mask,
1331                                  bool range_accepted,
1332                                  struct rte_flow_error *error);
1333 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1334                                  uint64_t item_flags,
1335                                  uint64_t last_item,
1336                                  uint16_t ether_type,
1337                                  const struct rte_flow_item_ipv6 *acc_mask,
1338                                  struct rte_flow_error *error);
1339 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1340                                  const struct rte_flow_item *item,
1341                                  uint64_t item_flags,
1342                                  uint64_t prev_layer,
1343                                  struct rte_flow_error *error);
1344 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1345                                 uint64_t item_flags,
1346                                 uint8_t target_protocol,
1347                                 const struct rte_flow_item_tcp *flow_mask,
1348                                 struct rte_flow_error *error);
1349 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1350                                 uint64_t item_flags,
1351                                 uint8_t target_protocol,
1352                                 struct rte_flow_error *error);
1353 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1354                                  uint64_t item_flags,
1355                                  struct rte_eth_dev *dev,
1356                                  struct rte_flow_error *error);
1357 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1358                                   uint64_t item_flags,
1359                                   struct rte_flow_error *error);
1360 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1361                                       uint64_t item_flags,
1362                                       struct rte_eth_dev *dev,
1363                                       struct rte_flow_error *error);
1364 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1365                                  uint64_t item_flags,
1366                                  uint8_t target_protocol,
1367                                  struct rte_flow_error *error);
1368 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1369                                    uint64_t item_flags,
1370                                    uint8_t target_protocol,
1371                                    struct rte_flow_error *error);
1372 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1373                                   uint64_t item_flags,
1374                                   uint8_t target_protocol,
1375                                   struct rte_flow_error *error);
1376 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1377                                    uint64_t item_flags,
1378                                    struct rte_eth_dev *dev,
1379                                    struct rte_flow_error *error);
1380 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1381                                   uint64_t item_flags,
1382                                   uint64_t last_item,
1383                                   uint16_t ether_type,
1384                                   const struct rte_flow_item_ecpri *acc_mask,
1385                                   struct rte_flow_error *error);
1386 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1387                                         (struct rte_eth_dev *dev,
1388                                          const struct mlx5_flow_meter *fm);
1389 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1390                                struct mlx5_meter_domains_infos *tbl);
1391 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1392                                    struct mlx5_flow_meter *fm,
1393                                    const struct rte_flow_attr *attr);
1394 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1395                                     struct mlx5_flow_meter *fm,
1396                                     const struct rte_flow_attr *attr);
1397 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1398                           struct rte_mtr_error *error);
1399 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1400 struct rte_flow_shared_action *mlx5_flow_get_shared_rss(struct rte_flow *flow);
1401 int mlx5_shared_action_flush(struct rte_eth_dev *dev);
1402 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1403 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1404 #endif /* RTE_PMD_MLX5_FLOW_H_ */