d56e48d7a93e0f901d4978e4d634a494f5599b8a
[dpdk.git] / drivers / net / mlx4 / mlx4_rxtx.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2017 6WIND S.A.
5  *   Copyright 2017 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 MLX4_RXTX_H_
35 #define MLX4_RXTX_H_
36
37 #include <stdint.h>
38 #include <sys/queue.h>
39
40 /* Verbs headers do not support -pedantic. */
41 #ifdef PEDANTIC
42 #pragma GCC diagnostic ignored "-Wpedantic"
43 #endif
44 #include <infiniband/mlx4dv.h>
45 #include <infiniband/verbs.h>
46 #ifdef PEDANTIC
47 #pragma GCC diagnostic error "-Wpedantic"
48 #endif
49
50 #include <rte_ethdev.h>
51 #include <rte_mbuf.h>
52 #include <rte_mempool.h>
53
54 #include "mlx4.h"
55 #include "mlx4_prm.h"
56
57 /** Rx queue counters. */
58 struct mlx4_rxq_stats {
59         unsigned int idx; /**< Mapping index. */
60         uint64_t ipackets; /**< Total of successfully received packets. */
61         uint64_t ibytes; /**< Total of successfully received bytes. */
62         uint64_t idropped; /**< Total of packets dropped when Rx ring full. */
63         uint64_t rx_nombuf; /**< Total of Rx mbuf allocation failures. */
64 };
65
66 /** Rx queue descriptor. */
67 struct rxq {
68         struct priv *priv; /**< Back pointer to private data. */
69         struct rte_mempool *mp; /**< Memory pool for allocations. */
70         struct mlx4_mr *mr; /**< Memory region. */
71         struct ibv_cq *cq; /**< Completion queue. */
72         struct ibv_wq *wq; /**< Work queue. */
73         struct ibv_comp_channel *channel; /**< Rx completion channel. */
74         uint16_t rq_ci; /**< Saved RQ consumer index. */
75         uint16_t port_id; /**< Port ID for incoming packets. */
76         uint16_t sges_n; /**< Number of segments per packet (log2 value). */
77         uint16_t elts_n; /**< Mbuf queue size (log2 value). */
78         struct rte_mbuf *(*elts)[]; /**< Rx elements. */
79         volatile struct mlx4_wqe_data_seg (*wqes)[]; /**< HW queue entries. */
80         volatile uint32_t *rq_db; /**< RQ doorbell record. */
81         uint32_t csum:1; /**< Enable checksum offloading. */
82         uint32_t csum_l2tun:1; /**< Same for L2 tunnels. */
83         uint32_t l2tun_offload:1; /**< L2 tunnel offload is enabled. */
84         struct mlx4_cq mcq;  /**< Info for directly manipulating the CQ. */
85         struct mlx4_rxq_stats stats; /**< Rx queue counters. */
86         unsigned int socket; /**< CPU socket ID for allocations. */
87         uint32_t usecnt; /**< Number of users relying on queue resources. */
88         uint8_t data[]; /**< Remaining queue resources. */
89 };
90
91 /** Shared flow target for Rx queues. */
92 struct mlx4_rss {
93         LIST_ENTRY(mlx4_rss) next; /**< Next entry in list. */
94         struct priv *priv; /**< Back pointer to private data. */
95         uint32_t refcnt; /**< Reference count for this object. */
96         uint32_t usecnt; /**< Number of users relying on @p qp and @p ind. */
97         struct ibv_qp *qp; /**< Queue pair. */
98         struct ibv_rwq_ind_table *ind; /**< Indirection table. */
99         uint64_t fields; /**< Fields for RSS processing (Verbs format). */
100         uint8_t key[MLX4_RSS_HASH_KEY_SIZE]; /**< Hash key to use. */
101         uint16_t queues; /**< Number of target queues. */
102         uint16_t queue_id[]; /**< Target queues. */
103 };
104
105 /** Tx element. */
106 struct txq_elt {
107         struct rte_mbuf *buf; /**< Buffer. */
108         volatile struct mlx4_wqe_ctrl_seg *wqe; /**< SQ WQE. */
109 };
110
111 /** Rx queue counters. */
112 struct mlx4_txq_stats {
113         unsigned int idx; /**< Mapping index. */
114         uint64_t opackets; /**< Total of successfully sent packets. */
115         uint64_t obytes; /**< Total of successfully sent bytes. */
116         uint64_t odropped; /**< Total of packets not sent when Tx ring full. */
117 };
118
119 /** Tx queue descriptor. */
120 struct txq {
121         struct mlx4_sq msq; /**< Info for directly manipulating the SQ. */
122         struct mlx4_cq mcq; /**< Info for directly manipulating the CQ. */
123         unsigned int elts_head; /**< Current index in (*elts)[]. */
124         unsigned int elts_tail; /**< First element awaiting completion. */
125         unsigned int elts_comp; /**< Number of packets awaiting completion. */
126         int elts_comp_cd; /**< Countdown for next completion. */
127         unsigned int elts_comp_cd_init; /**< Initial value for countdown. */
128         unsigned int elts_n; /**< (*elts)[] length. */
129         struct txq_elt (*elts)[]; /**< Tx elements. */
130         struct mlx4_txq_stats stats; /**< Tx queue counters. */
131         uint32_t max_inline; /**< Max inline send size. */
132         uint32_t csum:1; /**< Enable checksum offloading. */
133         uint32_t csum_l2tun:1; /**< Same for L2 tunnels. */
134         uint32_t lb:1; /**< Whether packets should be looped back by eSwitch. */
135         uint8_t *bounce_buf;
136         /**< Memory used for storing the first DWORD of data TXBBs. */
137         struct {
138                 const struct rte_mempool *mp; /**< Cached memory pool. */
139                 struct mlx4_mr *mr; /**< Memory region (for mp). */
140                 uint32_t lkey; /**< mr->lkey copy. */
141         } mp2mr[MLX4_PMD_TX_MP_CACHE]; /**< MP to MR translation table. */
142         struct priv *priv; /**< Back pointer to private data. */
143         unsigned int socket; /**< CPU socket ID for allocations. */
144         struct ibv_cq *cq; /**< Completion queue. */
145         struct ibv_qp *qp; /**< Queue pair. */
146         uint8_t data[]; /**< Remaining queue resources. */
147 };
148
149 /* mlx4_rxq.c */
150
151 uint8_t mlx4_rss_hash_key_default[MLX4_RSS_HASH_KEY_SIZE];
152 int mlx4_rss_init(struct priv *priv);
153 void mlx4_rss_deinit(struct priv *priv);
154 struct mlx4_rss *mlx4_rss_get(struct priv *priv, uint64_t fields,
155                               uint8_t key[MLX4_RSS_HASH_KEY_SIZE],
156                               uint16_t queues, const uint16_t queue_id[]);
157 void mlx4_rss_put(struct mlx4_rss *rss);
158 int mlx4_rss_attach(struct mlx4_rss *rss);
159 void mlx4_rss_detach(struct mlx4_rss *rss);
160 int mlx4_rxq_attach(struct rxq *rxq);
161 void mlx4_rxq_detach(struct rxq *rxq);
162 int mlx4_rx_queue_setup(struct rte_eth_dev *dev, uint16_t idx,
163                         uint16_t desc, unsigned int socket,
164                         const struct rte_eth_rxconf *conf,
165                         struct rte_mempool *mp);
166 void mlx4_rx_queue_release(void *dpdk_rxq);
167
168 /* mlx4_rxtx.c */
169
170 uint16_t mlx4_tx_burst(void *dpdk_txq, struct rte_mbuf **pkts,
171                        uint16_t pkts_n);
172 uint16_t mlx4_rx_burst(void *dpdk_rxq, struct rte_mbuf **pkts,
173                        uint16_t pkts_n);
174 uint16_t mlx4_tx_burst_removed(void *dpdk_txq, struct rte_mbuf **pkts,
175                                uint16_t pkts_n);
176 uint16_t mlx4_rx_burst_removed(void *dpdk_rxq, struct rte_mbuf **pkts,
177                                uint16_t pkts_n);
178
179 /* mlx4_txq.c */
180
181 int mlx4_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx,
182                         uint16_t desc, unsigned int socket,
183                         const struct rte_eth_txconf *conf);
184 void mlx4_tx_queue_release(void *dpdk_txq);
185
186 /**
187  * Get memory region (MR) <-> memory pool (MP) association from txq->mp2mr[].
188  * Call mlx4_txq_add_mr() if MP is not registered yet.
189  *
190  * @param txq
191  *   Pointer to Tx queue structure.
192  * @param[in] mp
193  *   Memory pool for which a memory region lkey must be returned.
194  *
195  * @return
196  *   mr->lkey on success, (uint32_t)-1 on failure.
197  */
198 static inline uint32_t
199 mlx4_txq_mp2mr(struct txq *txq, struct rte_mempool *mp)
200 {
201         unsigned int i;
202
203         for (i = 0; (i != RTE_DIM(txq->mp2mr)); ++i) {
204                 if (unlikely(txq->mp2mr[i].mp == NULL)) {
205                         /* Unknown MP, add a new MR for it. */
206                         break;
207                 }
208                 if (txq->mp2mr[i].mp == mp) {
209                         /* MP found MP. */
210                         return txq->mp2mr[i].lkey;
211                 }
212         }
213         return mlx4_txq_add_mr(txq, mp, i);
214 }
215
216 #endif /* MLX4_RXTX_H_ */