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