2 * Copyright (c) 2016 Solarflare Communications Inc.
5 * This software was jointly developed between OKTET Labs (under contract
6 * for Solarflare) and Solarflare Communications, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <rte_mempool.h>
35 #include "sfc_debug.h"
39 #include "sfc_tweak.h"
42 * Maximum number of Rx queue flush attempt in the case of failure or
45 #define SFC_RX_QFLUSH_ATTEMPTS (3)
48 * Time to wait between event queue polling attempts when waiting for Rx
49 * queue flush done or failed events.
51 #define SFC_RX_QFLUSH_POLL_WAIT_MS (1)
54 * Maximum number of event queue polling attempts when waiting for Rx queue
55 * flush done or failed events. It defines Rx queue flush attempt timeout
56 * together with SFC_RX_QFLUSH_POLL_WAIT_MS.
58 #define SFC_RX_QFLUSH_POLL_ATTEMPTS (2000)
61 sfc_rx_qflush_done(struct sfc_rxq *rxq)
63 rxq->state |= SFC_RXQ_FLUSHED;
64 rxq->state &= ~SFC_RXQ_FLUSHING;
68 sfc_rx_qflush_failed(struct sfc_rxq *rxq)
70 rxq->state |= SFC_RXQ_FLUSH_FAILED;
71 rxq->state &= ~SFC_RXQ_FLUSHING;
75 sfc_rx_qrefill(struct sfc_rxq *rxq)
77 unsigned int free_space;
79 void *objs[SFC_RX_REFILL_BULK];
80 efsys_dma_addr_t addr[RTE_DIM(objs)];
81 unsigned int added = rxq->added;
84 struct sfc_rx_sw_desc *rxd;
86 uint8_t port_id = rxq->port_id;
88 free_space = EFX_RXQ_LIMIT(rxq->ptr_mask + 1) -
89 (added - rxq->completed);
90 bulks = free_space / RTE_DIM(objs);
92 id = added & rxq->ptr_mask;
94 if (rte_mempool_get_bulk(rxq->refill_mb_pool, objs,
97 * It is hardly a safe way to increment counter
98 * from different contexts, but all PMDs do it.
100 rxq->evq->sa->eth_dev->data->rx_mbuf_alloc_failed +=
105 for (i = 0; i < RTE_DIM(objs);
106 ++i, id = (id + 1) & rxq->ptr_mask) {
109 rxd = &rxq->sw_desc[id];
112 rte_mbuf_refcnt_set(m, 1);
113 m->data_off = RTE_PKTMBUF_HEADROOM;
118 addr[i] = rte_pktmbuf_mtophys(m);
121 efx_rx_qpost(rxq->common, addr, rxq->buf_size,
122 RTE_DIM(objs), rxq->completed, added);
123 added += RTE_DIM(objs);
126 /* Push doorbell if something is posted */
127 if (rxq->added != added) {
129 efx_rx_qpush(rxq->common, added, &rxq->pushed);
134 sfc_rx_desc_flags_to_offload_flags(const unsigned int desc_flags)
136 uint64_t mbuf_flags = 0;
138 switch (desc_flags & (EFX_PKT_IPV4 | EFX_CKSUM_IPV4)) {
139 case (EFX_PKT_IPV4 | EFX_CKSUM_IPV4):
140 mbuf_flags |= PKT_RX_IP_CKSUM_GOOD;
143 mbuf_flags |= PKT_RX_IP_CKSUM_BAD;
146 RTE_BUILD_BUG_ON(PKT_RX_IP_CKSUM_UNKNOWN != 0);
147 SFC_ASSERT((mbuf_flags & PKT_RX_IP_CKSUM_MASK) ==
148 PKT_RX_IP_CKSUM_UNKNOWN);
152 switch ((desc_flags &
153 (EFX_PKT_TCP | EFX_PKT_UDP | EFX_CKSUM_TCPUDP))) {
154 case (EFX_PKT_TCP | EFX_CKSUM_TCPUDP):
155 case (EFX_PKT_UDP | EFX_CKSUM_TCPUDP):
156 mbuf_flags |= PKT_RX_L4_CKSUM_GOOD;
160 mbuf_flags |= PKT_RX_L4_CKSUM_BAD;
163 RTE_BUILD_BUG_ON(PKT_RX_L4_CKSUM_UNKNOWN != 0);
164 SFC_ASSERT((mbuf_flags & PKT_RX_L4_CKSUM_MASK) ==
165 PKT_RX_L4_CKSUM_UNKNOWN);
173 sfc_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
175 struct sfc_rxq *rxq = rx_queue;
176 unsigned int completed;
177 unsigned int prefix_size = rxq->prefix_size;
178 unsigned int done_pkts = 0;
179 boolean_t discard_next = B_FALSE;
181 if (unlikely((rxq->state & SFC_RXQ_RUNNING) == 0))
184 sfc_ev_qpoll(rxq->evq);
186 completed = rxq->completed;
187 while (completed != rxq->pending && done_pkts < nb_pkts) {
189 struct sfc_rx_sw_desc *rxd;
191 unsigned int seg_len;
192 unsigned int desc_flags;
194 id = completed++ & rxq->ptr_mask;
195 rxd = &rxq->sw_desc[id];
197 desc_flags = rxd->flags;
202 if (desc_flags & (EFX_ADDR_MISMATCH | EFX_DISCARD))
205 if (desc_flags & EFX_PKT_CONT)
208 if (desc_flags & EFX_PKT_PREFIX_LEN) {
212 rc = efx_pseudo_hdr_pkt_length_get(rxq->common,
213 rte_pktmbuf_mtod(m, uint8_t *), &tmp_size);
217 seg_len = rxd->size - prefix_size;
220 m->data_off += prefix_size;
221 rte_pktmbuf_data_len(m) = seg_len;
222 rte_pktmbuf_pkt_len(m) = seg_len;
224 m->ol_flags = sfc_rx_desc_flags_to_offload_flags(desc_flags);
225 m->packet_type = RTE_PTYPE_L2_ETHER;
232 discard_next = ((desc_flags & EFX_PKT_CONT) != 0);
233 rte_mempool_put(rxq->refill_mb_pool, m);
237 rxq->completed = completed;
245 sfc_rx_qpurge(struct sfc_rxq *rxq)
248 struct sfc_rx_sw_desc *rxd;
250 for (i = rxq->completed; i != rxq->added; ++i) {
251 rxd = &rxq->sw_desc[i & rxq->ptr_mask];
252 rte_mempool_put(rxq->refill_mb_pool, rxd->mbuf);
258 sfc_rx_qflush(struct sfc_adapter *sa, unsigned int sw_index)
261 unsigned int retry_count;
262 unsigned int wait_count;
264 rxq = sa->rxq_info[sw_index].rxq;
265 SFC_ASSERT(rxq->state & SFC_RXQ_STARTED);
268 * Retry Rx queue flushing in the case of flush failed or
269 * timeout. In the worst case it can delay for 6 seconds.
271 for (retry_count = 0;
272 ((rxq->state & SFC_RXQ_FLUSHED) == 0) &&
273 (retry_count < SFC_RX_QFLUSH_ATTEMPTS);
275 if (efx_rx_qflush(rxq->common) != 0) {
276 rxq->state |= SFC_RXQ_FLUSH_FAILED;
279 rxq->state &= ~SFC_RXQ_FLUSH_FAILED;
280 rxq->state |= SFC_RXQ_FLUSHING;
283 * Wait for Rx queue flush done or failed event at least
284 * SFC_RX_QFLUSH_POLL_WAIT_MS milliseconds and not more
285 * than 2 seconds (SFC_RX_QFLUSH_POLL_WAIT_MS multiplied
286 * by SFC_RX_QFLUSH_POLL_ATTEMPTS).
290 rte_delay_ms(SFC_RX_QFLUSH_POLL_WAIT_MS);
291 sfc_ev_qpoll(rxq->evq);
292 } while ((rxq->state & SFC_RXQ_FLUSHING) &&
293 (wait_count++ < SFC_RX_QFLUSH_POLL_ATTEMPTS));
295 if (rxq->state & SFC_RXQ_FLUSHING)
296 sfc_err(sa, "RxQ %u flush timed out", sw_index);
298 if (rxq->state & SFC_RXQ_FLUSH_FAILED)
299 sfc_err(sa, "RxQ %u flush failed", sw_index);
301 if (rxq->state & SFC_RXQ_FLUSHED)
302 sfc_info(sa, "RxQ %u flushed", sw_index);
309 sfc_rx_qstart(struct sfc_adapter *sa, unsigned int sw_index)
311 struct sfc_rxq_info *rxq_info;
316 sfc_log_init(sa, "sw_index=%u", sw_index);
318 SFC_ASSERT(sw_index < sa->rxq_count);
320 rxq_info = &sa->rxq_info[sw_index];
322 SFC_ASSERT(rxq->state == SFC_RXQ_INITIALIZED);
326 rc = sfc_ev_qstart(sa, evq->evq_index);
330 rc = efx_rx_qcreate(sa->nic, rxq->hw_index, 0, rxq_info->type,
331 &rxq->mem, rxq_info->entries,
332 0 /* not used on EF10 */, evq->common,
335 goto fail_rx_qcreate;
337 efx_rx_qenable(rxq->common);
339 rxq->pending = rxq->completed = rxq->added = rxq->pushed = 0;
341 rxq->state |= (SFC_RXQ_STARTED | SFC_RXQ_RUNNING);
346 rc = efx_mac_filter_default_rxq_set(sa->nic, rxq->common,
349 goto fail_mac_filter_default_rxq_set;
352 /* It seems to be used by DPDK for debug purposes only ('rte_ether') */
353 sa->eth_dev->data->rx_queue_state[sw_index] =
354 RTE_ETH_QUEUE_STATE_STARTED;
358 fail_mac_filter_default_rxq_set:
359 sfc_rx_qflush(sa, sw_index);
362 sfc_ev_qstop(sa, evq->evq_index);
369 sfc_rx_qstop(struct sfc_adapter *sa, unsigned int sw_index)
371 struct sfc_rxq_info *rxq_info;
374 sfc_log_init(sa, "sw_index=%u", sw_index);
376 SFC_ASSERT(sw_index < sa->rxq_count);
378 rxq_info = &sa->rxq_info[sw_index];
380 SFC_ASSERT(rxq->state & SFC_RXQ_STARTED);
382 /* It seems to be used by DPDK for debug purposes only ('rte_ether') */
383 sa->eth_dev->data->rx_queue_state[sw_index] =
384 RTE_ETH_QUEUE_STATE_STOPPED;
386 rxq->state &= ~SFC_RXQ_RUNNING;
389 efx_mac_filter_default_rxq_clear(sa->nic);
391 sfc_rx_qflush(sa, sw_index);
393 rxq->state = SFC_RXQ_INITIALIZED;
395 efx_rx_qdestroy(rxq->common);
397 sfc_ev_qstop(sa, rxq->evq->evq_index);
401 sfc_rx_qcheck_conf(struct sfc_adapter *sa,
402 const struct rte_eth_rxconf *rx_conf)
406 if (rx_conf->rx_thresh.pthresh != 0 ||
407 rx_conf->rx_thresh.hthresh != 0 ||
408 rx_conf->rx_thresh.wthresh != 0) {
410 "RxQ prefetch/host/writeback thresholds are not supported");
414 if (rx_conf->rx_free_thresh != 0) {
415 sfc_err(sa, "RxQ free threshold is not supported");
419 if (rx_conf->rx_drop_en == 0) {
420 sfc_err(sa, "RxQ drop disable is not supported");
424 if (rx_conf->rx_deferred_start != 0) {
425 sfc_err(sa, "RxQ deferred start is not supported");
433 sfc_rx_mbuf_data_alignment(struct rte_mempool *mb_pool)
438 /* The mbuf object itself is always cache line aligned */
439 order = rte_bsf32(RTE_CACHE_LINE_SIZE);
441 /* Data offset from mbuf object start */
442 data_off = sizeof(struct rte_mbuf) + rte_pktmbuf_priv_size(mb_pool) +
443 RTE_PKTMBUF_HEADROOM;
445 order = MIN(order, rte_bsf32(data_off));
447 return 1u << (order - 1);
451 sfc_rx_mb_pool_buf_size(struct sfc_adapter *sa, struct rte_mempool *mb_pool)
453 const efx_nic_cfg_t *encp = efx_nic_cfg_get(sa->nic);
454 const uint32_t nic_align_start = MAX(1, encp->enc_rx_buf_align_start);
455 const uint32_t nic_align_end = MAX(1, encp->enc_rx_buf_align_end);
457 unsigned int buf_aligned;
458 unsigned int start_alignment;
459 unsigned int end_padding_alignment;
461 /* Below it is assumed that both alignments are power of 2 */
462 SFC_ASSERT(rte_is_power_of_2(nic_align_start));
463 SFC_ASSERT(rte_is_power_of_2(nic_align_end));
466 * mbuf is always cache line aligned, double-check
467 * that it meets rx buffer start alignment requirements.
470 /* Start from mbuf pool data room size */
471 buf_size = rte_pktmbuf_data_room_size(mb_pool);
473 /* Remove headroom */
474 if (buf_size <= RTE_PKTMBUF_HEADROOM) {
476 "RxQ mbuf pool %s object data room size %u is smaller than headroom %u",
477 mb_pool->name, buf_size, RTE_PKTMBUF_HEADROOM);
480 buf_size -= RTE_PKTMBUF_HEADROOM;
482 /* Calculate guaranteed data start alignment */
483 buf_aligned = sfc_rx_mbuf_data_alignment(mb_pool);
485 /* Reserve space for start alignment */
486 if (buf_aligned < nic_align_start) {
487 start_alignment = nic_align_start - buf_aligned;
488 if (buf_size <= start_alignment) {
490 "RxQ mbuf pool %s object data room size %u is insufficient for headroom %u and buffer start alignment %u required by NIC",
492 rte_pktmbuf_data_room_size(mb_pool),
493 RTE_PKTMBUF_HEADROOM, start_alignment);
496 buf_aligned = nic_align_start;
497 buf_size -= start_alignment;
502 /* Make sure that end padding does not write beyond the buffer */
503 if (buf_aligned < nic_align_end) {
505 * Estimate space which can be lost. If guarnteed buffer
506 * size is odd, lost space is (nic_align_end - 1). More
507 * accurate formula is below.
509 end_padding_alignment = nic_align_end -
510 MIN(buf_aligned, 1u << (rte_bsf32(buf_size) - 1));
511 if (buf_size <= end_padding_alignment) {
513 "RxQ mbuf pool %s object data room size %u is insufficient for headroom %u, buffer start alignment %u and end padding alignment %u required by NIC",
515 rte_pktmbuf_data_room_size(mb_pool),
516 RTE_PKTMBUF_HEADROOM, start_alignment,
517 end_padding_alignment);
520 buf_size -= end_padding_alignment;
523 * Start is aligned the same or better than end,
526 buf_size = P2ALIGN(buf_size, nic_align_end);
533 sfc_rx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
534 uint16_t nb_rx_desc, unsigned int socket_id,
535 const struct rte_eth_rxconf *rx_conf,
536 struct rte_mempool *mb_pool)
538 const efx_nic_cfg_t *encp = efx_nic_cfg_get(sa->nic);
541 struct sfc_rxq_info *rxq_info;
542 unsigned int evq_index;
546 rc = sfc_rx_qcheck_conf(sa, rx_conf);
550 buf_size = sfc_rx_mb_pool_buf_size(sa, mb_pool);
552 sfc_err(sa, "RxQ %u mbuf pool object size is too small",
558 if ((buf_size < sa->port.pdu + encp->enc_rx_prefix_size) &&
559 !sa->eth_dev->data->dev_conf.rxmode.enable_scatter) {
560 sfc_err(sa, "Rx scatter is disabled and RxQ %u mbuf pool "
561 "object size is too small", sw_index);
562 sfc_err(sa, "RxQ %u calculated Rx buffer size is %u vs "
563 "PDU size %u plus Rx prefix %u bytes",
564 sw_index, buf_size, (unsigned int)sa->port.pdu,
565 encp->enc_rx_prefix_size);
570 SFC_ASSERT(sw_index < sa->rxq_count);
571 rxq_info = &sa->rxq_info[sw_index];
573 SFC_ASSERT(nb_rx_desc <= rxq_info->max_entries);
574 rxq_info->entries = nb_rx_desc;
575 rxq_info->type = EFX_RXQ_TYPE_DEFAULT;
577 evq_index = sfc_evq_index_by_rxq_sw_index(sa, sw_index);
579 rc = sfc_ev_qinit(sa, evq_index, rxq_info->entries, socket_id);
583 evq = sa->evq_info[evq_index].evq;
586 rxq = rte_zmalloc_socket("sfc-rxq", sizeof(*rxq), RTE_CACHE_LINE_SIZE,
591 rc = sfc_dma_alloc(sa, "rxq", sw_index, EFX_RXQ_SIZE(rxq_info->entries),
592 socket_id, &rxq->mem);
597 rxq->sw_desc = rte_calloc_socket("sfc-rxq-sw_desc", rxq_info->entries,
598 sizeof(*rxq->sw_desc),
599 RTE_CACHE_LINE_SIZE, socket_id);
600 if (rxq->sw_desc == NULL)
601 goto fail_desc_alloc;
605 rxq->ptr_mask = rxq_info->entries - 1;
606 rxq->refill_mb_pool = mb_pool;
607 rxq->buf_size = buf_size;
608 rxq->hw_index = sw_index;
609 rxq->port_id = sa->eth_dev->data->port_id;
611 /* Cache limits required on datapath in RxQ structure */
612 rxq->batch_max = encp->enc_rx_batch_max;
613 rxq->prefix_size = encp->enc_rx_prefix_size;
615 rxq->state = SFC_RXQ_INITIALIZED;
622 sfc_dma_free(sa, &rxq->mem);
628 sfc_ev_qfini(sa, evq_index);
631 rxq_info->entries = 0;
634 sfc_log_init(sa, "failed %d", rc);
639 sfc_rx_qfini(struct sfc_adapter *sa, unsigned int sw_index)
641 struct sfc_rxq_info *rxq_info;
644 SFC_ASSERT(sw_index < sa->rxq_count);
646 rxq_info = &sa->rxq_info[sw_index];
649 SFC_ASSERT(rxq->state == SFC_RXQ_INITIALIZED);
651 rxq_info->rxq = NULL;
652 rxq_info->entries = 0;
654 rte_free(rxq->sw_desc);
655 sfc_dma_free(sa, &rxq->mem);
660 sfc_rx_start(struct sfc_adapter *sa)
662 unsigned int sw_index;
665 sfc_log_init(sa, "rxq_count=%u", sa->rxq_count);
667 rc = efx_rx_init(sa->nic);
671 for (sw_index = 0; sw_index < sa->rxq_count; ++sw_index) {
672 rc = sfc_rx_qstart(sa, sw_index);
680 while (sw_index-- > 0)
681 sfc_rx_qstop(sa, sw_index);
683 efx_rx_fini(sa->nic);
686 sfc_log_init(sa, "failed %d", rc);
691 sfc_rx_stop(struct sfc_adapter *sa)
693 unsigned int sw_index;
695 sfc_log_init(sa, "rxq_count=%u", sa->rxq_count);
697 sw_index = sa->rxq_count;
698 while (sw_index-- > 0) {
699 if (sa->rxq_info[sw_index].rxq != NULL)
700 sfc_rx_qstop(sa, sw_index);
703 efx_rx_fini(sa->nic);
707 sfc_rx_qinit_info(struct sfc_adapter *sa, unsigned int sw_index)
709 struct sfc_rxq_info *rxq_info = &sa->rxq_info[sw_index];
710 unsigned int max_entries;
712 max_entries = EFX_RXQ_MAXNDESCS;
713 SFC_ASSERT(rte_is_power_of_2(max_entries));
715 rxq_info->max_entries = max_entries;
721 sfc_rx_check_mode(struct sfc_adapter *sa, struct rte_eth_rxmode *rxmode)
725 switch (rxmode->mq_mode) {
727 /* No special checks are required */
730 sfc_err(sa, "Rx multi-queue mode %u not supported",
735 if (rxmode->header_split) {
736 sfc_err(sa, "Header split on Rx not supported");
740 if (rxmode->hw_vlan_filter) {
741 sfc_err(sa, "HW VLAN filtering not supported");
745 if (rxmode->hw_vlan_strip) {
746 sfc_err(sa, "HW VLAN stripping not supported");
750 if (rxmode->hw_vlan_extend) {
752 "Q-in-Q HW VLAN stripping not supported");
756 if (!rxmode->hw_strip_crc) {
758 "FCS stripping control not supported - always stripped");
759 rxmode->hw_strip_crc = 1;
762 if (rxmode->enable_scatter) {
763 sfc_err(sa, "Scatter on Rx not supported");
767 if (rxmode->enable_lro) {
768 sfc_err(sa, "LRO not supported");
776 * Initialize Rx subsystem.
778 * Called at device configuration stage when number of receive queues is
779 * specified together with other device level receive configuration.
781 * It should be used to allocate NUMA-unaware resources.
784 sfc_rx_init(struct sfc_adapter *sa)
786 struct rte_eth_conf *dev_conf = &sa->eth_dev->data->dev_conf;
787 unsigned int sw_index;
790 rc = sfc_rx_check_mode(sa, &dev_conf->rxmode);
792 goto fail_check_mode;
794 sa->rxq_count = sa->eth_dev->data->nb_rx_queues;
797 sa->rxq_info = rte_calloc_socket("sfc-rxqs", sa->rxq_count,
798 sizeof(struct sfc_rxq_info), 0,
800 if (sa->rxq_info == NULL)
801 goto fail_rxqs_alloc;
803 for (sw_index = 0; sw_index < sa->rxq_count; ++sw_index) {
804 rc = sfc_rx_qinit_info(sa, sw_index);
806 goto fail_rx_qinit_info;
812 rte_free(sa->rxq_info);
818 sfc_log_init(sa, "failed %d", rc);
823 * Shutdown Rx subsystem.
825 * Called at device close stage, for example, before device
826 * reconfiguration or shutdown.
829 sfc_rx_fini(struct sfc_adapter *sa)
831 unsigned int sw_index;
833 sw_index = sa->rxq_count;
834 while (sw_index-- > 0) {
835 if (sa->rxq_info[sw_index].rxq != NULL)
836 sfc_rx_qfini(sa, sw_index);
839 rte_free(sa->rxq_info);