drivers/net/mlx5/mlx5_rxtx.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2015 6WIND S.A.
   5  *   Copyright 2015 Mellanox.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of 6WIND S.A. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef RTE_PMD_MLX5_RXTX_H_
  35 #define RTE_PMD_MLX5_RXTX_H_
  36
  37 #include <stddef.h>
  38 #include <stdint.h>
  39
  40 /* Verbs header. */
  41 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  42 #ifdef PEDANTIC
  43 #pragma GCC diagnostic ignored "-pedantic"
  44 #endif
  45 #include <infiniband/verbs.h>
  46 #ifdef PEDANTIC
  47 #pragma GCC diagnostic error "-pedantic"
  48 #endif
  49
  50 /* DPDK headers don't like -pedantic. */
  51 #ifdef PEDANTIC
  52 #pragma GCC diagnostic ignored "-pedantic"
  53 #endif
  54 #include <rte_mbuf.h>
  55 #include <rte_mempool.h>
  56 #ifdef PEDANTIC
  57 #pragma GCC diagnostic error "-pedantic"
  58 #endif
  59
  60 #include "mlx5_utils.h"
  61 #include "mlx5.h"
  62 #include "mlx5_autoconf.h"
  63 #include "mlx5_defs.h"
  64
  65 struct mlx5_rxq_stats {
  66         unsigned int idx; /**< Mapping index. */
  67 #ifdef MLX5_PMD_SOFT_COUNTERS
  68         uint64_t ipackets; /**< Total of successfully received packets. */
  69         uint64_t ibytes; /**< Total of successfully received bytes. */
  70 #endif
  71         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
  72         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
  73 };
  74
  75 struct mlx5_txq_stats {
  76         unsigned int idx; /**< Mapping index. */
  77 #ifdef MLX5_PMD_SOFT_COUNTERS
  78         uint64_t opackets; /**< Total of successfully sent packets. */
  79         uint64_t obytes; /**< Total of successfully sent bytes. */
  80 #endif
  81         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
  82 };
  83
  84 /* RX element. */
  85 struct rxq_elt {
  86         struct ibv_sge sge; /* Scatter/Gather Element. */
  87         struct rte_mbuf *buf; /* SGE buffer. */
  88 };
  89
  90 /* Flow director queue structure. */
  91 struct fdir_queue {
  92         struct ibv_qp *qp; /* Associated RX QP. */
  93         struct ibv_exp_rwq_ind_table *ind_table; /* Indirection table. */
  94 };
  95
  96 struct priv;
  97
  98 /* RX queue descriptor. */
  99 struct rxq {
 100         struct priv *priv; /* Back pointer to private data. */
 101         struct rte_mempool *mp; /* Memory Pool for allocations. */
 102         struct ibv_cq *cq; /* Completion Queue. */
 103         struct ibv_exp_wq *wq; /* Work Queue. */
 104         int32_t (*poll)(); /* Verbs poll function. */
 105         int32_t (*recv)(); /* Verbs receive function. */
 106         unsigned int port_id; /* Port ID for incoming packets. */
 107         unsigned int elts_n; /* (*elts)[] length. */
 108         unsigned int elts_head; /* Current index in (*elts)[]. */
 109         unsigned int csum:1; /* Enable checksum offloading. */
 110         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 111         unsigned int vlan_strip:1; /* Enable VLAN stripping. */
 112         unsigned int crc_present:1; /* CRC must be subtracted. */
 113         struct rxq_elt (*elts)[]; /* RX elements. */
 114         unsigned int socket; /* CPU socket ID for allocations. */
 115         struct mlx5_rxq_stats stats; /* RX queue counters. */
 116         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 117         struct fdir_queue fdir_queue; /* Flow director queue. */
 118         struct ibv_mr *mr; /* Memory Region (for mp). */
 119         struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
 120 #ifdef HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS
 121         struct ibv_exp_cq_family_v1 *if_cq; /* CQ interface. */
 122 #else /* HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS */
 123         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 124 #endif /* HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS */
 125 };
 126
 127 /* Hash RX queue types. */
 128 enum hash_rxq_type {
 129         HASH_RXQ_TCPV4,
 130         HASH_RXQ_UDPV4,
 131         HASH_RXQ_IPV4,
 132 #ifdef HAVE_FLOW_SPEC_IPV6
 133         HASH_RXQ_TCPV6,
 134         HASH_RXQ_UDPV6,
 135         HASH_RXQ_IPV6,
 136 #endif /* HAVE_FLOW_SPEC_IPV6 */
 137         HASH_RXQ_ETH,
 138 };
 139
 140 /* Flow structure with Ethernet specification. It is packed to prevent padding
 141  * between attr and spec as this layout is expected by libibverbs. */
 142 struct flow_attr_spec_eth {
 143         struct ibv_exp_flow_attr attr;
 144         struct ibv_exp_flow_spec_eth spec;
 145 } __attribute__((packed));
 146
 147 /* Define a struct flow_attr_spec_eth object as an array of at least
 148  * "size" bytes. Room after the first index is normally used to store
 149  * extra flow specifications. */
 150 #define FLOW_ATTR_SPEC_ETH(name, size) \
 151         struct flow_attr_spec_eth name \
 152                 [((size) / sizeof(struct flow_attr_spec_eth)) + \
 153                  !!((size) % sizeof(struct flow_attr_spec_eth))]
 154
 155 /* Initialization data for hash RX queue. */
 156 struct hash_rxq_init {
 157         uint64_t hash_fields; /* Fields that participate in the hash. */
 158         uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
 159         unsigned int flow_priority; /* Flow priority to use. */
 160         union {
 161                 struct {
 162                         enum ibv_exp_flow_spec_type type;
 163                         uint16_t size;
 164                 } hdr;
 165                 struct ibv_exp_flow_spec_tcp_udp tcp_udp;
 166                 struct ibv_exp_flow_spec_ipv4 ipv4;
 167 #ifdef HAVE_FLOW_SPEC_IPV6
 168                 struct ibv_exp_flow_spec_ipv6 ipv6;
 169 #endif /* HAVE_FLOW_SPEC_IPV6 */
 170                 struct ibv_exp_flow_spec_eth eth;
 171         } flow_spec; /* Flow specification template. */
 172         const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
 173 };
 174
 175 /* Initialization data for indirection table. */
 176 struct ind_table_init {
 177         unsigned int max_size; /* Maximum number of WQs. */
 178         /* Hash RX queues using this table. */
 179         unsigned int hash_types;
 180         unsigned int hash_types_n;
 181 };
 182
 183 /* Initialization data for special flows. */
 184 struct special_flow_init {
 185         uint8_t dst_mac_val[6];
 186         uint8_t dst_mac_mask[6];
 187         unsigned int hash_types;
 188         unsigned int per_vlan:1;
 189 };
 190
 191 enum hash_rxq_flow_type {
 192         HASH_RXQ_FLOW_TYPE_PROMISC,
 193         HASH_RXQ_FLOW_TYPE_ALLMULTI,
 194         HASH_RXQ_FLOW_TYPE_BROADCAST,
 195         HASH_RXQ_FLOW_TYPE_IPV6MULTI,
 196         HASH_RXQ_FLOW_TYPE_MAC,
 197 };
 198
 199 #ifndef NDEBUG
 200 static inline const char *
 201 hash_rxq_flow_type_str(enum hash_rxq_flow_type flow_type)
 202 {
 203         switch (flow_type) {
 204         case HASH_RXQ_FLOW_TYPE_PROMISC:
 205                 return "promiscuous";
 206         case HASH_RXQ_FLOW_TYPE_ALLMULTI:
 207                 return "allmulticast";
 208         case HASH_RXQ_FLOW_TYPE_BROADCAST:
 209                 return "broadcast";
 210         case HASH_RXQ_FLOW_TYPE_IPV6MULTI:
 211                 return "IPv6 multicast";
 212         case HASH_RXQ_FLOW_TYPE_MAC:
 213                 return "MAC";
 214         }
 215         return NULL;
 216 }
 217 #endif /* NDEBUG */
 218
 219 struct hash_rxq {
 220         struct priv *priv; /* Back pointer to private data. */
 221         struct ibv_qp *qp; /* Hash RX QP. */
 222         enum hash_rxq_type type; /* Hash RX queue type. */
 223         /* MAC flow steering rules, one per VLAN ID. */
 224         struct ibv_exp_flow *mac_flow
 225                 [MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
 226         struct ibv_exp_flow *special_flow
 227                 [MLX5_MAX_SPECIAL_FLOWS][MLX5_MAX_VLAN_IDS];
 228 };
 229
 230 /* TX element. */
 231 struct txq_elt {
 232         struct rte_mbuf *buf;
 233 };
 234
 235 /* TX queue descriptor. */
 236 struct txq {
 237         struct priv *priv; /* Back pointer to private data. */
 238         int32_t (*poll_cnt)(struct ibv_cq *cq, uint32_t max);
 239         int (*send_pending)();
 240 #ifdef HAVE_VERBS_VLAN_INSERTION
 241         int (*send_pending_vlan)();
 242 #endif
 243 #if MLX5_PMD_MAX_INLINE > 0
 244         int (*send_pending_inline)();
 245 #ifdef HAVE_VERBS_VLAN_INSERTION
 246         int (*send_pending_inline_vlan)();
 247 #endif
 248 #endif
 249         int (*send_flush)(struct ibv_qp *qp);
 250         struct ibv_cq *cq; /* Completion Queue. */
 251         struct ibv_qp *qp; /* Queue Pair. */
 252         struct txq_elt (*elts)[]; /* TX elements. */
 253 #if MLX5_PMD_MAX_INLINE > 0
 254         uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
 255 #endif
 256         unsigned int elts_n; /* (*elts)[] length. */
 257         unsigned int elts_head; /* Current index in (*elts)[]. */
 258         unsigned int elts_tail; /* First element awaiting completion. */
 259         unsigned int elts_comp; /* Number of completion requests. */
 260         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 261         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 262         struct {
 263                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 264                 struct ibv_mr *mr; /* Memory Region (for mp). */
 265                 uint32_t lkey; /* mr->lkey */
 266         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 267         struct mlx5_txq_stats stats; /* TX queue counters. */
 268 #ifdef HAVE_VERBS_VLAN_INSERTION
 269         struct ibv_exp_qp_burst_family_v1 *if_qp; /* QP burst interface. */
 270 #else
 271         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 272 #endif
 273         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 274         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 275         unsigned int socket; /* CPU socket ID for allocations. */
 276 };
 277
 278 /* mlx5_rxq.c */
 279
 280 extern const struct hash_rxq_init hash_rxq_init[];
 281 extern const unsigned int hash_rxq_init_n;
 282
 283 extern uint8_t rss_hash_default_key[];
 284 extern const size_t rss_hash_default_key_len;
 285
 286 size_t priv_flow_attr(struct priv *, struct ibv_exp_flow_attr *,
 287                       size_t, enum hash_rxq_type);
 288 int priv_create_hash_rxqs(struct priv *);
 289 void priv_destroy_hash_rxqs(struct priv *);
 290 int priv_allow_flow_type(struct priv *, enum hash_rxq_flow_type);
 291 int priv_rehash_flows(struct priv *);
 292 void rxq_cleanup(struct rxq *);
 293 int rxq_rehash(struct rte_eth_dev *, struct rxq *);
 294 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
 295               const struct rte_eth_rxconf *, struct rte_mempool *);
 296 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 297                         const struct rte_eth_rxconf *, struct rte_mempool *);
 298 void mlx5_rx_queue_release(void *);
 299 uint16_t mlx5_rx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 300
 301 /* mlx5_txq.c */
 302
 303 void txq_cleanup(struct txq *);
 304 int txq_setup(struct rte_eth_dev *, struct txq *, uint16_t, unsigned int,
 305               const struct rte_eth_txconf *);
 306 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 307                         const struct rte_eth_txconf *);
 308 void mlx5_tx_queue_release(void *);
 309 uint16_t mlx5_tx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 310
 311 /* mlx5_rxtx.c */
 312
 313 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 314 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 315 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 316 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 317
 318 /* mlx5_mr.c */
 319
 320 struct ibv_mr *mlx5_mp2mr(struct ibv_pd *, struct rte_mempool *);
 321 void txq_mp2mr_iter(struct rte_mempool *, void *);
 322 uint32_t txq_mp2mr_reg(struct txq *, struct rte_mempool *, unsigned int);
 323
 324 #endif /* RTE_PMD_MLX5_RXTX_H_ */