de7e28be606201801861442006e9cd34547f6f02
[deb_dpdk.git] / drivers / net / mlx5 / mlx5_txq.c
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 #include <stddef.h>
35 #include <assert.h>
36 #include <errno.h>
37 #include <string.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 "-Wpedantic"
44 #endif
45 #include <infiniband/verbs.h>
46 #ifdef PEDANTIC
47 #pragma GCC diagnostic error "-Wpedantic"
48 #endif
49
50 /* DPDK headers don't like -pedantic. */
51 #ifdef PEDANTIC
52 #pragma GCC diagnostic ignored "-Wpedantic"
53 #endif
54 #include <rte_mbuf.h>
55 #include <rte_malloc.h>
56 #include <rte_ethdev.h>
57 #include <rte_common.h>
58 #ifdef PEDANTIC
59 #pragma GCC diagnostic error "-Wpedantic"
60 #endif
61
62 #include "mlx5_utils.h"
63 #include "mlx5_defs.h"
64 #include "mlx5.h"
65 #include "mlx5_rxtx.h"
66 #include "mlx5_autoconf.h"
67 #include "mlx5_defs.h"
68
69 /**
70  * Allocate TX queue elements.
71  *
72  * @param txq_ctrl
73  *   Pointer to TX queue structure.
74  * @param elts_n
75  *   Number of elements to allocate.
76  */
77 static void
78 txq_alloc_elts(struct txq_ctrl *txq_ctrl, unsigned int elts_n)
79 {
80         unsigned int i;
81
82         for (i = 0; (i != elts_n); ++i)
83                 (*txq_ctrl->txq.elts)[i] = NULL;
84         for (i = 0; (i != (1u << txq_ctrl->txq.wqe_n)); ++i) {
85                 volatile struct mlx5_wqe64 *wqe =
86                         (volatile struct mlx5_wqe64 *)
87                         txq_ctrl->txq.wqes + i;
88
89                 memset((void *)(uintptr_t)wqe, 0x0, sizeof(*wqe));
90         }
91         DEBUG("%p: allocated and configured %u WRs", (void *)txq_ctrl, elts_n);
92         txq_ctrl->txq.elts_head = 0;
93         txq_ctrl->txq.elts_tail = 0;
94         txq_ctrl->txq.elts_comp = 0;
95 }
96
97 /**
98  * Free TX queue elements.
99  *
100  * @param txq_ctrl
101  *   Pointer to TX queue structure.
102  */
103 static void
104 txq_free_elts(struct txq_ctrl *txq_ctrl)
105 {
106         unsigned int elts_n = 1 << txq_ctrl->txq.elts_n;
107         unsigned int elts_head = txq_ctrl->txq.elts_head;
108         unsigned int elts_tail = txq_ctrl->txq.elts_tail;
109         struct rte_mbuf *(*elts)[elts_n] = txq_ctrl->txq.elts;
110
111         DEBUG("%p: freeing WRs", (void *)txq_ctrl);
112         txq_ctrl->txq.elts_head = 0;
113         txq_ctrl->txq.elts_tail = 0;
114         txq_ctrl->txq.elts_comp = 0;
115
116         while (elts_tail != elts_head) {
117                 struct rte_mbuf *elt = (*elts)[elts_tail];
118
119                 assert(elt != NULL);
120                 rte_pktmbuf_free(elt);
121 #ifndef NDEBUG
122                 /* Poisoning. */
123                 memset(&(*elts)[elts_tail],
124                        0x77,
125                        sizeof((*elts)[elts_tail]));
126 #endif
127                 if (++elts_tail == elts_n)
128                         elts_tail = 0;
129         }
130 }
131
132 /**
133  * Clean up a TX queue.
134  *
135  * Destroy objects, free allocated memory and reset the structure for reuse.
136  *
137  * @param txq_ctrl
138  *   Pointer to TX queue structure.
139  */
140 void
141 txq_cleanup(struct txq_ctrl *txq_ctrl)
142 {
143         size_t i;
144
145         DEBUG("cleaning up %p", (void *)txq_ctrl);
146         txq_free_elts(txq_ctrl);
147         if (txq_ctrl->qp != NULL)
148                 claim_zero(ibv_destroy_qp(txq_ctrl->qp));
149         if (txq_ctrl->cq != NULL)
150                 claim_zero(ibv_destroy_cq(txq_ctrl->cq));
151         for (i = 0; (i != RTE_DIM(txq_ctrl->txq.mp2mr)); ++i) {
152                 if (txq_ctrl->txq.mp2mr[i].mp == NULL)
153                         break;
154                 assert(txq_ctrl->txq.mp2mr[i].mr != NULL);
155                 claim_zero(ibv_dereg_mr(txq_ctrl->txq.mp2mr[i].mr));
156         }
157         memset(txq_ctrl, 0, sizeof(*txq_ctrl));
158 }
159
160 /**
161  * Initialize TX queue.
162  *
163  * @param tmpl
164  *   Pointer to TX queue control template.
165  * @param txq_ctrl
166  *   Pointer to TX queue control.
167  *
168  * @return
169  *   0 on success, errno value on failure.
170  */
171 static inline int
172 txq_setup(struct txq_ctrl *tmpl, struct txq_ctrl *txq_ctrl)
173 {
174         struct mlx5_qp *qp = to_mqp(tmpl->qp);
175         struct ibv_cq *ibcq = tmpl->cq;
176         struct mlx5_cq *cq = to_mxxx(cq, cq);
177
178         if (cq->cqe_sz != RTE_CACHE_LINE_SIZE) {
179                 ERROR("Wrong MLX5_CQE_SIZE environment variable value: "
180                       "it should be set to %u", RTE_CACHE_LINE_SIZE);
181                 return EINVAL;
182         }
183         tmpl->txq.cqe_n = log2above(ibcq->cqe);
184         tmpl->txq.qp_num_8s = qp->ctrl_seg.qp_num << 8;
185         tmpl->txq.wqes = qp->gen_data.sqstart;
186         tmpl->txq.wqe_n = log2above(qp->sq.wqe_cnt);
187         tmpl->txq.qp_db = &qp->gen_data.db[MLX5_SND_DBR];
188         tmpl->txq.bf_reg = qp->gen_data.bf->reg;
189         tmpl->txq.cq_db = cq->dbrec;
190         tmpl->txq.cqes =
191                 (volatile struct mlx5_cqe (*)[])
192                 (uintptr_t)cq->active_buf->buf;
193         tmpl->txq.elts =
194                 (struct rte_mbuf *(*)[1 << tmpl->txq.elts_n])
195                 ((uintptr_t)txq_ctrl + sizeof(*txq_ctrl));
196         return 0;
197 }
198
199 /**
200  * Configure a TX queue.
201  *
202  * @param dev
203  *   Pointer to Ethernet device structure.
204  * @param txq_ctrl
205  *   Pointer to TX queue structure.
206  * @param desc
207  *   Number of descriptors to configure in queue.
208  * @param socket
209  *   NUMA socket on which memory must be allocated.
210  * @param[in] conf
211  *   Thresholds parameters.
212  *
213  * @return
214  *   0 on success, errno value on failure.
215  */
216 int
217 txq_ctrl_setup(struct rte_eth_dev *dev, struct txq_ctrl *txq_ctrl,
218                uint16_t desc, unsigned int socket,
219                const struct rte_eth_txconf *conf)
220 {
221         struct priv *priv = mlx5_get_priv(dev);
222         struct txq_ctrl tmpl = {
223                 .priv = priv,
224                 .socket = socket,
225         };
226         union {
227                 struct ibv_exp_qp_init_attr init;
228                 struct ibv_exp_cq_init_attr cq;
229                 struct ibv_exp_qp_attr mod;
230                 struct ibv_exp_cq_attr cq_attr;
231         } attr;
232         unsigned int cqe_n;
233         const unsigned int max_tso_inline = ((MLX5_MAX_TSO_HEADER +
234                                              (RTE_CACHE_LINE_SIZE - 1)) /
235                                               RTE_CACHE_LINE_SIZE);
236         int ret = 0;
237
238         if (mlx5_getenv_int("MLX5_ENABLE_CQE_COMPRESSION")) {
239                 ret = ENOTSUP;
240                 ERROR("MLX5_ENABLE_CQE_COMPRESSION must never be set");
241                 goto error;
242         }
243         (void)conf; /* Thresholds configuration (ignored). */
244         assert(desc > MLX5_TX_COMP_THRESH);
245         tmpl.txq.elts_n = log2above(desc);
246         if (priv->mps == MLX5_MPW_ENHANCED)
247                 tmpl.txq.mpw_hdr_dseg = priv->mpw_hdr_dseg;
248         /* MRs will be registered in mp2mr[] later. */
249         attr.cq = (struct ibv_exp_cq_init_attr){
250                 .comp_mask = 0,
251         };
252         cqe_n = ((desc / MLX5_TX_COMP_THRESH) - 1) ?
253                 ((desc / MLX5_TX_COMP_THRESH) - 1) : 1;
254         if (priv->mps == MLX5_MPW_ENHANCED)
255                 cqe_n += MLX5_TX_COMP_THRESH_INLINE_DIV;
256         tmpl.cq = ibv_exp_create_cq(priv->ctx,
257                                     cqe_n,
258                                     NULL, NULL, 0, &attr.cq);
259         if (tmpl.cq == NULL) {
260                 ret = ENOMEM;
261                 ERROR("%p: CQ creation failure: %s",
262                       (void *)dev, strerror(ret));
263                 goto error;
264         }
265         DEBUG("priv->device_attr.max_qp_wr is %d",
266               priv->device_attr.max_qp_wr);
267         DEBUG("priv->device_attr.max_sge is %d",
268               priv->device_attr.max_sge);
269         attr.init = (struct ibv_exp_qp_init_attr){
270                 /* CQ to be associated with the send queue. */
271                 .send_cq = tmpl.cq,
272                 /* CQ to be associated with the receive queue. */
273                 .recv_cq = tmpl.cq,
274                 .cap = {
275                         /* Max number of outstanding WRs. */
276                         .max_send_wr = ((priv->device_attr.max_qp_wr < desc) ?
277                                         priv->device_attr.max_qp_wr :
278                                         desc),
279                         /*
280                          * Max number of scatter/gather elements in a WR,
281                          * must be 1 to prevent libmlx5 from trying to affect
282                          * too much memory. TX gather is not impacted by the
283                          * priv->device_attr.max_sge limit and will still work
284                          * properly.
285                          */
286                         .max_send_sge = 1,
287                 },
288                 .qp_type = IBV_QPT_RAW_PACKET,
289                 /* Do *NOT* enable this, completions events are managed per
290                  * TX burst. */
291                 .sq_sig_all = 0,
292                 .pd = priv->pd,
293                 .comp_mask = IBV_EXP_QP_INIT_ATTR_PD,
294         };
295         if (priv->txq_inline && (priv->txqs_n >= priv->txqs_inline)) {
296                 tmpl.txq.max_inline =
297                         ((priv->txq_inline + (RTE_CACHE_LINE_SIZE - 1)) /
298                          RTE_CACHE_LINE_SIZE);
299                 tmpl.txq.inline_en = 1;
300                 /* TSO and MPS can't be enabled concurrently. */
301                 assert(!priv->tso || !priv->mps);
302                 if (priv->mps == MLX5_MPW_ENHANCED) {
303                         tmpl.txq.inline_max_packet_sz =
304                                 priv->inline_max_packet_sz;
305                         /* To minimize the size of data set, avoid requesting
306                          * too large WQ.
307                          */
308                         attr.init.cap.max_inline_data =
309                                 ((RTE_MIN(priv->txq_inline,
310                                           priv->inline_max_packet_sz) +
311                                   (RTE_CACHE_LINE_SIZE - 1)) /
312                                  RTE_CACHE_LINE_SIZE) * RTE_CACHE_LINE_SIZE;
313                 } else if (priv->tso) {
314                         int inline_diff = tmpl.txq.max_inline - max_tso_inline;
315
316                         /*
317                          * Adjust inline value as Verbs aggregates
318                          * tso_inline and txq_inline fields.
319                          */
320                         attr.init.cap.max_inline_data = inline_diff > 0 ?
321                                                         inline_diff *
322                                                         RTE_CACHE_LINE_SIZE :
323                                                         0;
324                 } else {
325                         attr.init.cap.max_inline_data =
326                                 tmpl.txq.max_inline * RTE_CACHE_LINE_SIZE;
327                 }
328         }
329         if (priv->tso) {
330                 attr.init.max_tso_header =
331                         max_tso_inline * RTE_CACHE_LINE_SIZE;
332                 attr.init.comp_mask |= IBV_EXP_QP_INIT_ATTR_MAX_TSO_HEADER;
333                 tmpl.txq.max_inline = RTE_MAX(tmpl.txq.max_inline,
334                                               max_tso_inline);
335                 tmpl.txq.tso_en = 1;
336         }
337         if (priv->tunnel_en)
338                 tmpl.txq.tunnel_en = 1;
339         tmpl.qp = ibv_exp_create_qp(priv->ctx, &attr.init);
340         if (tmpl.qp == NULL) {
341                 ret = (errno ? errno : EINVAL);
342                 ERROR("%p: QP creation failure: %s",
343                       (void *)dev, strerror(ret));
344                 goto error;
345         }
346         DEBUG("TX queue capabilities: max_send_wr=%u, max_send_sge=%u,"
347               " max_inline_data=%u",
348               attr.init.cap.max_send_wr,
349               attr.init.cap.max_send_sge,
350               attr.init.cap.max_inline_data);
351         attr.mod = (struct ibv_exp_qp_attr){
352                 /* Move the QP to this state. */
353                 .qp_state = IBV_QPS_INIT,
354                 /* Primary port number. */
355                 .port_num = priv->port
356         };
357         ret = ibv_exp_modify_qp(tmpl.qp, &attr.mod,
358                                 (IBV_EXP_QP_STATE | IBV_EXP_QP_PORT));
359         if (ret) {
360                 ERROR("%p: QP state to IBV_QPS_INIT failed: %s",
361                       (void *)dev, strerror(ret));
362                 goto error;
363         }
364         ret = txq_setup(&tmpl, txq_ctrl);
365         if (ret) {
366                 ERROR("%p: cannot initialize TX queue structure: %s",
367                       (void *)dev, strerror(ret));
368                 goto error;
369         }
370         txq_alloc_elts(&tmpl, desc);
371         attr.mod = (struct ibv_exp_qp_attr){
372                 .qp_state = IBV_QPS_RTR
373         };
374         ret = ibv_exp_modify_qp(tmpl.qp, &attr.mod, IBV_EXP_QP_STATE);
375         if (ret) {
376                 ERROR("%p: QP state to IBV_QPS_RTR failed: %s",
377                       (void *)dev, strerror(ret));
378                 goto error;
379         }
380         attr.mod.qp_state = IBV_QPS_RTS;
381         ret = ibv_exp_modify_qp(tmpl.qp, &attr.mod, IBV_EXP_QP_STATE);
382         if (ret) {
383                 ERROR("%p: QP state to IBV_QPS_RTS failed: %s",
384                       (void *)dev, strerror(ret));
385                 goto error;
386         }
387         /* Clean up txq in case we're reinitializing it. */
388         DEBUG("%p: cleaning-up old txq just in case", (void *)txq_ctrl);
389         txq_cleanup(txq_ctrl);
390         *txq_ctrl = tmpl;
391         DEBUG("%p: txq updated with %p", (void *)txq_ctrl, (void *)&tmpl);
392         /* Pre-register known mempools. */
393         rte_mempool_walk(txq_mp2mr_iter, txq_ctrl);
394         assert(ret == 0);
395         return 0;
396 error:
397         txq_cleanup(&tmpl);
398         assert(ret > 0);
399         return ret;
400 }
401
402 /**
403  * DPDK callback to configure a TX queue.
404  *
405  * @param dev
406  *   Pointer to Ethernet device structure.
407  * @param idx
408  *   TX queue index.
409  * @param desc
410  *   Number of descriptors to configure in queue.
411  * @param socket
412  *   NUMA socket on which memory must be allocated.
413  * @param[in] conf
414  *   Thresholds parameters.
415  *
416  * @return
417  *   0 on success, negative errno value on failure.
418  */
419 int
420 mlx5_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
421                     unsigned int socket, const struct rte_eth_txconf *conf)
422 {
423         struct priv *priv = dev->data->dev_private;
424         struct txq *txq = (*priv->txqs)[idx];
425         struct txq_ctrl *txq_ctrl = container_of(txq, struct txq_ctrl, txq);
426         int ret;
427
428         if (mlx5_is_secondary())
429                 return -E_RTE_SECONDARY;
430
431         priv_lock(priv);
432         if (desc <= MLX5_TX_COMP_THRESH) {
433                 WARN("%p: number of descriptors requested for TX queue %u"
434                      " must be higher than MLX5_TX_COMP_THRESH, using"
435                      " %u instead of %u",
436                      (void *)dev, idx, MLX5_TX_COMP_THRESH + 1, desc);
437                 desc = MLX5_TX_COMP_THRESH + 1;
438         }
439         if (!rte_is_power_of_2(desc)) {
440                 desc = 1 << log2above(desc);
441                 WARN("%p: increased number of descriptors in TX queue %u"
442                      " to the next power of two (%d)",
443                      (void *)dev, idx, desc);
444         }
445         DEBUG("%p: configuring queue %u for %u descriptors",
446               (void *)dev, idx, desc);
447         if (idx >= priv->txqs_n) {
448                 ERROR("%p: queue index out of range (%u >= %u)",
449                       (void *)dev, idx, priv->txqs_n);
450                 priv_unlock(priv);
451                 return -EOVERFLOW;
452         }
453         if (txq != NULL) {
454                 DEBUG("%p: reusing already allocated queue index %u (%p)",
455                       (void *)dev, idx, (void *)txq);
456                 if (priv->started) {
457                         priv_unlock(priv);
458                         return -EEXIST;
459                 }
460                 (*priv->txqs)[idx] = NULL;
461                 txq_cleanup(txq_ctrl);
462                 /* Resize if txq size is changed. */
463                 if (txq_ctrl->txq.elts_n != log2above(desc)) {
464                         txq_ctrl = rte_realloc(txq_ctrl,
465                                                sizeof(*txq_ctrl) +
466                                                desc * sizeof(struct rte_mbuf *),
467                                                RTE_CACHE_LINE_SIZE);
468                         if (!txq_ctrl) {
469                                 ERROR("%p: unable to reallocate queue index %u",
470                                         (void *)dev, idx);
471                                 priv_unlock(priv);
472                                 return -ENOMEM;
473                         }
474                 }
475         } else {
476                 txq_ctrl =
477                         rte_calloc_socket("TXQ", 1,
478                                           sizeof(*txq_ctrl) +
479                                           desc * sizeof(struct rte_mbuf *),
480                                           0, socket);
481                 if (txq_ctrl == NULL) {
482                         ERROR("%p: unable to allocate queue index %u",
483                               (void *)dev, idx);
484                         priv_unlock(priv);
485                         return -ENOMEM;
486                 }
487         }
488         ret = txq_ctrl_setup(dev, txq_ctrl, desc, socket, conf);
489         if (ret)
490                 rte_free(txq_ctrl);
491         else {
492                 txq_ctrl->txq.stats.idx = idx;
493                 DEBUG("%p: adding TX queue %p to list",
494                       (void *)dev, (void *)txq_ctrl);
495                 (*priv->txqs)[idx] = &txq_ctrl->txq;
496                 /* Update send callback. */
497                 priv_select_tx_function(priv);
498         }
499         priv_unlock(priv);
500         return -ret;
501 }
502
503 /**
504  * DPDK callback to release a TX queue.
505  *
506  * @param dpdk_txq
507  *   Generic TX queue pointer.
508  */
509 void
510 mlx5_tx_queue_release(void *dpdk_txq)
511 {
512         struct txq *txq = (struct txq *)dpdk_txq;
513         struct txq_ctrl *txq_ctrl;
514         struct priv *priv;
515         unsigned int i;
516
517         if (mlx5_is_secondary())
518                 return;
519
520         if (txq == NULL)
521                 return;
522         txq_ctrl = container_of(txq, struct txq_ctrl, txq);
523         priv = txq_ctrl->priv;
524         priv_lock(priv);
525         for (i = 0; (i != priv->txqs_n); ++i)
526                 if ((*priv->txqs)[i] == txq) {
527                         DEBUG("%p: removing TX queue %p from list",
528                               (void *)priv->dev, (void *)txq_ctrl);
529                         (*priv->txqs)[i] = NULL;
530                         break;
531                 }
532         txq_cleanup(txq_ctrl);
533         rte_free(txq_ctrl);
534         priv_unlock(priv);
535 }
536
537 /**
538  * DPDK callback for TX in secondary processes.
539  *
540  * This function configures all queues from primary process information
541  * if necessary before reverting to the normal TX burst callback.
542  *
543  * @param dpdk_txq
544  *   Generic pointer to TX queue structure.
545  * @param[in] pkts
546  *   Packets to transmit.
547  * @param pkts_n
548  *   Number of packets in array.
549  *
550  * @return
551  *   Number of packets successfully transmitted (<= pkts_n).
552  */
553 uint16_t
554 mlx5_tx_burst_secondary_setup(void *dpdk_txq, struct rte_mbuf **pkts,
555                               uint16_t pkts_n)
556 {
557         struct txq *txq = dpdk_txq;
558         struct txq_ctrl *txq_ctrl = container_of(txq, struct txq_ctrl, txq);
559         struct priv *priv = mlx5_secondary_data_setup(txq_ctrl->priv);
560         struct priv *primary_priv;
561         unsigned int index;
562
563         if (priv == NULL)
564                 return 0;
565         primary_priv =
566                 mlx5_secondary_data[priv->dev->data->port_id].primary_priv;
567         /* Look for queue index in both private structures. */
568         for (index = 0; index != priv->txqs_n; ++index)
569                 if (((*primary_priv->txqs)[index] == txq) ||
570                     ((*priv->txqs)[index] == txq))
571                         break;
572         if (index == priv->txqs_n)
573                 return 0;
574         txq = (*priv->txqs)[index];
575         return priv->dev->tx_pkt_burst(txq, pkts, pkts_n);
576 }