drivers/net/mlx4/mlx4_flow.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 6WIND S.A.
   3  * Copyright 2017 Mellanox Technologies, Ltd
   4  */
   5
   6 /**
   7  * @file
   8  * Flow API operations for mlx4 driver.
   9  */
  10
  11 #include <arpa/inet.h>
  12 #include <assert.h>
  13 #include <errno.h>
  14 #include <stdalign.h>
  15 #include <stddef.h>
  16 #include <stdint.h>
  17 #include <string.h>
  18 #include <sys/queue.h>
  19
  20 /* Verbs headers do not support -pedantic. */
  21 #ifdef PEDANTIC
  22 #pragma GCC diagnostic ignored "-Wpedantic"
  23 #endif
  24 #include <infiniband/verbs.h>
  25 #ifdef PEDANTIC
  26 #pragma GCC diagnostic error "-Wpedantic"
  27 #endif
  28
  29 #include <rte_byteorder.h>
  30 #include <rte_errno.h>
  31 #include <rte_eth_ctrl.h>
  32 #include <rte_ethdev_driver.h>
  33 #include <rte_ether.h>
  34 #include <rte_flow.h>
  35 #include <rte_flow_driver.h>
  36 #include <rte_malloc.h>
  37
  38 /* PMD headers. */
  39 #include "mlx4.h"
  40 #include "mlx4_glue.h"
  41 #include "mlx4_flow.h"
  42 #include "mlx4_rxtx.h"
  43 #include "mlx4_utils.h"
  44
  45 /** Static initializer for a list of subsequent item types. */
  46 #define NEXT_ITEM(...) \
  47         (const enum rte_flow_item_type []){ \
  48                 __VA_ARGS__, RTE_FLOW_ITEM_TYPE_END, \
  49         }
  50
  51 /** Processor structure associated with a flow item. */
  52 struct mlx4_flow_proc_item {
  53         /** Bit-mask for fields supported by this PMD. */
  54         const void *mask_support;
  55         /** Bit-mask to use when @p item->mask is not provided. */
  56         const void *mask_default;
  57         /** Size in bytes for @p mask_support and @p mask_default. */
  58         const unsigned int mask_sz;
  59         /** Merge a pattern item into a flow rule handle. */
  60         int (*merge)(struct rte_flow *flow,
  61                      const struct rte_flow_item *item,
  62                      const struct mlx4_flow_proc_item *proc,
  63                      struct rte_flow_error *error);
  64         /** Size in bytes of the destination structure. */
  65         const unsigned int dst_sz;
  66         /** List of possible subsequent items. */
  67         const enum rte_flow_item_type *const next_item;
  68 };
  69
  70 /** Shared resources for drop flow rules. */
  71 struct mlx4_drop {
  72         struct ibv_qp *qp; /**< QP target. */
  73         struct ibv_cq *cq; /**< CQ associated with above QP. */
  74         struct priv *priv; /**< Back pointer to private data. */
  75         uint32_t refcnt; /**< Reference count. */
  76 };
  77
  78 /**
  79  * Convert supported RSS hash field types between DPDK and Verbs formats.
  80  *
  81  * This function returns the supported (default) set when @p types has
  82  * special value 0.
  83  *
  84  * @param priv
  85  *   Pointer to private structure.
  86  * @param types
  87  *   Depending on @p verbs_to_dpdk, hash types in either DPDK (see struct
  88  *   rte_eth_rss_conf) or Verbs format.
  89  * @param verbs_to_dpdk
  90  *   A zero value converts @p types from DPDK to Verbs, a nonzero value
  91  *   performs the reverse operation.
  92  *
  93  * @return
  94  *   Converted RSS hash fields on success, (uint64_t)-1 otherwise and
  95  *   rte_errno is set.
  96  */
  97 uint64_t
  98 mlx4_conv_rss_types(struct priv *priv, uint64_t types, int verbs_to_dpdk)
  99 {
 100         enum {
 101                 INNER,
 102                 IPV4, IPV4_1, IPV4_2, IPV6, IPV6_1, IPV6_2, IPV6_3,
 103                 TCP, UDP,
 104                 IPV4_TCP, IPV4_UDP, IPV6_TCP, IPV6_TCP_1, IPV6_UDP, IPV6_UDP_1,
 105         };
 106         enum {
 107                 VERBS_IPV4 = IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4,
 108                 VERBS_IPV6 = IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6,
 109                 VERBS_TCP = IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_DST_PORT_TCP,
 110                 VERBS_UDP = IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_DST_PORT_UDP,
 111         };
 112         static const uint64_t dpdk[] = {
 113                 [INNER] = 0,
 114                 [IPV4] = ETH_RSS_IPV4,
 115                 [IPV4_1] = ETH_RSS_FRAG_IPV4,
 116                 [IPV4_2] = ETH_RSS_NONFRAG_IPV4_OTHER,
 117                 [IPV6] = ETH_RSS_IPV6,
 118                 [IPV6_1] = ETH_RSS_FRAG_IPV6,
 119                 [IPV6_2] = ETH_RSS_NONFRAG_IPV6_OTHER,
 120                 [IPV6_3] = ETH_RSS_IPV6_EX,
 121                 [TCP] = 0,
 122                 [UDP] = 0,
 123                 [IPV4_TCP] = ETH_RSS_NONFRAG_IPV4_TCP,
 124                 [IPV4_UDP] = ETH_RSS_NONFRAG_IPV4_UDP,
 125                 [IPV6_TCP] = ETH_RSS_NONFRAG_IPV6_TCP,
 126                 [IPV6_TCP_1] = ETH_RSS_IPV6_TCP_EX,
 127                 [IPV6_UDP] = ETH_RSS_NONFRAG_IPV6_UDP,
 128                 [IPV6_UDP_1] = ETH_RSS_IPV6_UDP_EX,
 129         };
 130         static const uint64_t verbs[RTE_DIM(dpdk)] = {
 131                 [INNER] = IBV_RX_HASH_INNER,
 132                 [IPV4] = VERBS_IPV4,
 133                 [IPV4_1] = VERBS_IPV4,
 134                 [IPV4_2] = VERBS_IPV4,
 135                 [IPV6] = VERBS_IPV6,
 136                 [IPV6_1] = VERBS_IPV6,
 137                 [IPV6_2] = VERBS_IPV6,
 138                 [IPV6_3] = VERBS_IPV6,
 139                 [TCP] = VERBS_TCP,
 140                 [UDP] = VERBS_UDP,
 141                 [IPV4_TCP] = VERBS_IPV4 | VERBS_TCP,
 142                 [IPV4_UDP] = VERBS_IPV4 | VERBS_UDP,
 143                 [IPV6_TCP] = VERBS_IPV6 | VERBS_TCP,
 144                 [IPV6_TCP_1] = VERBS_IPV6 | VERBS_TCP,
 145                 [IPV6_UDP] = VERBS_IPV6 | VERBS_UDP,
 146                 [IPV6_UDP_1] = VERBS_IPV6 | VERBS_UDP,
 147         };
 148         const uint64_t *in = verbs_to_dpdk ? verbs : dpdk;
 149         const uint64_t *out = verbs_to_dpdk ? dpdk : verbs;
 150         uint64_t seen = 0;
 151         uint64_t conv = 0;
 152         unsigned int i;
 153
 154         if (!types) {
 155                 if (!verbs_to_dpdk)
 156                         return priv->hw_rss_sup;
 157                 types = priv->hw_rss_sup;
 158         }
 159         for (i = 0; i != RTE_DIM(dpdk); ++i)
 160                 if (in[i] && (types & in[i]) == in[i]) {
 161                         seen |= types & in[i];
 162                         conv |= out[i];
 163                 }
 164         if ((verbs_to_dpdk || (conv & priv->hw_rss_sup) == conv) &&
 165             !(types & ~seen))
 166                 return conv;
 167         rte_errno = ENOTSUP;
 168         return (uint64_t)-1;
 169 }
 170
 171 /**
 172  * Merge Ethernet pattern item into flow rule handle.
 173  *
 174  * Additional mlx4-specific constraints on supported fields:
 175  *
 176  * - No support for partial masks, except in the specific case of matching
 177  *   all multicast traffic (@p spec->dst and @p mask->dst equal to
 178  *   01:00:00:00:00:00).
 179  * - Not providing @p item->spec or providing an empty @p mask->dst is
 180  *   *only* supported if the rule doesn't specify additional matching
 181  *   criteria (i.e. rule is promiscuous-like).
 182  *
 183  * @param[in, out] flow
 184  *   Flow rule handle to update.
 185  * @param[in] item
 186  *   Pattern item to merge.
 187  * @param[in] proc
 188  *   Associated item-processing object.
 189  * @param[out] error
 190  *   Perform verbose error reporting if not NULL.
 191  *
 192  * @return
 193  *   0 on success, a negative errno value otherwise and rte_errno is set.
 194  */
 195 static int
 196 mlx4_flow_merge_eth(struct rte_flow *flow,
 197                     const struct rte_flow_item *item,
 198                     const struct mlx4_flow_proc_item *proc,
 199                     struct rte_flow_error *error)
 200 {
 201         const struct rte_flow_item_eth *spec = item->spec;
 202         const struct rte_flow_item_eth *mask =
 203                 spec ? (item->mask ? item->mask : proc->mask_default) : NULL;
 204         struct ibv_flow_spec_eth *eth;
 205         const char *msg;
 206         unsigned int i;
 207
 208         if (!mask) {
 209                 flow->promisc = 1;
 210         } else {
 211                 uint32_t sum_dst = 0;
 212                 uint32_t sum_src = 0;
 213
 214                 for (i = 0; i != sizeof(mask->dst.addr_bytes); ++i) {
 215                         sum_dst += mask->dst.addr_bytes[i];
 216                         sum_src += mask->src.addr_bytes[i];
 217                 }
 218                 if (sum_src) {
 219                         msg = "mlx4 does not support source MAC matching";
 220                         goto error;
 221                 } else if (!sum_dst) {
 222                         flow->promisc = 1;
 223                 } else if (sum_dst == 1 && mask->dst.addr_bytes[0] == 1) {
 224                         if (!(spec->dst.addr_bytes[0] & 1)) {
 225                                 msg = "mlx4 does not support the explicit"
 226                                         " exclusion of all multicast traffic";
 227                                 goto error;
 228                         }
 229                         flow->allmulti = 1;
 230                 } else if (sum_dst != (UINT8_C(0xff) * ETHER_ADDR_LEN)) {
 231                         msg = "mlx4 does not support matching partial"
 232                                 " Ethernet fields";
 233                         goto error;
 234                 }
 235         }
 236         if (!flow->ibv_attr)
 237                 return 0;
 238         if (flow->promisc) {
 239                 flow->ibv_attr->type = IBV_FLOW_ATTR_ALL_DEFAULT;
 240                 return 0;
 241         }
 242         if (flow->allmulti) {
 243                 flow->ibv_attr->type = IBV_FLOW_ATTR_MC_DEFAULT;
 244                 return 0;
 245         }
 246         ++flow->ibv_attr->num_of_specs;
 247         eth = (void *)((uintptr_t)flow->ibv_attr + flow->ibv_attr_size);
 248         *eth = (struct ibv_flow_spec_eth) {
 249                 .type = IBV_FLOW_SPEC_ETH,
 250                 .size = sizeof(*eth),
 251         };
 252         memcpy(eth->val.dst_mac, spec->dst.addr_bytes, ETHER_ADDR_LEN);
 253         memcpy(eth->mask.dst_mac, mask->dst.addr_bytes, ETHER_ADDR_LEN);
 254         /* Remove unwanted bits from values. */
 255         for (i = 0; i < ETHER_ADDR_LEN; ++i) {
 256                 eth->val.dst_mac[i] &= eth->mask.dst_mac[i];
 257         }
 258         return 0;
 259 error:
 260         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 261                                   item, msg);
 262 }
 263
 264 /**
 265  * Merge VLAN pattern item into flow rule handle.
 266  *
 267  * Additional mlx4-specific constraints on supported fields:
 268  *
 269  * - Matching *all* VLAN traffic by omitting @p item->spec or providing an
 270  *   empty @p item->mask would also include non-VLAN traffic. Doing so is
 271  *   therefore unsupported.
 272  * - No support for partial masks.
 273  *
 274  * @param[in, out] flow
 275  *   Flow rule handle to update.
 276  * @param[in] item
 277  *   Pattern item to merge.
 278  * @param[in] proc
 279  *   Associated item-processing object.
 280  * @param[out] error
 281  *   Perform verbose error reporting if not NULL.
 282  *
 283  * @return
 284  *   0 on success, a negative errno value otherwise and rte_errno is set.
 285  */
 286 static int
 287 mlx4_flow_merge_vlan(struct rte_flow *flow,
 288                      const struct rte_flow_item *item,
 289                      const struct mlx4_flow_proc_item *proc,
 290                      struct rte_flow_error *error)
 291 {
 292         const struct rte_flow_item_vlan *spec = item->spec;
 293         const struct rte_flow_item_vlan *mask =
 294                 spec ? (item->mask ? item->mask : proc->mask_default) : NULL;
 295         struct ibv_flow_spec_eth *eth;
 296         const char *msg;
 297
 298         if (!mask || !mask->tci) {
 299                 msg = "mlx4 cannot match all VLAN traffic while excluding"
 300                         " non-VLAN traffic, TCI VID must be specified";
 301                 goto error;
 302         }
 303         if (mask->tci != RTE_BE16(0x0fff)) {
 304                 msg = "mlx4 does not support partial TCI VID matching";
 305                 goto error;
 306         }
 307         if (!flow->ibv_attr)
 308                 return 0;
 309         eth = (void *)((uintptr_t)flow->ibv_attr + flow->ibv_attr_size -
 310                        sizeof(*eth));
 311         eth->val.vlan_tag = spec->tci;
 312         eth->mask.vlan_tag = mask->tci;
 313         eth->val.vlan_tag &= eth->mask.vlan_tag;
 314         return 0;
 315 error:
 316         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 317                                   item, msg);
 318 }
 319
 320 /**
 321  * Merge IPv4 pattern item into flow rule handle.
 322  *
 323  * Additional mlx4-specific constraints on supported fields:
 324  *
 325  * - No support for partial masks.
 326  *
 327  * @param[in, out] flow
 328  *   Flow rule handle to update.
 329  * @param[in] item
 330  *   Pattern item to merge.
 331  * @param[in] proc
 332  *   Associated item-processing object.
 333  * @param[out] error
 334  *   Perform verbose error reporting if not NULL.
 335  *
 336  * @return
 337  *   0 on success, a negative errno value otherwise and rte_errno is set.
 338  */
 339 static int
 340 mlx4_flow_merge_ipv4(struct rte_flow *flow,
 341                      const struct rte_flow_item *item,
 342                      const struct mlx4_flow_proc_item *proc,
 343                      struct rte_flow_error *error)
 344 {
 345         const struct rte_flow_item_ipv4 *spec = item->spec;
 346         const struct rte_flow_item_ipv4 *mask =
 347                 spec ? (item->mask ? item->mask : proc->mask_default) : NULL;
 348         struct ibv_flow_spec_ipv4 *ipv4;
 349         const char *msg;
 350
 351         if (mask &&
 352             ((uint32_t)(mask->hdr.src_addr + 1) > UINT32_C(1) ||
 353              (uint32_t)(mask->hdr.dst_addr + 1) > UINT32_C(1))) {
 354                 msg = "mlx4 does not support matching partial IPv4 fields";
 355                 goto error;
 356         }
 357         if (!flow->ibv_attr)
 358                 return 0;
 359         ++flow->ibv_attr->num_of_specs;
 360         ipv4 = (void *)((uintptr_t)flow->ibv_attr + flow->ibv_attr_size);
 361         *ipv4 = (struct ibv_flow_spec_ipv4) {
 362                 .type = IBV_FLOW_SPEC_IPV4,
 363                 .size = sizeof(*ipv4),
 364         };
 365         if (!spec)
 366                 return 0;
 367         ipv4->val = (struct ibv_flow_ipv4_filter) {
 368                 .src_ip = spec->hdr.src_addr,
 369                 .dst_ip = spec->hdr.dst_addr,
 370         };
 371         ipv4->mask = (struct ibv_flow_ipv4_filter) {
 372                 .src_ip = mask->hdr.src_addr,
 373                 .dst_ip = mask->hdr.dst_addr,
 374         };
 375         /* Remove unwanted bits from values. */
 376         ipv4->val.src_ip &= ipv4->mask.src_ip;
 377         ipv4->val.dst_ip &= ipv4->mask.dst_ip;
 378         return 0;
 379 error:
 380         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 381                                   item, msg);
 382 }
 383
 384 /**
 385  * Merge UDP pattern item into flow rule handle.
 386  *
 387  * Additional mlx4-specific constraints on supported fields:
 388  *
 389  * - No support for partial masks.
 390  * - Due to HW/FW limitation, flow rule priority is not taken into account
 391  *   when matching UDP destination ports, doing is therefore only supported
 392  *   at the highest priority level (0).
 393  *
 394  * @param[in, out] flow
 395  *   Flow rule handle to update.
 396  * @param[in] item
 397  *   Pattern item to merge.
 398  * @param[in] proc
 399  *   Associated item-processing object.
 400  * @param[out] error
 401  *   Perform verbose error reporting if not NULL.
 402  *
 403  * @return
 404  *   0 on success, a negative errno value otherwise and rte_errno is set.
 405  */
 406 static int
 407 mlx4_flow_merge_udp(struct rte_flow *flow,
 408                     const struct rte_flow_item *item,
 409                     const struct mlx4_flow_proc_item *proc,
 410                     struct rte_flow_error *error)
 411 {
 412         const struct rte_flow_item_udp *spec = item->spec;
 413         const struct rte_flow_item_udp *mask =
 414                 spec ? (item->mask ? item->mask : proc->mask_default) : NULL;
 415         struct ibv_flow_spec_tcp_udp *udp;
 416         const char *msg;
 417
 418         if (mask &&
 419             ((uint16_t)(mask->hdr.src_port + 1) > UINT16_C(1) ||
 420              (uint16_t)(mask->hdr.dst_port + 1) > UINT16_C(1))) {
 421                 msg = "mlx4 does not support matching partial UDP fields";
 422                 goto error;
 423         }
 424         if (mask && mask->hdr.dst_port && flow->priority) {
 425                 msg = "combining UDP destination port matching with a nonzero"
 426                         " priority level is not supported";
 427                 goto error;
 428         }
 429         if (!flow->ibv_attr)
 430                 return 0;
 431         ++flow->ibv_attr->num_of_specs;
 432         udp = (void *)((uintptr_t)flow->ibv_attr + flow->ibv_attr_size);
 433         *udp = (struct ibv_flow_spec_tcp_udp) {
 434                 .type = IBV_FLOW_SPEC_UDP,
 435                 .size = sizeof(*udp),
 436         };
 437         if (!spec)
 438                 return 0;
 439         udp->val.dst_port = spec->hdr.dst_port;
 440         udp->val.src_port = spec->hdr.src_port;
 441         udp->mask.dst_port = mask->hdr.dst_port;
 442         udp->mask.src_port = mask->hdr.src_port;
 443         /* Remove unwanted bits from values. */
 444         udp->val.src_port &= udp->mask.src_port;
 445         udp->val.dst_port &= udp->mask.dst_port;
 446         return 0;
 447 error:
 448         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 449                                   item, msg);
 450 }
 451
 452 /**
 453  * Merge TCP pattern item into flow rule handle.
 454  *
 455  * Additional mlx4-specific constraints on supported fields:
 456  *
 457  * - No support for partial masks.
 458  *
 459  * @param[in, out] flow
 460  *   Flow rule handle to update.
 461  * @param[in] item
 462  *   Pattern item to merge.
 463  * @param[in] proc
 464  *   Associated item-processing object.
 465  * @param[out] error
 466  *   Perform verbose error reporting if not NULL.
 467  *
 468  * @return
 469  *   0 on success, a negative errno value otherwise and rte_errno is set.
 470  */
 471 static int
 472 mlx4_flow_merge_tcp(struct rte_flow *flow,
 473                     const struct rte_flow_item *item,
 474                     const struct mlx4_flow_proc_item *proc,
 475                     struct rte_flow_error *error)
 476 {
 477         const struct rte_flow_item_tcp *spec = item->spec;
 478         const struct rte_flow_item_tcp *mask =
 479                 spec ? (item->mask ? item->mask : proc->mask_default) : NULL;
 480         struct ibv_flow_spec_tcp_udp *tcp;
 481         const char *msg;
 482
 483         if (mask &&
 484             ((uint16_t)(mask->hdr.src_port + 1) > UINT16_C(1) ||
 485              (uint16_t)(mask->hdr.dst_port + 1) > UINT16_C(1))) {
 486                 msg = "mlx4 does not support matching partial TCP fields";
 487                 goto error;
 488         }
 489         if (!flow->ibv_attr)
 490                 return 0;
 491         ++flow->ibv_attr->num_of_specs;
 492         tcp = (void *)((uintptr_t)flow->ibv_attr + flow->ibv_attr_size);
 493         *tcp = (struct ibv_flow_spec_tcp_udp) {
 494                 .type = IBV_FLOW_SPEC_TCP,
 495                 .size = sizeof(*tcp),
 496         };
 497         if (!spec)
 498                 return 0;
 499         tcp->val.dst_port = spec->hdr.dst_port;
 500         tcp->val.src_port = spec->hdr.src_port;
 501         tcp->mask.dst_port = mask->hdr.dst_port;
 502         tcp->mask.src_port = mask->hdr.src_port;
 503         /* Remove unwanted bits from values. */
 504         tcp->val.src_port &= tcp->mask.src_port;
 505         tcp->val.dst_port &= tcp->mask.dst_port;
 506         return 0;
 507 error:
 508         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 509                                   item, msg);
 510 }
 511
 512 /**
 513  * Perform basic sanity checks on a pattern item.
 514  *
 515  * @param[in] item
 516  *   Item specification.
 517  * @param[in] proc
 518  *   Associated item-processing object.
 519  * @param[out] error
 520  *   Perform verbose error reporting if not NULL.
 521  *
 522  * @return
 523  *   0 on success, a negative errno value otherwise and rte_errno is set.
 524  */
 525 static int
 526 mlx4_flow_item_check(const struct rte_flow_item *item,
 527                      const struct mlx4_flow_proc_item *proc,
 528                      struct rte_flow_error *error)
 529 {
 530         const uint8_t *mask;
 531         unsigned int i;
 532
 533         /* item->last and item->mask cannot exist without item->spec. */
 534         if (!item->spec && (item->mask || item->last))
 535                 return rte_flow_error_set
 536                         (error, EINVAL, RTE_FLOW_ERROR_TYPE_ITEM, item,
 537                          "\"mask\" or \"last\" field provided without a"
 538                          " corresponding \"spec\"");
 539         /* No spec, no mask, no problem. */
 540         if (!item->spec)
 541                 return 0;
 542         mask = item->mask ?
 543                 (const uint8_t *)item->mask :
 544                 (const uint8_t *)proc->mask_default;
 545         assert(mask);
 546         /*
 547          * Single-pass check to make sure that:
 548          * - Mask is supported, no bits are set outside proc->mask_support.
 549          * - Both item->spec and item->last are included in mask.
 550          */
 551         for (i = 0; i != proc->mask_sz; ++i) {
 552                 if (!mask[i])
 553                         continue;
 554                 if ((mask[i] | ((const uint8_t *)proc->mask_support)[i]) !=
 555                     ((const uint8_t *)proc->mask_support)[i])
 556                         return rte_flow_error_set
 557                                 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 558                                  item, "unsupported field found in \"mask\"");
 559                 if (item->last &&
 560                     (((const uint8_t *)item->spec)[i] & mask[i]) !=
 561                     (((const uint8_t *)item->last)[i] & mask[i]))
 562                         return rte_flow_error_set
 563                                 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 564                                  item,
 565                                  "range between \"spec\" and \"last\""
 566                                  " is larger than \"mask\"");
 567         }
 568         return 0;
 569 }
 570
 571 /** Graph of supported items and associated actions. */
 572 static const struct mlx4_flow_proc_item mlx4_flow_proc_item_list[] = {
 573         [RTE_FLOW_ITEM_TYPE_END] = {
 574                 .next_item = NEXT_ITEM(RTE_FLOW_ITEM_TYPE_ETH),
 575         },
 576         [RTE_FLOW_ITEM_TYPE_ETH] = {
 577                 .next_item = NEXT_ITEM(RTE_FLOW_ITEM_TYPE_VLAN,
 578                                        RTE_FLOW_ITEM_TYPE_IPV4),
 579                 .mask_support = &(const struct rte_flow_item_eth){
 580                         /* Only destination MAC can be matched. */
 581                         .dst.addr_bytes = "\xff\xff\xff\xff\xff\xff",
 582                 },
 583                 .mask_default = &rte_flow_item_eth_mask,
 584                 .mask_sz = sizeof(struct rte_flow_item_eth),
 585                 .merge = mlx4_flow_merge_eth,
 586                 .dst_sz = sizeof(struct ibv_flow_spec_eth),
 587         },
 588         [RTE_FLOW_ITEM_TYPE_VLAN] = {
 589                 .next_item = NEXT_ITEM(RTE_FLOW_ITEM_TYPE_IPV4),
 590                 .mask_support = &(const struct rte_flow_item_vlan){
 591                         /* Only TCI VID matching is supported. */
 592                         .tci = RTE_BE16(0x0fff),
 593                 },
 594                 .mask_default = &rte_flow_item_vlan_mask,
 595                 .mask_sz = sizeof(struct rte_flow_item_vlan),
 596                 .merge = mlx4_flow_merge_vlan,
 597                 .dst_sz = 0,
 598         },
 599         [RTE_FLOW_ITEM_TYPE_IPV4] = {
 600                 .next_item = NEXT_ITEM(RTE_FLOW_ITEM_TYPE_UDP,
 601                                        RTE_FLOW_ITEM_TYPE_TCP),
 602                 .mask_support = &(const struct rte_flow_item_ipv4){
 603                         .hdr = {
 604                                 .src_addr = RTE_BE32(0xffffffff),
 605                                 .dst_addr = RTE_BE32(0xffffffff),
 606                         },
 607                 },
 608                 .mask_default = &rte_flow_item_ipv4_mask,
 609                 .mask_sz = sizeof(struct rte_flow_item_ipv4),
 610                 .merge = mlx4_flow_merge_ipv4,
 611                 .dst_sz = sizeof(struct ibv_flow_spec_ipv4),
 612         },
 613         [RTE_FLOW_ITEM_TYPE_UDP] = {
 614                 .mask_support = &(const struct rte_flow_item_udp){
 615                         .hdr = {
 616                                 .src_port = RTE_BE16(0xffff),
 617                                 .dst_port = RTE_BE16(0xffff),
 618                         },
 619                 },
 620                 .mask_default = &rte_flow_item_udp_mask,
 621                 .mask_sz = sizeof(struct rte_flow_item_udp),
 622                 .merge = mlx4_flow_merge_udp,
 623                 .dst_sz = sizeof(struct ibv_flow_spec_tcp_udp),
 624         },
 625         [RTE_FLOW_ITEM_TYPE_TCP] = {
 626                 .mask_support = &(const struct rte_flow_item_tcp){
 627                         .hdr = {
 628                                 .src_port = RTE_BE16(0xffff),
 629                                 .dst_port = RTE_BE16(0xffff),
 630                         },
 631                 },
 632                 .mask_default = &rte_flow_item_tcp_mask,
 633                 .mask_sz = sizeof(struct rte_flow_item_tcp),
 634                 .merge = mlx4_flow_merge_tcp,
 635                 .dst_sz = sizeof(struct ibv_flow_spec_tcp_udp),
 636         },
 637 };
 638
 639 /**
 640  * Make sure a flow rule is supported and initialize associated structure.
 641  *
 642  * @param priv
 643  *   Pointer to private structure.
 644  * @param[in] attr
 645  *   Flow rule attributes.
 646  * @param[in] pattern
 647  *   Pattern specification (list terminated by the END pattern item).
 648  * @param[in] actions
 649  *   Associated actions (list terminated by the END action).
 650  * @param[out] error
 651  *   Perform verbose error reporting if not NULL.
 652  * @param[in, out] addr
 653  *   Buffer where the resulting flow rule handle pointer must be stored.
 654  *   If NULL, stop processing after validation stage.
 655  *
 656  * @return
 657  *   0 on success, a negative errno value otherwise and rte_errno is set.
 658  */
 659 static int
 660 mlx4_flow_prepare(struct priv *priv,
 661                   const struct rte_flow_attr *attr,
 662                   const struct rte_flow_item pattern[],
 663                   const struct rte_flow_action actions[],
 664                   struct rte_flow_error *error,
 665                   struct rte_flow **addr)
 666 {
 667         const struct rte_flow_item *item;
 668         const struct rte_flow_action *action;
 669         const struct mlx4_flow_proc_item *proc;
 670         struct rte_flow temp = { .ibv_attr_size = sizeof(*temp.ibv_attr) };
 671         struct rte_flow *flow = &temp;
 672         const char *msg = NULL;
 673         int overlap;
 674
 675         if (attr->group)
 676                 return rte_flow_error_set
 677                         (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ATTR_GROUP,
 678                          NULL, "groups are not supported");
 679         if (attr->priority > MLX4_FLOW_PRIORITY_LAST)
 680                 return rte_flow_error_set
 681                         (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY,
 682                          NULL, "maximum priority level is "
 683                          MLX4_STR_EXPAND(MLX4_FLOW_PRIORITY_LAST));
 684         if (attr->egress)
 685                 return rte_flow_error_set
 686                         (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ATTR_EGRESS,
 687                          NULL, "egress is not supported");
 688         if (attr->transfer)
 689                 return rte_flow_error_set
 690                         (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER,
 691                          NULL, "transfer is not supported");
 692         if (!attr->ingress)
 693                 return rte_flow_error_set
 694                         (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ATTR_INGRESS,
 695                          NULL, "only ingress is supported");
 696 fill:
 697         overlap = 0;
 698         proc = mlx4_flow_proc_item_list;
 699         flow->priority = attr->priority;
 700         /* Go over pattern. */
 701         for (item = pattern; item->type; ++item) {
 702                 const struct mlx4_flow_proc_item *next = NULL;
 703                 unsigned int i;
 704                 int err;
 705
 706                 if (item->type == RTE_FLOW_ITEM_TYPE_VOID)
 707                         continue;
 708                 if (item->type == MLX4_FLOW_ITEM_TYPE_INTERNAL) {
 709                         flow->internal = 1;
 710                         continue;
 711                 }
 712                 if (flow->promisc || flow->allmulti) {
 713                         msg = "mlx4 does not support additional matching"
 714                                 " criteria combined with indiscriminate"
 715                                 " matching on Ethernet headers";
 716                         goto exit_item_not_supported;
 717                 }
 718                 for (i = 0; proc->next_item && proc->next_item[i]; ++i) {
 719                         if (proc->next_item[i] == item->type) {
 720                                 next = &mlx4_flow_proc_item_list[item->type];
 721                                 break;
 722                         }
 723                 }
 724                 if (!next)
 725                         goto exit_item_not_supported;
 726                 proc = next;
 727                 /*
 728                  * Perform basic sanity checks only once, while handle is
 729                  * not allocated.
 730                  */
 731                 if (flow == &temp) {
 732                         err = mlx4_flow_item_check(item, proc, error);
 733                         if (err)
 734                                 return err;
 735                 }
 736                 if (proc->merge) {
 737                         err = proc->merge(flow, item, proc, error);
 738                         if (err)
 739                                 return err;
 740                 }
 741                 flow->ibv_attr_size += proc->dst_sz;
 742         }
 743         /* Go over actions list. */
 744         for (action = actions; action->type; ++action) {
 745                 /* This one may appear anywhere multiple times. */
 746                 if (action->type == RTE_FLOW_ACTION_TYPE_VOID)
 747                         continue;
 748                 /* Fate-deciding actions may appear exactly once. */
 749                 if (overlap) {
 750                         msg = "cannot combine several fate-deciding actions,"
 751                                 " choose between DROP, QUEUE or RSS";
 752                         goto exit_action_not_supported;
 753                 }
 754                 overlap = 1;
 755                 switch (action->type) {
 756                         const struct rte_flow_action_queue *queue;
 757                         const struct rte_flow_action_rss *rss;
 758                         const uint8_t *rss_key;
 759                         uint32_t rss_key_len;
 760                         uint64_t fields;
 761                         unsigned int i;
 762
 763                 case RTE_FLOW_ACTION_TYPE_DROP:
 764                         flow->drop = 1;
 765                         break;
 766                 case RTE_FLOW_ACTION_TYPE_QUEUE:
 767                         if (flow->rss)
 768                                 break;
 769                         queue = action->conf;
 770                         if (queue->index >= priv->dev->data->nb_rx_queues) {
 771                                 msg = "queue target index beyond number of"
 772                                         " configured Rx queues";
 773                                 goto exit_action_not_supported;
 774                         }
 775                         flow->rss = mlx4_rss_get
 776                                 (priv, 0, mlx4_rss_hash_key_default, 1,
 777                                  &queue->index);
 778                         if (!flow->rss) {
 779                                 msg = "not enough resources for additional"
 780                                         " single-queue RSS context";
 781                                 goto exit_action_not_supported;
 782                         }
 783                         break;
 784                 case RTE_FLOW_ACTION_TYPE_RSS:
 785                         if (flow->rss)
 786                                 break;
 787                         rss = action->conf;
 788                         /* Default RSS configuration if none is provided. */
 789                         if (rss->key_len) {
 790                                 rss_key = rss->key;
 791                                 rss_key_len = rss->key_len;
 792                         } else {
 793                                 rss_key = mlx4_rss_hash_key_default;
 794                                 rss_key_len = MLX4_RSS_HASH_KEY_SIZE;
 795                         }
 796                         /* Sanity checks. */
 797                         for (i = 0; i < rss->queue_num; ++i)
 798                                 if (rss->queue[i] >=
 799                                     priv->dev->data->nb_rx_queues)
 800                                         break;
 801                         if (i != rss->queue_num) {
 802                                 msg = "queue index target beyond number of"
 803                                         " configured Rx queues";
 804                                 goto exit_action_not_supported;
 805                         }
 806                         if (!rte_is_power_of_2(rss->queue_num)) {
 807                                 msg = "for RSS, mlx4 requires the number of"
 808                                         " queues to be a power of two";
 809                                 goto exit_action_not_supported;
 810                         }
 811                         if (rss_key_len != sizeof(flow->rss->key)) {
 812                                 msg = "mlx4 supports exactly one RSS hash key"
 813                                         " length: "
 814                                         MLX4_STR_EXPAND(MLX4_RSS_HASH_KEY_SIZE);
 815                                 goto exit_action_not_supported;
 816                         }
 817                         for (i = 1; i < rss->queue_num; ++i)
 818                                 if (rss->queue[i] - rss->queue[i - 1] != 1)
 819                                         break;
 820                         if (i != rss->queue_num) {
 821                                 msg = "mlx4 requires RSS contexts to use"
 822                                         " consecutive queue indices only";
 823                                 goto exit_action_not_supported;
 824                         }
 825                         if (rss->queue[0] % rss->queue_num) {
 826                                 msg = "mlx4 requires the first queue of a RSS"
 827                                         " context to be aligned on a multiple"
 828                                         " of the context size";
 829                                 goto exit_action_not_supported;
 830                         }
 831                         if (rss->func &&
 832                             rss->func != RTE_ETH_HASH_FUNCTION_TOEPLITZ) {
 833                                 msg = "the only supported RSS hash function"
 834                                         " is Toeplitz";
 835                                 goto exit_action_not_supported;
 836                         }
 837                         if (rss->level) {
 838                                 msg = "a nonzero RSS encapsulation level is"
 839                                         " not supported";
 840                                 goto exit_action_not_supported;
 841                         }
 842                         rte_errno = 0;
 843                         fields = mlx4_conv_rss_types(priv, rss->types, 0);
 844                         if (fields == (uint64_t)-1 && rte_errno) {
 845                                 msg = "unsupported RSS hash type requested";
 846                                 goto exit_action_not_supported;
 847                         }
 848                         flow->rss = mlx4_rss_get
 849                                 (priv, fields, rss_key, rss->queue_num,
 850                                  rss->queue);
 851                         if (!flow->rss) {
 852                                 msg = "either invalid parameters or not enough"
 853                                         " resources for additional multi-queue"
 854                                         " RSS context";
 855                                 goto exit_action_not_supported;
 856                         }
 857                         break;
 858                 default:
 859                         goto exit_action_not_supported;
 860                 }
 861         }
 862         /* When fate is unknown, drop traffic. */
 863         if (!overlap)
 864                 flow->drop = 1;
 865         /* Validation ends here. */
 866         if (!addr) {
 867                 if (flow->rss)
 868                         mlx4_rss_put(flow->rss);
 869                 return 0;
 870         }
 871         if (flow == &temp) {
 872                 /* Allocate proper handle based on collected data. */
 873                 const struct mlx4_malloc_vec vec[] = {
 874                         {
 875                                 .align = alignof(struct rte_flow),
 876                                 .size = sizeof(*flow),
 877                                 .addr = (void **)&flow,
 878                         },
 879                         {
 880                                 .align = alignof(struct ibv_flow_attr),
 881                                 .size = temp.ibv_attr_size,
 882                                 .addr = (void **)&temp.ibv_attr,
 883                         },
 884                 };
 885
 886                 if (!mlx4_zmallocv(__func__, vec, RTE_DIM(vec))) {
 887                         if (temp.rss)
 888                                 mlx4_rss_put(temp.rss);
 889                         return rte_flow_error_set
 890                                 (error, -rte_errno,
 891                                  RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
 892                                  "flow rule handle allocation failure");
 893                 }
 894                 /* Most fields will be updated by second pass. */
 895                 *flow = (struct rte_flow){
 896                         .ibv_attr = temp.ibv_attr,
 897                         .ibv_attr_size = sizeof(*flow->ibv_attr),
 898                         .rss = temp.rss,
 899                 };
 900                 *flow->ibv_attr = (struct ibv_flow_attr){
 901                         .type = IBV_FLOW_ATTR_NORMAL,
 902                         .size = sizeof(*flow->ibv_attr),
 903                         .priority = attr->priority,
 904                         .port = priv->port,
 905                 };
 906                 goto fill;
 907         }
 908         *addr = flow;
 909         return 0;
 910 exit_item_not_supported:
 911         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM,
 912                                   item, msg ? msg : "item not supported");
 913 exit_action_not_supported:
 914         return rte_flow_error_set(error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
 915                                   action, msg ? msg : "action not supported");
 916 }
 917
 918 /**
 919  * Validate a flow supported by the NIC.
 920  *
 921  * @see rte_flow_validate()
 922  * @see rte_flow_ops
 923  */
 924 static int
 925 mlx4_flow_validate(struct rte_eth_dev *dev,
 926                    const struct rte_flow_attr *attr,
 927                    const struct rte_flow_item pattern[],
 928                    const struct rte_flow_action actions[],
 929                    struct rte_flow_error *error)
 930 {
 931         struct priv *priv = dev->data->dev_private;
 932
 933         return mlx4_flow_prepare(priv, attr, pattern, actions, error, NULL);
 934 }
 935
 936 /**
 937  * Get a drop flow rule resources instance.
 938  *
 939  * @param priv
 940  *   Pointer to private structure.
 941  *
 942  * @return
 943  *   Pointer to drop flow resources on success, NULL otherwise and rte_errno
 944  *   is set.
 945  */
 946 static struct mlx4_drop *
 947 mlx4_drop_get(struct priv *priv)
 948 {
 949         struct mlx4_drop *drop = priv->drop;
 950
 951         if (drop) {
 952                 assert(drop->refcnt);
 953                 assert(drop->priv == priv);
 954                 ++drop->refcnt;
 955                 return drop;
 956         }
 957         drop = rte_malloc(__func__, sizeof(*drop), 0);
 958         if (!drop)
 959                 goto error;
 960         *drop = (struct mlx4_drop){
 961                 .priv = priv,
 962                 .refcnt = 1,
 963         };
 964         drop->cq = mlx4_glue->create_cq(priv->ctx, 1, NULL, NULL, 0);
 965         if (!drop->cq)
 966                 goto error;
 967         drop->qp = mlx4_glue->create_qp
 968                 (priv->pd,
 969                  &(struct ibv_qp_init_attr){
 970                         .send_cq = drop->cq,
 971                         .recv_cq = drop->cq,
 972                         .qp_type = IBV_QPT_RAW_PACKET,
 973                  });
 974         if (!drop->qp)
 975                 goto error;
 976         priv->drop = drop;
 977         return drop;
 978 error:
 979         if (drop->qp)
 980                 claim_zero(mlx4_glue->destroy_qp(drop->qp));
 981         if (drop->cq)
 982                 claim_zero(mlx4_glue->destroy_cq(drop->cq));
 983         if (drop)
 984                 rte_free(drop);
 985         rte_errno = ENOMEM;
 986         return NULL;
 987 }
 988
 989 /**
 990  * Give back a drop flow rule resources instance.
 991  *
 992  * @param drop
 993  *   Pointer to drop flow rule resources.
 994  */
 995 static void
 996 mlx4_drop_put(struct mlx4_drop *drop)
 997 {
 998         assert(drop->refcnt);
 999         if (--drop->refcnt)
1000                 return;
1001         drop->priv->drop = NULL;
1002         claim_zero(mlx4_glue->destroy_qp(drop->qp));
1003         claim_zero(mlx4_glue->destroy_cq(drop->cq));
1004         rte_free(drop);
1005 }
1006
1007 /**
1008  * Toggle a configured flow rule.
1009  *
1010  * @param priv
1011  *   Pointer to private structure.
1012  * @param flow
1013  *   Flow rule handle to toggle.
1014  * @param enable
1015  *   Whether associated Verbs flow must be created or removed.
1016  * @param[out] error
1017  *   Perform verbose error reporting if not NULL.
1018  *
1019  * @return
1020  *   0 on success, a negative errno value otherwise and rte_errno is set.
1021  */
1022 static int
1023 mlx4_flow_toggle(struct priv *priv,
1024                  struct rte_flow *flow,
1025                  int enable,
1026                  struct rte_flow_error *error)
1027 {
1028         struct ibv_qp *qp = NULL;
1029         const char *msg;
1030         int err;
1031
1032         if (!enable) {
1033                 if (!flow->ibv_flow)
1034                         return 0;
1035                 claim_zero(mlx4_glue->destroy_flow(flow->ibv_flow));
1036                 flow->ibv_flow = NULL;
1037                 if (flow->drop)
1038                         mlx4_drop_put(priv->drop);
1039                 else if (flow->rss)
1040                         mlx4_rss_detach(flow->rss);
1041                 return 0;
1042         }
1043         assert(flow->ibv_attr);
1044         if (!flow->internal &&
1045             !priv->isolated &&
1046             flow->ibv_attr->priority == MLX4_FLOW_PRIORITY_LAST) {
1047                 if (flow->ibv_flow) {
1048                         claim_zero(mlx4_glue->destroy_flow(flow->ibv_flow));
1049                         flow->ibv_flow = NULL;
1050                         if (flow->drop)
1051                                 mlx4_drop_put(priv->drop);
1052                         else if (flow->rss)
1053                                 mlx4_rss_detach(flow->rss);
1054                 }
1055                 err = EACCES;
1056                 msg = ("priority level "
1057                        MLX4_STR_EXPAND(MLX4_FLOW_PRIORITY_LAST)
1058                        " is reserved when not in isolated mode");
1059                 goto error;
1060         }
1061         if (flow->rss) {
1062                 struct mlx4_rss *rss = flow->rss;
1063                 int missing = 0;
1064                 unsigned int i;
1065
1066                 /* Stop at the first nonexistent target queue. */
1067                 for (i = 0; i != rss->queues; ++i)
1068                         if (rss->queue_id[i] >=
1069                             priv->dev->data->nb_rx_queues ||
1070                             !priv->dev->data->rx_queues[rss->queue_id[i]]) {
1071                                 missing = 1;
1072                                 break;
1073                         }
1074                 if (flow->ibv_flow) {
1075                         if (missing ^ !flow->drop)
1076                                 return 0;
1077                         /* Verbs flow needs updating. */
1078                         claim_zero(mlx4_glue->destroy_flow(flow->ibv_flow));
1079                         flow->ibv_flow = NULL;
1080                         if (flow->drop)
1081                                 mlx4_drop_put(priv->drop);
1082                         else
1083                                 mlx4_rss_detach(rss);
1084                 }
1085                 if (!missing) {
1086                         err = mlx4_rss_attach(rss);
1087                         if (err) {
1088                                 err = -err;
1089                                 msg = "cannot create indirection table or hash"
1090                                         " QP to associate flow rule with";
1091                                 goto error;
1092                         }
1093                         qp = rss->qp;
1094                 }
1095                 /* A missing target queue drops traffic implicitly. */
1096                 flow->drop = missing;
1097         }
1098         if (flow->drop) {
1099                 if (flow->ibv_flow)
1100                         return 0;
1101                 mlx4_drop_get(priv);
1102                 if (!priv->drop) {
1103                         err = rte_errno;
1104                         msg = "resources for drop flow rule cannot be created";
1105                         goto error;
1106                 }
1107                 qp = priv->drop->qp;
1108         }
1109         assert(qp);
1110         if (flow->ibv_flow)
1111                 return 0;
1112         flow->ibv_flow = mlx4_glue->create_flow(qp, flow->ibv_attr);
1113         if (flow->ibv_flow)
1114                 return 0;
1115         if (flow->drop)
1116                 mlx4_drop_put(priv->drop);
1117         else if (flow->rss)
1118                 mlx4_rss_detach(flow->rss);
1119         err = errno;
1120         msg = "flow rule rejected by device";
1121 error:
1122         return rte_flow_error_set
1123                 (error, err, RTE_FLOW_ERROR_TYPE_HANDLE, flow, msg);
1124 }
1125
1126 /**
1127  * Create a flow.
1128  *
1129  * @see rte_flow_create()
1130  * @see rte_flow_ops
1131  */
1132 static struct rte_flow *
1133 mlx4_flow_create(struct rte_eth_dev *dev,
1134                  const struct rte_flow_attr *attr,
1135                  const struct rte_flow_item pattern[],
1136                  const struct rte_flow_action actions[],
1137                  struct rte_flow_error *error)
1138 {
1139         struct priv *priv = dev->data->dev_private;
1140         struct rte_flow *flow;
1141         int err;
1142
1143         err = mlx4_flow_prepare(priv, attr, pattern, actions, error, &flow);
1144         if (err)
1145                 return NULL;
1146         err = mlx4_flow_toggle(priv, flow, priv->started, error);
1147         if (!err) {
1148                 struct rte_flow *curr = LIST_FIRST(&priv->flows);
1149
1150                 /* New rules are inserted after internal ones. */
1151                 if (!curr || !curr->internal) {
1152                         LIST_INSERT_HEAD(&priv->flows, flow, next);
1153                 } else {
1154                         while (LIST_NEXT(curr, next) &&
1155                                LIST_NEXT(curr, next)->internal)
1156                                 curr = LIST_NEXT(curr, next);
1157                         LIST_INSERT_AFTER(curr, flow, next);
1158                 }
1159                 return flow;
1160         }
1161         if (flow->rss)
1162                 mlx4_rss_put(flow->rss);
1163         rte_flow_error_set(error, -err, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
1164                            error->message);
1165         rte_free(flow);
1166         return NULL;
1167 }
1168
1169 /**
1170  * Configure isolated mode.
1171  *
1172  * @see rte_flow_isolate()
1173  * @see rte_flow_ops
1174  */
1175 static int
1176 mlx4_flow_isolate(struct rte_eth_dev *dev,
1177                   int enable,
1178                   struct rte_flow_error *error)
1179 {
1180         struct priv *priv = dev->data->dev_private;
1181
1182         if (!!enable == !!priv->isolated)
1183                 return 0;
1184         priv->isolated = !!enable;
1185         if (mlx4_flow_sync(priv, error)) {
1186                 priv->isolated = !enable;
1187                 return -rte_errno;
1188         }
1189         return 0;
1190 }
1191
1192 /**
1193  * Destroy a flow rule.
1194  *
1195  * @see rte_flow_destroy()
1196  * @see rte_flow_ops
1197  */
1198 static int
1199 mlx4_flow_destroy(struct rte_eth_dev *dev,
1200                   struct rte_flow *flow,
1201                   struct rte_flow_error *error)
1202 {
1203         struct priv *priv = dev->data->dev_private;
1204         int err = mlx4_flow_toggle(priv, flow, 0, error);
1205
1206         if (err)
1207                 return err;
1208         LIST_REMOVE(flow, next);
1209         if (flow->rss)
1210                 mlx4_rss_put(flow->rss);
1211         rte_free(flow);
1212         return 0;
1213 }
1214
1215 /**
1216  * Destroy user-configured flow rules.
1217  *
1218  * This function skips internal flows rules.
1219  *
1220  * @see rte_flow_flush()
1221  * @see rte_flow_ops
1222  */
1223 static int
1224 mlx4_flow_flush(struct rte_eth_dev *dev,
1225                 struct rte_flow_error *error)
1226 {
1227         struct priv *priv = dev->data->dev_private;
1228         struct rte_flow *flow = LIST_FIRST(&priv->flows);
1229
1230         while (flow) {
1231                 struct rte_flow *next = LIST_NEXT(flow, next);
1232
1233                 if (!flow->internal)
1234                         mlx4_flow_destroy(dev, flow, error);
1235                 flow = next;
1236         }
1237         return 0;
1238 }
1239
1240 /**
1241  * Helper function to determine the next configured VLAN filter.
1242  *
1243  * @param priv
1244  *   Pointer to private structure.
1245  * @param vlan
1246  *   VLAN ID to use as a starting point.
1247  *
1248  * @return
1249  *   Next configured VLAN ID or a high value (>= 4096) if there is none.
1250  */
1251 static uint16_t
1252 mlx4_flow_internal_next_vlan(struct priv *priv, uint16_t vlan)
1253 {
1254         while (vlan < 4096) {
1255                 if (priv->dev->data->vlan_filter_conf.ids[vlan / 64] &
1256                     (UINT64_C(1) << (vlan % 64)))
1257                         return vlan;
1258                 ++vlan;
1259         }
1260         return vlan;
1261 }
1262
1263 /**
1264  * Generate internal flow rules.
1265  *
1266  * Various flow rules are created depending on the mode the device is in:
1267  *
1268  * 1. Promiscuous:
1269  *       port MAC + broadcast + catch-all (VLAN filtering is ignored).
1270  * 2. All multicast:
1271  *       port MAC/VLAN + broadcast + catch-all multicast.
1272  * 3. Otherwise:
1273  *       port MAC/VLAN + broadcast MAC/VLAN.
1274  *
1275  * About MAC flow rules:
1276  *
1277  * - MAC flow rules are generated from @p dev->data->mac_addrs
1278  *   (@p priv->mac array).
1279  * - An additional flow rule for Ethernet broadcasts is also generated.
1280  * - All these are per-VLAN if @p DEV_RX_OFFLOAD_VLAN_FILTER
1281  *   is enabled and VLAN filters are configured.
1282  *
1283  * @param priv
1284  *   Pointer to private structure.
1285  * @param[out] error
1286  *   Perform verbose error reporting if not NULL.
1287  *
1288  * @return
1289  *   0 on success, a negative errno value otherwise and rte_errno is set.
1290  */
1291 static int
1292 mlx4_flow_internal(struct priv *priv, struct rte_flow_error *error)
1293 {
1294         struct rte_flow_attr attr = {
1295                 .priority = MLX4_FLOW_PRIORITY_LAST,
1296                 .ingress = 1,
1297         };
1298         struct rte_flow_item_eth eth_spec;
1299         const struct rte_flow_item_eth eth_mask = {
1300                 .dst.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1301         };
1302         const struct rte_flow_item_eth eth_allmulti = {
1303                 .dst.addr_bytes = "\x01\x00\x00\x00\x00\x00",
1304         };
1305         struct rte_flow_item_vlan vlan_spec;
1306         const struct rte_flow_item_vlan vlan_mask = {
1307                 .tci = RTE_BE16(0x0fff),
1308         };
1309         struct rte_flow_item pattern[] = {
1310                 {
1311                         .type = MLX4_FLOW_ITEM_TYPE_INTERNAL,
1312                 },
1313                 {
1314                         .type = RTE_FLOW_ITEM_TYPE_ETH,
1315                         .spec = &eth_spec,
1316                         .mask = &eth_mask,
1317                 },
1318                 {
1319                         /* Replaced with VLAN if filtering is enabled. */
1320                         .type = RTE_FLOW_ITEM_TYPE_END,
1321                 },
1322                 {
1323                         .type = RTE_FLOW_ITEM_TYPE_END,
1324                 },
1325         };
1326         /*
1327          * Round number of queues down to their previous power of 2 to
1328          * comply with RSS context limitations. Extra queues silently do not
1329          * get RSS by default.
1330          */
1331         uint32_t queues =
1332                 rte_align32pow2(priv->dev->data->nb_rx_queues + 1) >> 1;
1333         uint16_t queue[queues];
1334         struct rte_flow_action_rss action_rss = {
1335                 .func = RTE_ETH_HASH_FUNCTION_DEFAULT,
1336                 .level = 0,
1337                 .types = 0,
1338                 .key_len = MLX4_RSS_HASH_KEY_SIZE,
1339                 .queue_num = queues,
1340                 .key = mlx4_rss_hash_key_default,
1341                 .queue = queue,
1342         };
1343         struct rte_flow_action actions[] = {
1344                 {
1345                         .type = RTE_FLOW_ACTION_TYPE_RSS,
1346                         .conf = &action_rss,
1347                 },
1348                 {
1349                         .type = RTE_FLOW_ACTION_TYPE_END,
1350                 },
1351         };
1352         struct ether_addr *rule_mac = &eth_spec.dst;
1353         rte_be16_t *rule_vlan =
1354                 (priv->dev->data->dev_conf.rxmode.offloads &
1355                  DEV_RX_OFFLOAD_VLAN_FILTER) &&
1356                 !priv->dev->data->promiscuous ?
1357                 &vlan_spec.tci :
1358                 NULL;
1359         uint16_t vlan = 0;
1360         struct rte_flow *flow;
1361         unsigned int i;
1362         int err = 0;
1363
1364         /* Nothing to be done if there are no Rx queues. */
1365         if (!queues)
1366                 goto error;
1367         /* Prepare default RSS configuration. */
1368         for (i = 0; i != queues; ++i)
1369                 queue[i] = i;
1370         /*
1371          * Set up VLAN item if filtering is enabled and at least one VLAN
1372          * filter is configured.
1373          */
1374         if (rule_vlan) {
1375                 vlan = mlx4_flow_internal_next_vlan(priv, 0);
1376                 if (vlan < 4096) {
1377                         pattern[2] = (struct rte_flow_item){
1378                                 .type = RTE_FLOW_ITEM_TYPE_VLAN,
1379                                 .spec = &vlan_spec,
1380                                 .mask = &vlan_mask,
1381                         };
1382 next_vlan:
1383                         *rule_vlan = rte_cpu_to_be_16(vlan);
1384                 } else {
1385                         rule_vlan = NULL;
1386                 }
1387         }
1388         for (i = 0; i != RTE_DIM(priv->mac) + 1; ++i) {
1389                 const struct ether_addr *mac;
1390
1391                 /* Broadcasts are handled by an extra iteration. */
1392                 if (i < RTE_DIM(priv->mac))
1393                         mac = &priv->mac[i];
1394                 else
1395                         mac = &eth_mask.dst;
1396                 if (is_zero_ether_addr(mac))
1397                         continue;
1398                 /* Check if MAC flow rule is already present. */
1399                 for (flow = LIST_FIRST(&priv->flows);
1400                      flow && flow->internal;
1401                      flow = LIST_NEXT(flow, next)) {
1402                         const struct ibv_flow_spec_eth *eth =
1403                                 (const void *)((uintptr_t)flow->ibv_attr +
1404                                                sizeof(*flow->ibv_attr));
1405                         unsigned int j;
1406
1407                         if (!flow->mac)
1408                                 continue;
1409                         assert(flow->ibv_attr->type == IBV_FLOW_ATTR_NORMAL);
1410                         assert(flow->ibv_attr->num_of_specs == 1);
1411                         assert(eth->type == IBV_FLOW_SPEC_ETH);
1412                         assert(flow->rss);
1413                         if (rule_vlan &&
1414                             (eth->val.vlan_tag != *rule_vlan ||
1415                              eth->mask.vlan_tag != RTE_BE16(0x0fff)))
1416                                 continue;
1417                         if (!rule_vlan && eth->mask.vlan_tag)
1418                                 continue;
1419                         for (j = 0; j != sizeof(mac->addr_bytes); ++j)
1420                                 if (eth->val.dst_mac[j] != mac->addr_bytes[j] ||
1421                                     eth->mask.dst_mac[j] != UINT8_C(0xff) ||
1422                                     eth->val.src_mac[j] != UINT8_C(0x00) ||
1423                                     eth->mask.src_mac[j] != UINT8_C(0x00))
1424                                         break;
1425                         if (j != sizeof(mac->addr_bytes))
1426                                 continue;
1427                         if (flow->rss->queues != queues ||
1428                             memcmp(flow->rss->queue_id, action_rss.queue,
1429                                    queues * sizeof(flow->rss->queue_id[0])))
1430                                 continue;
1431                         break;
1432                 }
1433                 if (!flow || !flow->internal) {
1434                         /* Not found, create a new flow rule. */
1435                         memcpy(rule_mac, mac, sizeof(*mac));
1436                         flow = mlx4_flow_create(priv->dev, &attr, pattern,
1437                                                 actions, error);
1438                         if (!flow) {
1439                                 err = -rte_errno;
1440                                 goto error;
1441                         }
1442                 }
1443                 flow->select = 1;
1444                 flow->mac = 1;
1445         }
1446         if (rule_vlan) {
1447                 vlan = mlx4_flow_internal_next_vlan(priv, vlan + 1);
1448                 if (vlan < 4096)
1449                         goto next_vlan;
1450         }
1451         /* Take care of promiscuous and all multicast flow rules. */
1452         if (priv->dev->data->promiscuous || priv->dev->data->all_multicast) {
1453                 for (flow = LIST_FIRST(&priv->flows);
1454                      flow && flow->internal;
1455                      flow = LIST_NEXT(flow, next)) {
1456                         if (priv->dev->data->promiscuous) {
1457                                 if (flow->promisc)
1458                                         break;
1459                         } else {
1460                                 assert(priv->dev->data->all_multicast);
1461                                 if (flow->allmulti)
1462                                         break;
1463                         }
1464                 }
1465                 if (flow && flow->internal) {
1466                         assert(flow->rss);
1467                         if (flow->rss->queues != queues ||
1468                             memcmp(flow->rss->queue_id, action_rss.queue,
1469                                    queues * sizeof(flow->rss->queue_id[0])))
1470                                 flow = NULL;
1471                 }
1472                 if (!flow || !flow->internal) {
1473                         /* Not found, create a new flow rule. */
1474                         if (priv->dev->data->promiscuous) {
1475                                 pattern[1].spec = NULL;
1476                                 pattern[1].mask = NULL;
1477                         } else {
1478                                 assert(priv->dev->data->all_multicast);
1479                                 pattern[1].spec = &eth_allmulti;
1480                                 pattern[1].mask = &eth_allmulti;
1481                         }
1482                         pattern[2] = pattern[3];
1483                         flow = mlx4_flow_create(priv->dev, &attr, pattern,
1484                                                 actions, error);
1485                         if (!flow) {
1486                                 err = -rte_errno;
1487                                 goto error;
1488                         }
1489                 }
1490                 assert(flow->promisc || flow->allmulti);
1491                 flow->select = 1;
1492         }
1493 error:
1494         /* Clear selection and clean up stale internal flow rules. */
1495         flow = LIST_FIRST(&priv->flows);
1496         while (flow && flow->internal) {
1497                 struct rte_flow *next = LIST_NEXT(flow, next);
1498
1499                 if (!flow->select)
1500                         claim_zero(mlx4_flow_destroy(priv->dev, flow, error));
1501                 else
1502                         flow->select = 0;
1503                 flow = next;
1504         }
1505         return err;
1506 }
1507
1508 /**
1509  * Synchronize flow rules.
1510  *
1511  * This function synchronizes flow rules with the state of the device by
1512  * taking into account isolated mode and whether target queues are
1513  * configured.
1514  *
1515  * @param priv
1516  *   Pointer to private structure.
1517  * @param[out] error
1518  *   Perform verbose error reporting if not NULL.
1519  *
1520  * @return
1521  *   0 on success, a negative errno value otherwise and rte_errno is set.
1522  */
1523 int
1524 mlx4_flow_sync(struct priv *priv, struct rte_flow_error *error)
1525 {
1526         struct rte_flow *flow;
1527         int ret;
1528
1529         /* Internal flow rules are guaranteed to come first in the list. */
1530         if (priv->isolated) {
1531                 /*
1532                  * Get rid of them in isolated mode, stop at the first
1533                  * non-internal rule found.
1534                  */
1535                 for (flow = LIST_FIRST(&priv->flows);
1536                      flow && flow->internal;
1537                      flow = LIST_FIRST(&priv->flows))
1538                         claim_zero(mlx4_flow_destroy(priv->dev, flow, error));
1539         } else {
1540                 /* Refresh internal rules. */
1541                 ret = mlx4_flow_internal(priv, error);
1542                 if (ret)
1543                         return ret;
1544         }
1545         /* Toggle the remaining flow rules . */
1546         LIST_FOREACH(flow, &priv->flows, next) {
1547                 ret = mlx4_flow_toggle(priv, flow, priv->started, error);
1548                 if (ret)
1549                         return ret;
1550         }
1551         if (!priv->started)
1552                 assert(!priv->drop);
1553         return 0;
1554 }
1555
1556 /**
1557  * Clean up all flow rules.
1558  *
1559  * Unlike mlx4_flow_flush(), this function takes care of all remaining flow
1560  * rules regardless of whether they are internal or user-configured.
1561  *
1562  * @param priv
1563  *   Pointer to private structure.
1564  */
1565 void
1566 mlx4_flow_clean(struct priv *priv)
1567 {
1568         struct rte_flow *flow;
1569
1570         while ((flow = LIST_FIRST(&priv->flows)))
1571                 mlx4_flow_destroy(priv->dev, flow, NULL);
1572         assert(LIST_EMPTY(&priv->rss));
1573 }
1574
1575 static const struct rte_flow_ops mlx4_flow_ops = {
1576         .validate = mlx4_flow_validate,
1577         .create = mlx4_flow_create,
1578         .destroy = mlx4_flow_destroy,
1579         .flush = mlx4_flow_flush,
1580         .isolate = mlx4_flow_isolate,
1581 };
1582
1583 /**
1584  * Manage filter operations.
1585  *
1586  * @param dev
1587  *   Pointer to Ethernet device structure.
1588  * @param filter_type
1589  *   Filter type.
1590  * @param filter_op
1591  *   Operation to perform.
1592  * @param arg
1593  *   Pointer to operation-specific structure.
1594  *
1595  * @return
1596  *   0 on success, negative errno value otherwise and rte_errno is set.
1597  */
1598 int
1599 mlx4_filter_ctrl(struct rte_eth_dev *dev,
1600                  enum rte_filter_type filter_type,
1601                  enum rte_filter_op filter_op,
1602                  void *arg)
1603 {
1604         switch (filter_type) {
1605         case RTE_ETH_FILTER_GENERIC:
1606                 if (filter_op != RTE_ETH_FILTER_GET)
1607                         break;
1608                 *(const void **)arg = &mlx4_flow_ops;
1609                 return 0;
1610         default:
1611                 ERROR("%p: filter type (%d) not supported",
1612                       (void *)dev, filter_type);
1613                 break;
1614         }
1615         rte_errno = ENOTSUP;
1616         return -rte_errno;
1617 }