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 <stdint.h>
  38
  39 /* Verbs header. */
  40 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  41 #ifdef PEDANTIC
  42 #pragma GCC diagnostic ignored "-pedantic"
  43 #endif
  44 #include <infiniband/verbs.h>
  45 #ifdef PEDANTIC
  46 #pragma GCC diagnostic error "-pedantic"
  47 #endif
  48
  49 /* DPDK headers don't like -pedantic. */
  50 #ifdef PEDANTIC
  51 #pragma GCC diagnostic ignored "-pedantic"
  52 #endif
  53 #include <rte_mbuf.h>
  54 #include <rte_mempool.h>
  55 #ifdef PEDANTIC
  56 #pragma GCC diagnostic error "-pedantic"
  57 #endif
  58
  59 #include "mlx5_utils.h"
  60 #include "mlx5.h"
  61 #include "mlx5_defs.h"
  62
  63 struct mlx5_rxq_stats {
  64         unsigned int idx; /**< Mapping index. */
  65 #ifdef MLX5_PMD_SOFT_COUNTERS
  66         uint64_t ipackets; /**< Total of successfully received packets. */
  67         uint64_t ibytes; /**< Total of successfully received bytes. */
  68 #endif
  69         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
  70         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
  71 };
  72
  73 struct mlx5_txq_stats {
  74         unsigned int idx; /**< Mapping index. */
  75 #ifdef MLX5_PMD_SOFT_COUNTERS
  76         uint64_t opackets; /**< Total of successfully sent packets. */
  77         uint64_t obytes; /**< Total of successfully sent bytes. */
  78 #endif
  79         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
  80 };
  81
  82 /* RX element (scattered packets). */
  83 struct rxq_elt_sp {
  84         struct ibv_recv_wr wr; /* Work Request. */
  85         struct ibv_sge sges[MLX5_PMD_SGE_WR_N]; /* Scatter/Gather Elements. */
  86         struct rte_mbuf *bufs[MLX5_PMD_SGE_WR_N]; /* SGEs buffers. */
  87 };
  88
  89 /* RX element. */
  90 struct rxq_elt {
  91         struct ibv_recv_wr wr; /* Work Request. */
  92         struct ibv_sge sge; /* Scatter/Gather Element. */
  93         /* mbuf pointer is derived from WR_ID(wr.wr_id).offset. */
  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_qp *qp; /* Queue Pair. */
 105         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 106         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 107         /* MAC flow steering rules. */
 108         struct ibv_flow *mac_flow[MLX5_MAX_MAC_ADDRESSES];
 109         unsigned int port_id; /* Port ID for incoming packets. */
 110         unsigned int elts_n; /* (*elts)[] length. */
 111         unsigned int elts_head; /* Current index in (*elts)[]. */
 112         union {
 113                 struct rxq_elt_sp (*sp)[]; /* Scattered RX elements. */
 114                 struct rxq_elt (*no_sp)[]; /* RX elements. */
 115         } elts;
 116         unsigned int sp:1; /* Use scattered RX elements. */
 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 /* TX element. */
 124 struct txq_elt {
 125         struct rte_mbuf *buf;
 126 };
 127
 128 /* Linear buffer type. It is used when transmitting buffers with too many
 129  * segments that do not fit the hardware queue (see max_send_sge).
 130  * Extra segments are copied (linearized) in such buffers, replacing the
 131  * last SGE during TX.
 132  * The size is arbitrary but large enough to hold a jumbo frame with
 133  * 8 segments considering mbuf.buf_len is about 2048 bytes. */
 134 typedef uint8_t linear_t[16384];
 135
 136 /* TX queue descriptor. */
 137 struct txq {
 138         struct priv *priv; /* Back pointer to private data. */
 139         struct {
 140                 struct rte_mempool *mp; /* Cached Memory Pool. */
 141                 struct ibv_mr *mr; /* Memory Region (for mp). */
 142                 uint32_t lkey; /* mr->lkey */
 143         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 144         struct ibv_cq *cq; /* Completion Queue. */
 145         struct ibv_qp *qp; /* Queue Pair. */
 146         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 147         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 148 #if MLX5_PMD_MAX_INLINE > 0
 149         uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
 150 #endif
 151         unsigned int elts_n; /* (*elts)[] length. */
 152         struct txq_elt (*elts)[]; /* TX elements. */
 153         unsigned int elts_head; /* Current index in (*elts)[]. */
 154         unsigned int elts_tail; /* First element awaiting completion. */
 155         unsigned int elts_comp; /* Number of completion requests. */
 156         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 157         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 158         struct mlx5_txq_stats stats; /* TX queue counters. */
 159         linear_t (*elts_linear)[]; /* Linearized buffers. */
 160         struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
 161         unsigned int socket; /* CPU socket ID for allocations. */
 162         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 163 };
 164
 165 /* mlx5_rxq.c */
 166
 167 void rxq_cleanup(struct rxq *);
 168 int rxq_rehash(struct rte_eth_dev *, struct rxq *);
 169 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
 170               const struct rte_eth_rxconf *, struct rte_mempool *);
 171 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 172                         const struct rte_eth_rxconf *, struct rte_mempool *);
 173 void mlx5_rx_queue_release(void *);
 174
 175 /* mlx5_txq.c */
 176
 177 void txq_cleanup(struct txq *);
 178 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 179                         const struct rte_eth_txconf *);
 180 void mlx5_tx_queue_release(void *);
 181
 182 /* mlx5_rxtx.c */
 183
 184 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 185 uint16_t mlx5_rx_burst_sp(void *, struct rte_mbuf **, uint16_t);
 186 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 187 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 188 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 189
 190 #endif /* RTE_PMD_MLX5_RXTX_H_ */