4 * Copyright 2015 6WIND S.A.
5 * Copyright 2015 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
43 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
45 #pragma GCC diagnostic ignored "-Wpedantic"
47 #include <infiniband/verbs.h>
49 #pragma GCC diagnostic error "-Wpedantic"
53 #include <rte_malloc.h>
54 #include <rte_ethdev.h>
55 #include <rte_common.h>
57 #include "mlx5_utils.h"
58 #include "mlx5_defs.h"
60 #include "mlx5_rxtx.h"
61 #include "mlx5_autoconf.h"
64 * Allocate TX queue elements.
67 * Pointer to TX queue structure.
70 txq_alloc_elts(struct mlx5_txq_ctrl *txq_ctrl)
72 const unsigned int elts_n = 1 << txq_ctrl->txq.elts_n;
75 for (i = 0; (i != elts_n); ++i)
76 (*txq_ctrl->txq.elts)[i] = NULL;
77 DEBUG("%p: allocated and configured %u WRs", (void *)txq_ctrl, elts_n);
78 txq_ctrl->txq.elts_head = 0;
79 txq_ctrl->txq.elts_tail = 0;
80 txq_ctrl->txq.elts_comp = 0;
84 * Free TX queue elements.
87 * Pointer to TX queue structure.
90 txq_free_elts(struct mlx5_txq_ctrl *txq_ctrl)
92 const uint16_t elts_n = 1 << txq_ctrl->txq.elts_n;
93 const uint16_t elts_m = elts_n - 1;
94 uint16_t elts_head = txq_ctrl->txq.elts_head;
95 uint16_t elts_tail = txq_ctrl->txq.elts_tail;
96 struct rte_mbuf *(*elts)[elts_n] = txq_ctrl->txq.elts;
98 DEBUG("%p: freeing WRs", (void *)txq_ctrl);
99 txq_ctrl->txq.elts_head = 0;
100 txq_ctrl->txq.elts_tail = 0;
101 txq_ctrl->txq.elts_comp = 0;
103 while (elts_tail != elts_head) {
104 struct rte_mbuf *elt = (*elts)[elts_tail & elts_m];
107 rte_pktmbuf_free_seg(elt);
110 memset(&(*elts)[elts_tail & elts_m],
112 sizeof((*elts)[elts_tail & elts_m]));
119 * DPDK callback to configure a TX queue.
122 * Pointer to Ethernet device structure.
126 * Number of descriptors to configure in queue.
128 * NUMA socket on which memory must be allocated.
130 * Thresholds parameters.
133 * 0 on success, negative errno value on failure.
136 mlx5_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
137 unsigned int socket, const struct rte_eth_txconf *conf)
139 struct priv *priv = dev->data->dev_private;
140 struct mlx5_txq_data *txq = (*priv->txqs)[idx];
141 struct mlx5_txq_ctrl *txq_ctrl =
142 container_of(txq, struct mlx5_txq_ctrl, txq);
146 if (desc <= MLX5_TX_COMP_THRESH) {
147 WARN("%p: number of descriptors requested for TX queue %u"
148 " must be higher than MLX5_TX_COMP_THRESH, using"
150 (void *)dev, idx, MLX5_TX_COMP_THRESH + 1, desc);
151 desc = MLX5_TX_COMP_THRESH + 1;
153 if (!rte_is_power_of_2(desc)) {
154 desc = 1 << log2above(desc);
155 WARN("%p: increased number of descriptors in TX queue %u"
156 " to the next power of two (%d)",
157 (void *)dev, idx, desc);
159 DEBUG("%p: configuring queue %u for %u descriptors",
160 (void *)dev, idx, desc);
161 if (idx >= priv->txqs_n) {
162 ERROR("%p: queue index out of range (%u >= %u)",
163 (void *)dev, idx, priv->txqs_n);
167 if (!mlx5_priv_txq_releasable(priv, idx)) {
169 ERROR("%p: unable to release queue index %u",
173 mlx5_priv_txq_release(priv, idx);
174 txq_ctrl = mlx5_priv_txq_new(priv, idx, desc, socket, conf);
176 ERROR("%p: unable to allocate queue index %u",
181 DEBUG("%p: adding TX queue %p to list",
182 (void *)dev, (void *)txq_ctrl);
183 (*priv->txqs)[idx] = &txq_ctrl->txq;
190 * DPDK callback to release a TX queue.
193 * Generic TX queue pointer.
196 mlx5_tx_queue_release(void *dpdk_txq)
198 struct mlx5_txq_data *txq = (struct mlx5_txq_data *)dpdk_txq;
199 struct mlx5_txq_ctrl *txq_ctrl;
205 txq_ctrl = container_of(txq, struct mlx5_txq_ctrl, txq);
206 priv = txq_ctrl->priv;
208 for (i = 0; (i != priv->txqs_n); ++i)
209 if ((*priv->txqs)[i] == txq) {
210 DEBUG("%p: removing TX queue %p from list",
211 (void *)priv->dev, (void *)txq_ctrl);
212 mlx5_priv_txq_release(priv, i);
220 * Map locally UAR used in Tx queues for BlueFlame doorbell.
223 * Pointer to private structure.
225 * Verbs file descriptor to map UAR pages.
228 * 0 on success, errno value on failure.
231 priv_tx_uar_remap(struct priv *priv, int fd)
234 uintptr_t pages[priv->txqs_n];
235 unsigned int pages_n = 0;
238 struct mlx5_txq_data *txq;
239 struct mlx5_txq_ctrl *txq_ctrl;
241 size_t page_size = sysconf(_SC_PAGESIZE);
243 memset(pages, 0, priv->txqs_n * sizeof(uintptr_t));
245 * As rdma-core, UARs are mapped in size of OS page size.
246 * Use aligned address to avoid duplicate mmap.
247 * Ref to libmlx5 function: mlx5_init_context()
249 for (i = 0; i != priv->txqs_n; ++i) {
250 if (!(*priv->txqs)[i])
252 txq = (*priv->txqs)[i];
253 txq_ctrl = container_of(txq, struct mlx5_txq_ctrl, txq);
254 uar_va = (uintptr_t)txq_ctrl->txq.bf_reg;
255 uar_va = RTE_ALIGN_FLOOR(uar_va, page_size);
257 for (j = 0; j != pages_n; ++j) {
258 if (pages[j] == uar_va) {
265 pages[pages_n++] = uar_va;
266 addr = mmap((void *)uar_va, page_size,
267 PROT_WRITE, MAP_FIXED | MAP_SHARED, fd,
268 txq_ctrl->uar_mmap_offset);
269 if (addr != (void *)uar_va) {
270 ERROR("call to mmap failed on UAR for txq %d\n", i);
278 * Create the Tx queue Verbs object.
281 * Pointer to private structure.
283 * Queue index in DPDK Rx queue array
286 * The Verbs object initialised if it can be created.
289 mlx5_priv_txq_ibv_new(struct priv *priv, uint16_t idx)
291 struct mlx5_txq_data *txq_data = (*priv->txqs)[idx];
292 struct mlx5_txq_ctrl *txq_ctrl =
293 container_of(txq_data, struct mlx5_txq_ctrl, txq);
294 struct mlx5_txq_ibv tmpl;
295 struct mlx5_txq_ibv *txq_ibv;
297 struct ibv_qp_init_attr_ex init;
298 struct ibv_cq_init_attr_ex cq;
299 struct ibv_qp_attr mod;
300 struct ibv_cq_ex cq_attr;
303 struct mlx5dv_qp qp = { .comp_mask = MLX5DV_QP_MASK_UAR_MMAP_OFFSET };
304 struct mlx5dv_cq cq_info;
305 struct mlx5dv_obj obj;
306 const int desc = 1 << txq_data->elts_n;
310 if (mlx5_getenv_int("MLX5_ENABLE_CQE_COMPRESSION")) {
311 ERROR("MLX5_ENABLE_CQE_COMPRESSION must never be set");
314 memset(&tmpl, 0, sizeof(struct mlx5_txq_ibv));
315 /* MRs will be registered in mp2mr[] later. */
316 attr.cq = (struct ibv_cq_init_attr_ex){
319 cqe_n = ((desc / MLX5_TX_COMP_THRESH) - 1) ?
320 ((desc / MLX5_TX_COMP_THRESH) - 1) : 1;
321 if (priv->mps == MLX5_MPW_ENHANCED)
322 cqe_n += MLX5_TX_COMP_THRESH_INLINE_DIV;
323 tmpl.cq = ibv_create_cq(priv->ctx, cqe_n, NULL, NULL, 0);
324 if (tmpl.cq == NULL) {
325 ERROR("%p: CQ creation failure", (void *)txq_ctrl);
328 attr.init = (struct ibv_qp_init_attr_ex){
329 /* CQ to be associated with the send queue. */
331 /* CQ to be associated with the receive queue. */
334 /* Max number of outstanding WRs. */
336 ((priv->device_attr.orig_attr.max_qp_wr <
338 priv->device_attr.orig_attr.max_qp_wr :
341 * Max number of scatter/gather elements in a WR,
342 * must be 1 to prevent libmlx5 from trying to affect
343 * too much memory. TX gather is not impacted by the
344 * priv->device_attr.max_sge limit and will still work
349 .qp_type = IBV_QPT_RAW_PACKET,
351 * Do *NOT* enable this, completions events are managed per
356 .comp_mask = IBV_QP_INIT_ATTR_PD,
358 if (txq_data->inline_en)
359 attr.init.cap.max_inline_data = txq_ctrl->max_inline_data;
360 if (txq_data->tso_en) {
361 attr.init.max_tso_header = txq_ctrl->max_tso_header;
362 attr.init.comp_mask |= IBV_QP_INIT_ATTR_MAX_TSO_HEADER;
364 tmpl.qp = ibv_create_qp_ex(priv->ctx, &attr.init);
365 if (tmpl.qp == NULL) {
366 ERROR("%p: QP creation failure", (void *)txq_ctrl);
369 attr.mod = (struct ibv_qp_attr){
370 /* Move the QP to this state. */
371 .qp_state = IBV_QPS_INIT,
372 /* Primary port number. */
373 .port_num = priv->port
375 ret = ibv_modify_qp(tmpl.qp, &attr.mod, (IBV_QP_STATE | IBV_QP_PORT));
377 ERROR("%p: QP state to IBV_QPS_INIT failed", (void *)txq_ctrl);
380 attr.mod = (struct ibv_qp_attr){
381 .qp_state = IBV_QPS_RTR
383 ret = ibv_modify_qp(tmpl.qp, &attr.mod, IBV_QP_STATE);
385 ERROR("%p: QP state to IBV_QPS_RTR failed", (void *)txq_ctrl);
388 attr.mod.qp_state = IBV_QPS_RTS;
389 ret = ibv_modify_qp(tmpl.qp, &attr.mod, IBV_QP_STATE);
391 ERROR("%p: QP state to IBV_QPS_RTS failed", (void *)txq_ctrl);
394 txq_ibv = rte_calloc_socket(__func__, 1, sizeof(struct mlx5_txq_ibv), 0,
397 ERROR("%p: cannot allocate memory", (void *)txq_ctrl);
401 obj.cq.out = &cq_info;
404 ret = mlx5dv_init_obj(&obj, MLX5DV_OBJ_CQ | MLX5DV_OBJ_QP);
407 if (cq_info.cqe_size != RTE_CACHE_LINE_SIZE) {
408 ERROR("Wrong MLX5_CQE_SIZE environment variable value: "
409 "it should be set to %u", RTE_CACHE_LINE_SIZE);
412 txq_data->cqe_n = log2above(cq_info.cqe_cnt);
413 txq_data->qp_num_8s = tmpl.qp->qp_num << 8;
414 txq_data->wqes = qp.sq.buf;
415 txq_data->wqe_n = log2above(qp.sq.wqe_cnt);
416 txq_data->qp_db = &qp.dbrec[MLX5_SND_DBR];
417 txq_data->bf_reg = qp.bf.reg;
418 txq_data->cq_db = cq_info.dbrec;
420 (volatile struct mlx5_cqe (*)[])
421 (uintptr_t)cq_info.buf;
424 txq_data->wqe_ci = 0;
425 txq_data->wqe_pi = 0;
426 txq_ibv->qp = tmpl.qp;
427 txq_ibv->cq = tmpl.cq;
428 rte_atomic32_inc(&txq_ibv->refcnt);
429 if (qp.comp_mask & MLX5DV_QP_MASK_UAR_MMAP_OFFSET) {
430 txq_ctrl->uar_mmap_offset = qp.uar_mmap_offset;
432 ERROR("Failed to retrieve UAR info, invalid libmlx5.so version");
435 DEBUG("%p: Verbs Tx queue %p: refcnt %d", (void *)priv,
436 (void *)txq_ibv, rte_atomic32_read(&txq_ibv->refcnt));
437 LIST_INSERT_HEAD(&priv->txqsibv, txq_ibv, next);
441 claim_zero(ibv_destroy_cq(tmpl.cq));
443 claim_zero(ibv_destroy_qp(tmpl.qp));
448 * Get an Tx queue Verbs object.
451 * Pointer to private structure.
453 * Queue index in DPDK Rx queue array
456 * The Verbs object if it exists.
459 mlx5_priv_txq_ibv_get(struct priv *priv, uint16_t idx)
461 struct mlx5_txq_ctrl *txq_ctrl;
463 if (idx >= priv->txqs_n)
465 if (!(*priv->txqs)[idx])
467 txq_ctrl = container_of((*priv->txqs)[idx], struct mlx5_txq_ctrl, txq);
469 rte_atomic32_inc(&txq_ctrl->ibv->refcnt);
470 DEBUG("%p: Verbs Tx queue %p: refcnt %d", (void *)priv,
471 (void *)txq_ctrl->ibv,
472 rte_atomic32_read(&txq_ctrl->ibv->refcnt));
474 return txq_ctrl->ibv;
478 * Release an Tx verbs queue object.
481 * Pointer to private structure.
483 * Verbs Tx queue object.
486 * 0 on success, errno on failure.
489 mlx5_priv_txq_ibv_release(struct priv *priv, struct mlx5_txq_ibv *txq_ibv)
493 DEBUG("%p: Verbs Tx queue %p: refcnt %d", (void *)priv,
494 (void *)txq_ibv, rte_atomic32_read(&txq_ibv->refcnt));
495 if (rte_atomic32_dec_and_test(&txq_ibv->refcnt)) {
496 claim_zero(ibv_destroy_qp(txq_ibv->qp));
497 claim_zero(ibv_destroy_cq(txq_ibv->cq));
498 LIST_REMOVE(txq_ibv, next);
506 * Return true if a single reference exists on the object.
509 * Pointer to private structure.
511 * Verbs Tx queue object.
514 mlx5_priv_txq_ibv_releasable(struct priv *priv, struct mlx5_txq_ibv *txq_ibv)
518 return (rte_atomic32_read(&txq_ibv->refcnt) == 1);
522 * Verify the Verbs Tx queue list is empty
525 * Pointer to private structure.
527 * @return the number of object not released.
530 mlx5_priv_txq_ibv_verify(struct priv *priv)
533 struct mlx5_txq_ibv *txq_ibv;
535 LIST_FOREACH(txq_ibv, &priv->txqsibv, next) {
536 DEBUG("%p: Verbs Tx queue %p still referenced", (void *)priv,
544 * Create a DPDK Tx queue.
547 * Pointer to private structure.
551 * Number of descriptors to configure in queue.
553 * NUMA socket on which memory must be allocated.
555 * Thresholds parameters.
558 * A DPDK queue object on success.
560 struct mlx5_txq_ctrl*
561 mlx5_priv_txq_new(struct priv *priv, uint16_t idx, uint16_t desc,
563 const struct rte_eth_txconf *conf)
565 const unsigned int max_tso_inline =
566 ((MLX5_MAX_TSO_HEADER + (RTE_CACHE_LINE_SIZE - 1)) /
567 RTE_CACHE_LINE_SIZE);
568 struct mlx5_txq_ctrl *tmpl;
570 tmpl = rte_calloc_socket("TXQ", 1,
572 desc * sizeof(struct rte_mbuf *),
576 assert(desc > MLX5_TX_COMP_THRESH);
577 tmpl->txq.flags = conf->txq_flags;
579 tmpl->socket = socket;
580 tmpl->txq.elts_n = log2above(desc);
581 if (priv->mps == MLX5_MPW_ENHANCED)
582 tmpl->txq.mpw_hdr_dseg = priv->mpw_hdr_dseg;
583 /* MRs will be registered in mp2mr[] later. */
584 DEBUG("priv->device_attr.max_qp_wr is %d",
585 priv->device_attr.orig_attr.max_qp_wr);
586 DEBUG("priv->device_attr.max_sge is %d",
587 priv->device_attr.orig_attr.max_sge);
588 if (priv->txq_inline && (priv->txqs_n >= priv->txqs_inline)) {
591 tmpl->txq.max_inline =
592 ((priv->txq_inline + (RTE_CACHE_LINE_SIZE - 1)) /
593 RTE_CACHE_LINE_SIZE);
594 tmpl->txq.inline_en = 1;
595 /* TSO and MPS can't be enabled concurrently. */
596 assert(!priv->tso || !priv->mps);
597 if (priv->mps == MLX5_MPW_ENHANCED) {
598 tmpl->txq.inline_max_packet_sz =
599 priv->inline_max_packet_sz;
600 /* To minimize the size of data set, avoid requesting
603 tmpl->max_inline_data =
604 ((RTE_MIN(priv->txq_inline,
605 priv->inline_max_packet_sz) +
606 (RTE_CACHE_LINE_SIZE - 1)) /
607 RTE_CACHE_LINE_SIZE) * RTE_CACHE_LINE_SIZE;
608 } else if (priv->tso) {
609 int inline_diff = tmpl->txq.max_inline - max_tso_inline;
612 * Adjust inline value as Verbs aggregates
613 * tso_inline and txq_inline fields.
615 tmpl->max_inline_data = inline_diff > 0 ?
617 RTE_CACHE_LINE_SIZE :
620 tmpl->max_inline_data =
621 tmpl->txq.max_inline * RTE_CACHE_LINE_SIZE;
624 * Check if the inline size is too large in a way which
625 * can make the WQE DS to overflow.
626 * Considering in calculation:
631 ds_cnt = 2 + (tmpl->txq.max_inline / MLX5_WQE_DWORD_SIZE);
632 if (ds_cnt > MLX5_DSEG_MAX) {
633 unsigned int max_inline = (MLX5_DSEG_MAX - 2) *
636 max_inline = max_inline - (max_inline %
637 RTE_CACHE_LINE_SIZE);
638 WARN("txq inline is too large (%d) setting it to "
639 "the maximum possible: %d\n",
640 priv->txq_inline, max_inline);
641 tmpl->txq.max_inline = max_inline / RTE_CACHE_LINE_SIZE;
645 tmpl->max_tso_header = max_tso_inline * RTE_CACHE_LINE_SIZE;
646 tmpl->txq.max_inline = RTE_MAX(tmpl->txq.max_inline,
648 tmpl->txq.tso_en = 1;
651 tmpl->txq.tunnel_en = 1;
653 (struct rte_mbuf *(*)[1 << tmpl->txq.elts_n])(tmpl + 1);
654 tmpl->txq.stats.idx = idx;
655 rte_atomic32_inc(&tmpl->refcnt);
656 DEBUG("%p: Tx queue %p: refcnt %d", (void *)priv,
657 (void *)tmpl, rte_atomic32_read(&tmpl->refcnt));
658 LIST_INSERT_HEAD(&priv->txqsctrl, tmpl, next);
666 * Pointer to private structure.
671 * A pointer to the queue if it exists.
673 struct mlx5_txq_ctrl*
674 mlx5_priv_txq_get(struct priv *priv, uint16_t idx)
676 struct mlx5_txq_ctrl *ctrl = NULL;
678 if ((*priv->txqs)[idx]) {
679 ctrl = container_of((*priv->txqs)[idx], struct mlx5_txq_ctrl,
683 mlx5_priv_txq_ibv_get(priv, idx);
684 for (i = 0; i != MLX5_PMD_TX_MP_CACHE; ++i) {
685 struct mlx5_mr *mr = NULL;
688 if (ctrl->txq.mp2mr[i]) {
689 mr = priv_mr_get(priv, ctrl->txq.mp2mr[i]->mp);
693 rte_atomic32_inc(&ctrl->refcnt);
694 DEBUG("%p: Tx queue %p: refcnt %d", (void *)priv,
695 (void *)ctrl, rte_atomic32_read(&ctrl->refcnt));
701 * Release a Tx queue.
704 * Pointer to private structure.
709 * 0 on success, errno on failure.
712 mlx5_priv_txq_release(struct priv *priv, uint16_t idx)
715 struct mlx5_txq_ctrl *txq;
717 if (!(*priv->txqs)[idx])
719 txq = container_of((*priv->txqs)[idx], struct mlx5_txq_ctrl, txq);
720 DEBUG("%p: Tx queue %p: refcnt %d", (void *)priv,
721 (void *)txq, rte_atomic32_read(&txq->refcnt));
725 ret = mlx5_priv_txq_ibv_release(priv, txq->ibv);
729 for (i = 0; i != MLX5_PMD_TX_MP_CACHE; ++i) {
730 if (txq->txq.mp2mr[i]) {
731 priv_mr_release(priv, txq->txq.mp2mr[i]);
732 txq->txq.mp2mr[i] = NULL;
735 if (rte_atomic32_dec_and_test(&txq->refcnt)) {
737 LIST_REMOVE(txq, next);
739 (*priv->txqs)[idx] = NULL;
746 * Verify if the queue can be released.
749 * Pointer to private structure.
754 * 1 if the queue can be released.
757 mlx5_priv_txq_releasable(struct priv *priv, uint16_t idx)
759 struct mlx5_txq_ctrl *txq;
761 if (!(*priv->txqs)[idx])
763 txq = container_of((*priv->txqs)[idx], struct mlx5_txq_ctrl, txq);
764 return (rte_atomic32_read(&txq->refcnt) == 1);
768 * Verify the Tx Queue list is empty
771 * Pointer to private structure.
773 * @return the number of object not released.
776 mlx5_priv_txq_verify(struct priv *priv)
778 struct mlx5_txq_ctrl *txq;
781 LIST_FOREACH(txq, &priv->txqsctrl, next) {
782 DEBUG("%p: Tx Queue %p still referenced", (void *)priv,