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