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 (scattered packets). */
  85 struct rxq_elt_sp {
  86         struct ibv_sge sges[MLX5_PMD_SGE_WR_N]; /* Scatter/Gather Elements. */
  87         struct rte_mbuf *bufs[MLX5_PMD_SGE_WR_N]; /* SGEs buffers. */
  88 };
  89
  90 /* RX element. */
  91 struct rxq_elt {
  92         struct ibv_sge sge; /* Scatter/Gather Element. */
  93         struct rte_mbuf *buf; /* SGE buffer. */
  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_mr *mr; /* Memory Region (for mp). */
 103         struct ibv_cq *cq; /* Completion Queue. */
 104         struct ibv_exp_wq *wq; /* Work Queue. */
 105         struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
 106         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 107         unsigned int port_id; /* Port ID for incoming packets. */
 108         unsigned int elts_n; /* (*elts)[] length. */
 109         unsigned int elts_head; /* Current index in (*elts)[]. */
 110         union {
 111                 struct rxq_elt_sp (*sp)[]; /* Scattered RX elements. */
 112                 struct rxq_elt (*no_sp)[]; /* RX elements. */
 113         } elts;
 114         unsigned int sp:1; /* Use scattered RX elements. */
 115         unsigned int csum:1; /* Enable checksum offloading. */
 116         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 117         uint32_t mb_len; /* Length of a mp-issued mbuf. */
 118         struct mlx5_rxq_stats stats; /* RX queue counters. */
 119         unsigned int socket; /* CPU socket ID for allocations. */
 120         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 121 };
 122
 123 /* Hash RX queue types. */
 124 enum hash_rxq_type {
 125         HASH_RXQ_TCPV4,
 126         HASH_RXQ_UDPV4,
 127         HASH_RXQ_IPV4,
 128 #ifdef HAVE_FLOW_SPEC_IPV6
 129         HASH_RXQ_TCPV6,
 130         HASH_RXQ_UDPV6,
 131         HASH_RXQ_IPV6,
 132 #endif /* HAVE_FLOW_SPEC_IPV6 */
 133         HASH_RXQ_ETH,
 134 };
 135
 136 /* Flow structure with Ethernet specification. It is packed to prevent padding
 137  * between attr and spec as this layout is expected by libibverbs. */
 138 struct flow_attr_spec_eth {
 139         struct ibv_exp_flow_attr attr;
 140         struct ibv_exp_flow_spec_eth spec;
 141 } __attribute__((packed));
 142
 143 /* Define a struct flow_attr_spec_eth object as an array of at least
 144  * "size" bytes. Room after the first index is normally used to store
 145  * extra flow specifications. */
 146 #define FLOW_ATTR_SPEC_ETH(name, size) \
 147         struct flow_attr_spec_eth name \
 148                 [((size) / sizeof(struct flow_attr_spec_eth)) + \
 149                  !!((size) % sizeof(struct flow_attr_spec_eth))]
 150
 151 /* Initialization data for hash RX queue. */
 152 struct hash_rxq_init {
 153         uint64_t hash_fields; /* Fields that participate in the hash. */
 154         uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
 155         unsigned int flow_priority; /* Flow priority to use. */
 156         union {
 157                 struct {
 158                         enum ibv_exp_flow_spec_type type;
 159                         uint16_t size;
 160                 } hdr;
 161                 struct ibv_exp_flow_spec_tcp_udp tcp_udp;
 162                 struct ibv_exp_flow_spec_ipv4 ipv4;
 163 #ifdef HAVE_FLOW_SPEC_IPV6
 164                 struct ibv_exp_flow_spec_ipv6 ipv6;
 165 #endif /* HAVE_FLOW_SPEC_IPV6 */
 166                 struct ibv_exp_flow_spec_eth eth;
 167         } flow_spec; /* Flow specification template. */
 168         const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
 169 };
 170
 171 /* Initialization data for indirection table. */
 172 struct ind_table_init {
 173         unsigned int max_size; /* Maximum number of WQs. */
 174         /* Hash RX queues using this table. */
 175         unsigned int hash_types;
 176         unsigned int hash_types_n;
 177 };
 178
 179 /* Initialization data for special flows. */
 180 struct special_flow_init {
 181         uint8_t dst_mac_val[6];
 182         uint8_t dst_mac_mask[6];
 183         unsigned int hash_types;
 184 };
 185
 186 enum hash_rxq_flow_type {
 187         HASH_RXQ_FLOW_TYPE_PROMISC,
 188         HASH_RXQ_FLOW_TYPE_ALLMULTI,
 189         HASH_RXQ_FLOW_TYPE_BROADCAST,
 190         HASH_RXQ_FLOW_TYPE_IPV6MULTI,
 191         HASH_RXQ_FLOW_TYPE_MAC,
 192 };
 193
 194 #ifndef NDEBUG
 195 static inline const char *
 196 hash_rxq_flow_type_str(enum hash_rxq_flow_type flow_type)
 197 {
 198         switch (flow_type) {
 199         case HASH_RXQ_FLOW_TYPE_PROMISC:
 200                 return "promiscuous";
 201         case HASH_RXQ_FLOW_TYPE_ALLMULTI:
 202                 return "allmulticast";
 203         case HASH_RXQ_FLOW_TYPE_BROADCAST:
 204                 return "broadcast";
 205         case HASH_RXQ_FLOW_TYPE_IPV6MULTI:
 206                 return "IPv6 multicast";
 207         case HASH_RXQ_FLOW_TYPE_MAC:
 208                 return "MAC";
 209         }
 210         return NULL;
 211 }
 212 #endif /* NDEBUG */
 213
 214 struct hash_rxq {
 215         struct priv *priv; /* Back pointer to private data. */
 216         struct ibv_qp *qp; /* Hash RX QP. */
 217         enum hash_rxq_type type; /* Hash RX queue type. */
 218         /* MAC flow steering rules, one per VLAN ID. */
 219         struct ibv_exp_flow *mac_flow[MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
 220         struct ibv_exp_flow *special_flow[MLX5_MAX_SPECIAL_FLOWS];
 221 };
 222
 223 /* TX element. */
 224 struct txq_elt {
 225         struct rte_mbuf *buf;
 226 };
 227
 228 /* Linear buffer type. It is used when transmitting buffers with too many
 229  * segments that do not fit the hardware queue (see max_send_sge).
 230  * Extra segments are copied (linearized) in such buffers, replacing the
 231  * last SGE during TX.
 232  * The size is arbitrary but large enough to hold a jumbo frame with
 233  * 8 segments considering mbuf.buf_len is about 2048 bytes. */
 234 typedef uint8_t linear_t[16384];
 235
 236 /* TX queue descriptor. */
 237 struct txq {
 238         struct priv *priv; /* Back pointer to private data. */
 239         struct {
 240                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 241                 struct ibv_mr *mr; /* Memory Region (for mp). */
 242                 uint32_t lkey; /* mr->lkey */
 243         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 244         struct ibv_cq *cq; /* Completion Queue. */
 245         struct ibv_qp *qp; /* Queue Pair. */
 246         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 247         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 248 #if MLX5_PMD_MAX_INLINE > 0
 249         uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
 250 #endif
 251         unsigned int elts_n; /* (*elts)[] length. */
 252         struct txq_elt (*elts)[]; /* TX elements. */
 253         unsigned int elts_head; /* Current index in (*elts)[]. */
 254         unsigned int elts_tail; /* First element awaiting completion. */
 255         unsigned int elts_comp; /* Number of completion requests. */
 256         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 257         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 258         struct mlx5_txq_stats stats; /* TX queue counters. */
 259         linear_t (*elts_linear)[]; /* Linearized buffers. */
 260         struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
 261         unsigned int socket; /* CPU socket ID for allocations. */
 262         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 263 };
 264
 265 /* mlx5_rxq.c */
 266
 267 extern const struct hash_rxq_init hash_rxq_init[];
 268 extern const unsigned int hash_rxq_init_n;
 269
 270 extern uint8_t rss_hash_default_key[];
 271 extern const size_t rss_hash_default_key_len;
 272
 273 size_t hash_rxq_flow_attr(const struct hash_rxq *, struct ibv_exp_flow_attr *,
 274                           size_t);
 275 int priv_create_hash_rxqs(struct priv *);
 276 void priv_destroy_hash_rxqs(struct priv *);
 277 int priv_allow_flow_type(struct priv *, enum hash_rxq_flow_type);
 278 int priv_rehash_flows(struct priv *);
 279 void rxq_cleanup(struct rxq *);
 280 int rxq_rehash(struct rte_eth_dev *, struct rxq *);
 281 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
 282               const struct rte_eth_rxconf *, struct rte_mempool *);
 283 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 284                         const struct rte_eth_rxconf *, struct rte_mempool *);
 285 void mlx5_rx_queue_release(void *);
 286
 287 /* mlx5_txq.c */
 288
 289 void txq_cleanup(struct txq *);
 290 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 291                         const struct rte_eth_txconf *);
 292 void mlx5_tx_queue_release(void *);
 293
 294 /* mlx5_rxtx.c */
 295
 296 void txq_mp2mr_iter(const struct rte_mempool *, void *);
 297 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 298 uint16_t mlx5_rx_burst_sp(void *, struct rte_mbuf **, uint16_t);
 299 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 300 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 301 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 302
 303 #endif /* RTE_PMD_MLX5_RXTX_H_ */