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