1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2019-2020 Intel Corporation.
9 #include <netinet/in.h>
11 #include <sys/socket.h>
12 #include <sys/ioctl.h>
13 #include <linux/if_ether.h>
14 #include <linux/if_xdp.h>
15 #include <linux/if_link.h>
16 #include <linux/ethtool.h>
17 #include <linux/sockios.h>
18 #include "af_xdp_deps.h"
21 #include <rte_ethdev.h>
22 #include <rte_ethdev_driver.h>
23 #include <rte_ethdev_vdev.h>
24 #include <rte_kvargs.h>
25 #include <rte_bus_vdev.h>
26 #include <rte_string_fns.h>
27 #include <rte_branch_prediction.h>
28 #include <rte_common.h>
31 #include <rte_ether.h>
32 #include <rte_lcore.h>
34 #include <rte_memory.h>
35 #include <rte_memzone.h>
36 #include <rte_mempool.h>
38 #include <rte_malloc.h>
40 #include <rte_spinlock.h>
57 RTE_LOG_REGISTER(af_xdp_logtype, pmd.net.af_xdp, NOTICE);
59 #define AF_XDP_LOG(level, fmt, args...) \
60 rte_log(RTE_LOG_ ## level, af_xdp_logtype, \
61 "%s(): " fmt, __func__, ##args)
63 #define ETH_AF_XDP_FRAME_SIZE 2048
64 #define ETH_AF_XDP_NUM_BUFFERS 4096
65 #define ETH_AF_XDP_DFLT_NUM_DESCS XSK_RING_CONS__DEFAULT_NUM_DESCS
66 #define ETH_AF_XDP_DFLT_START_QUEUE_IDX 0
67 #define ETH_AF_XDP_DFLT_QUEUE_COUNT 1
69 #define ETH_AF_XDP_RX_BATCH_SIZE 32
70 #define ETH_AF_XDP_TX_BATCH_SIZE 32
73 struct xsk_umem_info {
74 struct xsk_umem *umem;
75 struct rte_ring *buf_ring;
76 const struct rte_memzone *mz;
77 struct rte_mempool *mb_pool;
90 struct xsk_ring_cons rx;
91 struct xsk_umem_info *umem;
92 struct xsk_socket *xsk;
93 struct rte_mempool *mb_pool;
95 struct rx_stats stats;
97 struct xsk_ring_prod fq;
98 struct xsk_ring_cons cq;
100 struct pkt_tx_queue *pair;
101 struct pollfd fds[1];
111 struct pkt_tx_queue {
112 struct xsk_ring_prod tx;
113 struct xsk_umem_info *umem;
115 struct tx_stats stats;
117 struct pkt_rx_queue *pair;
121 struct pmd_internals {
123 char if_name[IFNAMSIZ];
127 int combined_queue_cnt;
129 char prog_path[PATH_MAX];
130 bool custom_prog_configured;
132 struct rte_ether_addr eth_addr;
134 struct pkt_rx_queue *rx_queues;
135 struct pkt_tx_queue *tx_queues;
138 #define ETH_AF_XDP_IFACE_ARG "iface"
139 #define ETH_AF_XDP_START_QUEUE_ARG "start_queue"
140 #define ETH_AF_XDP_QUEUE_COUNT_ARG "queue_count"
141 #define ETH_AF_XDP_SHARED_UMEM_ARG "shared_umem"
142 #define ETH_AF_XDP_PROG_ARG "xdp_prog"
144 static const char * const valid_arguments[] = {
145 ETH_AF_XDP_IFACE_ARG,
146 ETH_AF_XDP_START_QUEUE_ARG,
147 ETH_AF_XDP_QUEUE_COUNT_ARG,
148 ETH_AF_XDP_SHARED_UMEM_ARG,
153 static const struct rte_eth_link pmd_link = {
154 .link_speed = ETH_SPEED_NUM_10G,
155 .link_duplex = ETH_LINK_FULL_DUPLEX,
156 .link_status = ETH_LINK_DOWN,
157 .link_autoneg = ETH_LINK_AUTONEG
160 /* List which tracks PMDs to facilitate sharing UMEMs across them. */
161 struct internal_list {
162 TAILQ_ENTRY(internal_list) next;
163 struct rte_eth_dev *eth_dev;
166 TAILQ_HEAD(internal_list_head, internal_list);
167 static struct internal_list_head internal_list =
168 TAILQ_HEAD_INITIALIZER(internal_list);
170 static pthread_mutex_t internal_list_lock = PTHREAD_MUTEX_INITIALIZER;
172 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
174 reserve_fill_queue_zc(struct xsk_umem_info *umem, uint16_t reserve_size,
175 struct rte_mbuf **bufs, struct xsk_ring_prod *fq)
180 if (unlikely(!xsk_ring_prod__reserve(fq, reserve_size, &idx))) {
181 for (i = 0; i < reserve_size; i++)
182 rte_pktmbuf_free(bufs[i]);
183 AF_XDP_LOG(DEBUG, "Failed to reserve enough fq descs.\n");
187 for (i = 0; i < reserve_size; i++) {
191 fq_addr = xsk_ring_prod__fill_addr(fq, idx++);
192 addr = (uint64_t)bufs[i] - (uint64_t)umem->buffer -
193 umem->mb_pool->header_size;
197 xsk_ring_prod__submit(fq, reserve_size);
203 reserve_fill_queue_cp(struct xsk_umem_info *umem, uint16_t reserve_size,
204 struct rte_mbuf **bufs __rte_unused,
205 struct xsk_ring_prod *fq)
207 void *addrs[reserve_size];
211 if (rte_ring_dequeue_bulk(umem->buf_ring, addrs, reserve_size, NULL)
213 AF_XDP_LOG(DEBUG, "Failed to get enough buffers for fq.\n");
217 if (unlikely(!xsk_ring_prod__reserve(fq, reserve_size, &idx))) {
218 AF_XDP_LOG(DEBUG, "Failed to reserve enough fq descs.\n");
219 rte_ring_enqueue_bulk(umem->buf_ring, addrs,
224 for (i = 0; i < reserve_size; i++) {
227 fq_addr = xsk_ring_prod__fill_addr(fq, idx++);
228 *fq_addr = (uint64_t)addrs[i];
231 xsk_ring_prod__submit(fq, reserve_size);
238 reserve_fill_queue(struct xsk_umem_info *umem, uint16_t reserve_size,
239 struct rte_mbuf **bufs, struct xsk_ring_prod *fq)
241 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
242 return reserve_fill_queue_zc(umem, reserve_size, bufs, fq);
244 return reserve_fill_queue_cp(umem, reserve_size, bufs, fq);
248 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
250 af_xdp_rx_zc(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
252 struct pkt_rx_queue *rxq = queue;
253 struct xsk_ring_cons *rx = &rxq->rx;
254 struct xsk_ring_prod *fq = &rxq->fq;
255 struct xsk_umem_info *umem = rxq->umem;
257 unsigned long rx_bytes = 0;
259 struct rte_mbuf *fq_bufs[ETH_AF_XDP_RX_BATCH_SIZE];
261 /* allocate bufs for fill queue replenishment after rx */
262 if (rte_pktmbuf_alloc_bulk(umem->mb_pool, fq_bufs, nb_pkts)) {
264 "Failed to get enough buffers for fq.\n");
268 rcvd = xsk_ring_cons__peek(rx, nb_pkts, &idx_rx);
271 #if defined(XDP_USE_NEED_WAKEUP)
272 if (xsk_ring_prod__needs_wakeup(fq))
273 (void)poll(rxq->fds, 1, 1000);
279 for (i = 0; i < rcvd; i++) {
280 const struct xdp_desc *desc;
285 desc = xsk_ring_cons__rx_desc(rx, idx_rx++);
289 offset = xsk_umem__extract_offset(addr);
290 addr = xsk_umem__extract_addr(addr);
292 bufs[i] = (struct rte_mbuf *)
293 xsk_umem__get_data(umem->buffer, addr +
294 umem->mb_pool->header_size);
295 bufs[i]->data_off = offset - sizeof(struct rte_mbuf) -
296 rte_pktmbuf_priv_size(umem->mb_pool) -
297 umem->mb_pool->header_size;
299 rte_pktmbuf_pkt_len(bufs[i]) = len;
300 rte_pktmbuf_data_len(bufs[i]) = len;
304 xsk_ring_cons__release(rx, rcvd);
306 (void)reserve_fill_queue(umem, rcvd, fq_bufs, fq);
309 rxq->stats.rx_pkts += rcvd;
310 rxq->stats.rx_bytes += rx_bytes;
314 rte_mempool_put_bulk(umem->mb_pool, (void **)&fq_bufs[rcvd],
321 af_xdp_rx_cp(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
323 struct pkt_rx_queue *rxq = queue;
324 struct xsk_ring_cons *rx = &rxq->rx;
325 struct xsk_umem_info *umem = rxq->umem;
326 struct xsk_ring_prod *fq = &rxq->fq;
328 unsigned long rx_bytes = 0;
330 uint32_t free_thresh = fq->size >> 1;
331 struct rte_mbuf *mbufs[ETH_AF_XDP_RX_BATCH_SIZE];
333 if (xsk_prod_nb_free(fq, free_thresh) >= free_thresh)
334 (void)reserve_fill_queue(umem, ETH_AF_XDP_RX_BATCH_SIZE,
337 if (unlikely(rte_pktmbuf_alloc_bulk(rxq->mb_pool, mbufs, nb_pkts) != 0))
340 rcvd = xsk_ring_cons__peek(rx, nb_pkts, &idx_rx);
342 #if defined(XDP_USE_NEED_WAKEUP)
343 if (xsk_ring_prod__needs_wakeup(fq))
344 (void)poll(rxq->fds, 1, 1000);
350 for (i = 0; i < rcvd; i++) {
351 const struct xdp_desc *desc;
356 desc = xsk_ring_cons__rx_desc(rx, idx_rx++);
359 pkt = xsk_umem__get_data(rxq->umem->mz->addr, addr);
361 rte_memcpy(rte_pktmbuf_mtod(mbufs[i], void *), pkt, len);
362 rte_ring_enqueue(umem->buf_ring, (void *)addr);
363 rte_pktmbuf_pkt_len(mbufs[i]) = len;
364 rte_pktmbuf_data_len(mbufs[i]) = len;
369 xsk_ring_cons__release(rx, rcvd);
372 rxq->stats.rx_pkts += rcvd;
373 rxq->stats.rx_bytes += rx_bytes;
377 rte_mempool_put_bulk(rxq->mb_pool, (void **)&mbufs[rcvd],
385 eth_af_xdp_rx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
387 nb_pkts = RTE_MIN(nb_pkts, ETH_AF_XDP_RX_BATCH_SIZE);
389 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
390 return af_xdp_rx_zc(queue, bufs, nb_pkts);
392 return af_xdp_rx_cp(queue, bufs, nb_pkts);
397 pull_umem_cq(struct xsk_umem_info *umem, int size, struct xsk_ring_cons *cq)
402 n = xsk_ring_cons__peek(cq, size, &idx_cq);
404 for (i = 0; i < n; i++) {
406 addr = *xsk_ring_cons__comp_addr(cq, idx_cq++);
407 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
408 addr = xsk_umem__extract_addr(addr);
409 rte_pktmbuf_free((struct rte_mbuf *)
410 xsk_umem__get_data(umem->buffer,
411 addr + umem->mb_pool->header_size));
413 rte_ring_enqueue(umem->buf_ring, (void *)addr);
417 xsk_ring_cons__release(cq, n);
421 kick_tx(struct pkt_tx_queue *txq, struct xsk_ring_cons *cq)
423 struct xsk_umem_info *umem = txq->umem;
425 pull_umem_cq(umem, XSK_RING_CONS__DEFAULT_NUM_DESCS, cq);
427 #if defined(XDP_USE_NEED_WAKEUP)
428 if (xsk_ring_prod__needs_wakeup(&txq->tx))
430 while (send(xsk_socket__fd(txq->pair->xsk), NULL,
431 0, MSG_DONTWAIT) < 0) {
432 /* some thing unexpected */
433 if (errno != EBUSY && errno != EAGAIN && errno != EINTR)
436 /* pull from completion queue to leave more space */
439 XSK_RING_CONS__DEFAULT_NUM_DESCS,
444 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
446 af_xdp_tx_zc(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
448 struct pkt_tx_queue *txq = queue;
449 struct xsk_umem_info *umem = txq->umem;
450 struct rte_mbuf *mbuf;
451 unsigned long tx_bytes = 0;
455 struct xdp_desc *desc;
456 uint64_t addr, offset;
457 struct xsk_ring_cons *cq = &txq->pair->cq;
458 uint32_t free_thresh = cq->size >> 1;
460 if (xsk_cons_nb_avail(cq, free_thresh) >= free_thresh)
461 pull_umem_cq(umem, XSK_RING_CONS__DEFAULT_NUM_DESCS, cq);
463 for (i = 0; i < nb_pkts; i++) {
466 if (mbuf->pool == umem->mb_pool) {
467 if (!xsk_ring_prod__reserve(&txq->tx, 1, &idx_tx)) {
469 if (!xsk_ring_prod__reserve(&txq->tx, 1,
473 desc = xsk_ring_prod__tx_desc(&txq->tx, idx_tx);
474 desc->len = mbuf->pkt_len;
475 addr = (uint64_t)mbuf - (uint64_t)umem->buffer -
476 umem->mb_pool->header_size;
477 offset = rte_pktmbuf_mtod(mbuf, uint64_t) -
479 umem->mb_pool->header_size;
480 offset = offset << XSK_UNALIGNED_BUF_OFFSET_SHIFT;
481 desc->addr = addr | offset;
484 struct rte_mbuf *local_mbuf =
485 rte_pktmbuf_alloc(umem->mb_pool);
488 if (local_mbuf == NULL)
491 if (!xsk_ring_prod__reserve(&txq->tx, 1, &idx_tx)) {
492 rte_pktmbuf_free(local_mbuf);
497 desc = xsk_ring_prod__tx_desc(&txq->tx, idx_tx);
498 desc->len = mbuf->pkt_len;
500 addr = (uint64_t)local_mbuf - (uint64_t)umem->buffer -
501 umem->mb_pool->header_size;
502 offset = rte_pktmbuf_mtod(local_mbuf, uint64_t) -
503 (uint64_t)local_mbuf +
504 umem->mb_pool->header_size;
505 pkt = xsk_umem__get_data(umem->buffer, addr + offset);
506 offset = offset << XSK_UNALIGNED_BUF_OFFSET_SHIFT;
507 desc->addr = addr | offset;
508 rte_memcpy(pkt, rte_pktmbuf_mtod(mbuf, void *),
510 rte_pktmbuf_free(mbuf);
514 tx_bytes += mbuf->pkt_len;
520 xsk_ring_prod__submit(&txq->tx, count);
522 txq->stats.tx_pkts += count;
523 txq->stats.tx_bytes += tx_bytes;
524 txq->stats.tx_dropped += nb_pkts - count;
530 af_xdp_tx_cp(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
532 struct pkt_tx_queue *txq = queue;
533 struct xsk_umem_info *umem = txq->umem;
534 struct rte_mbuf *mbuf;
535 void *addrs[ETH_AF_XDP_TX_BATCH_SIZE];
536 unsigned long tx_bytes = 0;
539 struct xsk_ring_cons *cq = &txq->pair->cq;
541 nb_pkts = RTE_MIN(nb_pkts, ETH_AF_XDP_TX_BATCH_SIZE);
543 pull_umem_cq(umem, nb_pkts, cq);
545 nb_pkts = rte_ring_dequeue_bulk(umem->buf_ring, addrs,
550 if (xsk_ring_prod__reserve(&txq->tx, nb_pkts, &idx_tx) != nb_pkts) {
552 rte_ring_enqueue_bulk(umem->buf_ring, addrs, nb_pkts, NULL);
556 for (i = 0; i < nb_pkts; i++) {
557 struct xdp_desc *desc;
560 desc = xsk_ring_prod__tx_desc(&txq->tx, idx_tx + i);
562 desc->len = mbuf->pkt_len;
564 desc->addr = (uint64_t)addrs[i];
565 pkt = xsk_umem__get_data(umem->mz->addr,
567 rte_memcpy(pkt, rte_pktmbuf_mtod(mbuf, void *), desc->len);
568 tx_bytes += mbuf->pkt_len;
569 rte_pktmbuf_free(mbuf);
572 xsk_ring_prod__submit(&txq->tx, nb_pkts);
576 txq->stats.tx_pkts += nb_pkts;
577 txq->stats.tx_bytes += tx_bytes;
584 eth_af_xdp_tx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
586 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
587 return af_xdp_tx_zc(queue, bufs, nb_pkts);
589 return af_xdp_tx_cp(queue, bufs, nb_pkts);
594 eth_dev_start(struct rte_eth_dev *dev)
596 dev->data->dev_link.link_status = ETH_LINK_UP;
601 /* This function gets called when the current port gets stopped. */
603 eth_dev_stop(struct rte_eth_dev *dev)
605 dev->data->dev_link.link_status = ETH_LINK_DOWN;
608 /* Find ethdev in list */
609 static inline struct internal_list *
610 find_internal_resource(struct pmd_internals *port_int)
613 struct internal_list *list = NULL;
615 if (port_int == NULL)
618 pthread_mutex_lock(&internal_list_lock);
620 TAILQ_FOREACH(list, &internal_list, next) {
621 struct pmd_internals *list_int =
622 list->eth_dev->data->dev_private;
623 if (list_int == port_int) {
629 pthread_mutex_unlock(&internal_list_lock);
637 /* Get a pointer to an existing UMEM which overlays the rxq's mb_pool */
638 static inline struct xsk_umem_info *
639 get_shared_umem(struct pkt_rx_queue *rxq) {
640 struct internal_list *list;
641 struct pmd_internals *internals;
643 struct rte_mempool *mb_pool = rxq->mb_pool;
648 pthread_mutex_lock(&internal_list_lock);
650 TAILQ_FOREACH(list, &internal_list, next) {
651 internals = list->eth_dev->data->dev_private;
652 for (i = 0; i < internals->queue_cnt; i++) {
653 struct pkt_rx_queue *list_rxq =
654 &internals->rx_queues[i];
657 if (mb_pool == internals->rx_queues[i].mb_pool) {
659 &internals->rx_queues[i].umem->refcnt,
661 pthread_mutex_unlock(
662 &internal_list_lock);
663 return internals->rx_queues[i].umem;
669 pthread_mutex_unlock(&internal_list_lock);
675 eth_dev_configure(struct rte_eth_dev *dev)
677 struct pmd_internals *internal = dev->data->dev_private;
679 /* rx/tx must be paired */
680 if (dev->data->nb_rx_queues != dev->data->nb_tx_queues)
683 if (internal->shared_umem) {
684 struct internal_list *list = NULL;
685 const char *name = dev->device->name;
687 /* Ensure PMD is not already inserted into the list */
688 list = find_internal_resource(internal);
692 list = rte_zmalloc_socket(name, sizeof(*list), 0,
693 dev->device->numa_node);
698 pthread_mutex_lock(&internal_list_lock);
699 TAILQ_INSERT_TAIL(&internal_list, list, next);
700 pthread_mutex_unlock(&internal_list_lock);
707 eth_dev_info(struct rte_eth_dev *dev, struct rte_eth_dev_info *dev_info)
709 struct pmd_internals *internals = dev->data->dev_private;
711 dev_info->if_index = internals->if_index;
712 dev_info->max_mac_addrs = 1;
713 dev_info->max_rx_pktlen = ETH_FRAME_LEN;
714 dev_info->max_rx_queues = internals->queue_cnt;
715 dev_info->max_tx_queues = internals->queue_cnt;
717 dev_info->min_mtu = RTE_ETHER_MIN_MTU;
718 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
719 dev_info->max_mtu = getpagesize() -
720 sizeof(struct rte_mempool_objhdr) -
721 sizeof(struct rte_mbuf) -
722 RTE_PKTMBUF_HEADROOM - XDP_PACKET_HEADROOM;
724 dev_info->max_mtu = ETH_AF_XDP_FRAME_SIZE - XDP_PACKET_HEADROOM;
727 dev_info->default_rxportconf.nb_queues = 1;
728 dev_info->default_txportconf.nb_queues = 1;
729 dev_info->default_rxportconf.ring_size = ETH_AF_XDP_DFLT_NUM_DESCS;
730 dev_info->default_txportconf.ring_size = ETH_AF_XDP_DFLT_NUM_DESCS;
736 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
738 struct pmd_internals *internals = dev->data->dev_private;
739 struct xdp_statistics xdp_stats;
740 struct pkt_rx_queue *rxq;
741 struct pkt_tx_queue *txq;
745 for (i = 0; i < dev->data->nb_rx_queues; i++) {
746 optlen = sizeof(struct xdp_statistics);
747 rxq = &internals->rx_queues[i];
749 stats->q_ipackets[i] = rxq->stats.rx_pkts;
750 stats->q_ibytes[i] = rxq->stats.rx_bytes;
752 stats->q_opackets[i] = txq->stats.tx_pkts;
753 stats->q_obytes[i] = txq->stats.tx_bytes;
755 stats->ipackets += stats->q_ipackets[i];
756 stats->ibytes += stats->q_ibytes[i];
757 stats->imissed += rxq->stats.rx_dropped;
758 stats->oerrors += txq->stats.tx_dropped;
759 ret = getsockopt(xsk_socket__fd(rxq->xsk), SOL_XDP,
760 XDP_STATISTICS, &xdp_stats, &optlen);
762 AF_XDP_LOG(ERR, "getsockopt() failed for XDP_STATISTICS.\n");
765 stats->imissed += xdp_stats.rx_dropped;
767 stats->opackets += stats->q_opackets[i];
768 stats->obytes += stats->q_obytes[i];
775 eth_stats_reset(struct rte_eth_dev *dev)
777 struct pmd_internals *internals = dev->data->dev_private;
780 for (i = 0; i < internals->queue_cnt; i++) {
781 memset(&internals->rx_queues[i].stats, 0,
782 sizeof(struct rx_stats));
783 memset(&internals->tx_queues[i].stats, 0,
784 sizeof(struct tx_stats));
791 remove_xdp_program(struct pmd_internals *internals)
793 uint32_t curr_prog_id = 0;
795 if (bpf_get_link_xdp_id(internals->if_index, &curr_prog_id,
796 XDP_FLAGS_UPDATE_IF_NOEXIST)) {
797 AF_XDP_LOG(ERR, "bpf_get_link_xdp_id failed\n");
800 bpf_set_link_xdp_fd(internals->if_index, -1,
801 XDP_FLAGS_UPDATE_IF_NOEXIST);
805 xdp_umem_destroy(struct xsk_umem_info *umem)
807 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
808 umem->mb_pool = NULL;
810 rte_memzone_free(umem->mz);
813 rte_ring_free(umem->buf_ring);
814 umem->buf_ring = NULL;
822 eth_dev_close(struct rte_eth_dev *dev)
824 struct pmd_internals *internals = dev->data->dev_private;
825 struct pkt_rx_queue *rxq;
828 if (rte_eal_process_type() != RTE_PROC_PRIMARY)
831 AF_XDP_LOG(INFO, "Closing AF_XDP ethdev on numa socket %u\n",
834 for (i = 0; i < internals->queue_cnt; i++) {
835 rxq = &internals->rx_queues[i];
836 if (rxq->umem == NULL)
838 xsk_socket__delete(rxq->xsk);
840 if (__atomic_sub_fetch(&rxq->umem->refcnt, 1, __ATOMIC_ACQUIRE)
842 (void)xsk_umem__delete(rxq->umem->umem);
843 xdp_umem_destroy(rxq->umem);
846 /* free pkt_tx_queue */
852 * MAC is not allocated dynamically, setting it to NULL would prevent
853 * from releasing it in rte_eth_dev_release_port.
855 dev->data->mac_addrs = NULL;
857 remove_xdp_program(internals);
859 if (internals->shared_umem) {
860 struct internal_list *list;
862 /* Remove ethdev from list used to track and share UMEMs */
863 list = find_internal_resource(internals);
865 pthread_mutex_lock(&internal_list_lock);
866 TAILQ_REMOVE(&internal_list, list, next);
867 pthread_mutex_unlock(&internal_list_lock);
876 eth_queue_release(void *q __rte_unused)
881 eth_link_update(struct rte_eth_dev *dev __rte_unused,
882 int wait_to_complete __rte_unused)
887 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
888 static inline uint64_t get_base_addr(struct rte_mempool *mp, uint64_t *align)
890 struct rte_mempool_memhdr *memhdr;
891 uint64_t memhdr_addr, aligned_addr;
893 memhdr = STAILQ_FIRST(&mp->mem_list);
894 memhdr_addr = (uint64_t)memhdr->addr;
895 aligned_addr = memhdr_addr & ~(getpagesize() - 1);
896 *align = memhdr_addr - aligned_addr;
902 xsk_umem_info *xdp_umem_configure(struct pmd_internals *internals,
903 struct pkt_rx_queue *rxq)
905 struct xsk_umem_info *umem = NULL;
907 struct xsk_umem_config usr_config = {
908 .fill_size = ETH_AF_XDP_DFLT_NUM_DESCS * 2,
909 .comp_size = ETH_AF_XDP_DFLT_NUM_DESCS,
910 .flags = XDP_UMEM_UNALIGNED_CHUNK_FLAG};
911 void *base_addr = NULL;
912 struct rte_mempool *mb_pool = rxq->mb_pool;
913 uint64_t umem_size, align = 0;
915 if (internals->shared_umem) {
916 umem = get_shared_umem(rxq);
918 __atomic_load_n(&umem->refcnt, __ATOMIC_ACQUIRE) <
920 AF_XDP_LOG(INFO, "%s,qid%i sharing UMEM\n",
921 internals->if_name, rxq->xsk_queue_idx);
922 __atomic_fetch_add(&umem->refcnt, 1, __ATOMIC_ACQUIRE);
927 usr_config.frame_size =
928 rte_mempool_calc_obj_size(mb_pool->elt_size,
929 mb_pool->flags, NULL);
930 usr_config.frame_headroom = mb_pool->header_size +
931 sizeof(struct rte_mbuf) +
932 rte_pktmbuf_priv_size(mb_pool) +
933 RTE_PKTMBUF_HEADROOM;
935 umem = rte_zmalloc_socket("umem", sizeof(*umem), 0,
938 AF_XDP_LOG(ERR, "Failed to allocate umem info");
942 umem->mb_pool = mb_pool;
943 base_addr = (void *)get_base_addr(mb_pool, &align);
944 umem_size = mb_pool->populated_size * usr_config.frame_size +
947 ret = xsk_umem__create(&umem->umem, base_addr, umem_size,
948 &rxq->fq, &rxq->cq, &usr_config);
950 AF_XDP_LOG(ERR, "Failed to create umem");
953 umem->buffer = base_addr;
955 if (internals->shared_umem) {
956 umem->max_xsks = mb_pool->populated_size /
957 ETH_AF_XDP_NUM_BUFFERS;
958 AF_XDP_LOG(INFO, "Max xsks for UMEM %s: %u\n",
959 mb_pool->name, umem->max_xsks);
962 __atomic_store_n(&umem->refcnt, 1, __ATOMIC_RELEASE);
967 xsk_umem_info *xdp_umem_configure(struct pmd_internals *internals,
968 struct pkt_rx_queue *rxq)
970 struct xsk_umem_info *umem;
971 const struct rte_memzone *mz;
972 struct xsk_umem_config usr_config = {
973 .fill_size = ETH_AF_XDP_DFLT_NUM_DESCS,
974 .comp_size = ETH_AF_XDP_DFLT_NUM_DESCS,
975 .frame_size = ETH_AF_XDP_FRAME_SIZE,
976 .frame_headroom = 0 };
977 char ring_name[RTE_RING_NAMESIZE];
978 char mz_name[RTE_MEMZONE_NAMESIZE];
982 umem = rte_zmalloc_socket("umem", sizeof(*umem), 0, rte_socket_id());
984 AF_XDP_LOG(ERR, "Failed to allocate umem info");
988 snprintf(ring_name, sizeof(ring_name), "af_xdp_ring_%s_%u",
989 internals->if_name, rxq->xsk_queue_idx);
990 umem->buf_ring = rte_ring_create(ring_name,
991 ETH_AF_XDP_NUM_BUFFERS,
994 if (umem->buf_ring == NULL) {
995 AF_XDP_LOG(ERR, "Failed to create rte_ring\n");
999 for (i = 0; i < ETH_AF_XDP_NUM_BUFFERS; i++)
1000 rte_ring_enqueue(umem->buf_ring,
1001 (void *)(i * ETH_AF_XDP_FRAME_SIZE));
1003 snprintf(mz_name, sizeof(mz_name), "af_xdp_umem_%s_%u",
1004 internals->if_name, rxq->xsk_queue_idx);
1005 mz = rte_memzone_reserve_aligned(mz_name,
1006 ETH_AF_XDP_NUM_BUFFERS * ETH_AF_XDP_FRAME_SIZE,
1007 rte_socket_id(), RTE_MEMZONE_IOVA_CONTIG,
1010 AF_XDP_LOG(ERR, "Failed to reserve memzone for af_xdp umem.\n");
1014 ret = xsk_umem__create(&umem->umem, mz->addr,
1015 ETH_AF_XDP_NUM_BUFFERS * ETH_AF_XDP_FRAME_SIZE,
1020 AF_XDP_LOG(ERR, "Failed to create umem");
1029 xdp_umem_destroy(umem);
1034 load_custom_xdp_prog(const char *prog_path, int if_index)
1036 int ret, prog_fd = -1;
1037 struct bpf_object *obj;
1038 struct bpf_map *map;
1040 ret = bpf_prog_load(prog_path, BPF_PROG_TYPE_XDP, &obj, &prog_fd);
1042 AF_XDP_LOG(ERR, "Failed to load program %s\n", prog_path);
1047 * The loaded program must provision for a map of xsks, such that some
1048 * traffic can be redirected to userspace. When the xsk is created,
1049 * libbpf inserts it into the map.
1051 map = bpf_object__find_map_by_name(obj, "xsks_map");
1053 AF_XDP_LOG(ERR, "Failed to find xsks_map in %s\n", prog_path);
1057 /* Link the program with the given network device */
1058 ret = bpf_set_link_xdp_fd(if_index, prog_fd,
1059 XDP_FLAGS_UPDATE_IF_NOEXIST);
1061 AF_XDP_LOG(ERR, "Failed to set prog fd %d on interface\n",
1066 AF_XDP_LOG(INFO, "Successfully loaded XDP program %s with fd %d\n",
1067 prog_path, prog_fd);
1073 xsk_configure(struct pmd_internals *internals, struct pkt_rx_queue *rxq,
1076 struct xsk_socket_config cfg;
1077 struct pkt_tx_queue *txq = rxq->pair;
1079 int reserve_size = ETH_AF_XDP_DFLT_NUM_DESCS;
1080 struct rte_mbuf *fq_bufs[reserve_size];
1082 rxq->umem = xdp_umem_configure(internals, rxq);
1083 if (rxq->umem == NULL)
1085 txq->umem = rxq->umem;
1087 cfg.rx_size = ring_size;
1088 cfg.tx_size = ring_size;
1089 cfg.libbpf_flags = 0;
1090 cfg.xdp_flags = XDP_FLAGS_UPDATE_IF_NOEXIST;
1093 #if defined(XDP_USE_NEED_WAKEUP)
1094 cfg.bind_flags |= XDP_USE_NEED_WAKEUP;
1097 if (strnlen(internals->prog_path, PATH_MAX) &&
1098 !internals->custom_prog_configured) {
1099 ret = load_custom_xdp_prog(internals->prog_path,
1100 internals->if_index);
1102 AF_XDP_LOG(ERR, "Failed to load custom XDP program %s\n",
1103 internals->prog_path);
1106 internals->custom_prog_configured = 1;
1109 if (internals->shared_umem)
1110 ret = create_shared_socket(&rxq->xsk, internals->if_name,
1111 rxq->xsk_queue_idx, rxq->umem->umem, &rxq->rx,
1112 &txq->tx, &rxq->fq, &rxq->cq, &cfg);
1114 ret = xsk_socket__create(&rxq->xsk, internals->if_name,
1115 rxq->xsk_queue_idx, rxq->umem->umem, &rxq->rx,
1119 AF_XDP_LOG(ERR, "Failed to create xsk socket.\n");
1123 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
1124 if (rte_pktmbuf_alloc_bulk(rxq->umem->mb_pool, fq_bufs, reserve_size)) {
1125 AF_XDP_LOG(DEBUG, "Failed to get enough buffers for fq.\n");
1129 ret = reserve_fill_queue(rxq->umem, reserve_size, fq_bufs, &rxq->fq);
1131 xsk_socket__delete(rxq->xsk);
1132 AF_XDP_LOG(ERR, "Failed to reserve fill queue.\n");
1139 if (__atomic_sub_fetch(&rxq->umem->refcnt, 1, __ATOMIC_ACQUIRE) == 0)
1140 xdp_umem_destroy(rxq->umem);
1146 eth_rx_queue_setup(struct rte_eth_dev *dev,
1147 uint16_t rx_queue_id,
1148 uint16_t nb_rx_desc,
1149 unsigned int socket_id __rte_unused,
1150 const struct rte_eth_rxconf *rx_conf __rte_unused,
1151 struct rte_mempool *mb_pool)
1153 struct pmd_internals *internals = dev->data->dev_private;
1154 struct pkt_rx_queue *rxq;
1157 rxq = &internals->rx_queues[rx_queue_id];
1159 AF_XDP_LOG(INFO, "Set up rx queue, rx queue id: %d, xsk queue id: %d\n",
1160 rx_queue_id, rxq->xsk_queue_idx);
1162 #ifndef XDP_UMEM_UNALIGNED_CHUNK_FLAG
1163 uint32_t buf_size, data_size;
1165 /* Now get the space available for data in the mbuf */
1166 buf_size = rte_pktmbuf_data_room_size(mb_pool) -
1167 RTE_PKTMBUF_HEADROOM;
1168 data_size = ETH_AF_XDP_FRAME_SIZE;
1170 if (data_size > buf_size) {
1171 AF_XDP_LOG(ERR, "%s: %d bytes will not fit in mbuf (%d bytes)\n",
1172 dev->device->name, data_size, buf_size);
1178 rxq->mb_pool = mb_pool;
1180 if (xsk_configure(internals, rxq, nb_rx_desc)) {
1181 AF_XDP_LOG(ERR, "Failed to configure xdp socket\n");
1186 rxq->fds[0].fd = xsk_socket__fd(rxq->xsk);
1187 rxq->fds[0].events = POLLIN;
1189 dev->data->rx_queues[rx_queue_id] = rxq;
1197 eth_tx_queue_setup(struct rte_eth_dev *dev,
1198 uint16_t tx_queue_id,
1199 uint16_t nb_tx_desc __rte_unused,
1200 unsigned int socket_id __rte_unused,
1201 const struct rte_eth_txconf *tx_conf __rte_unused)
1203 struct pmd_internals *internals = dev->data->dev_private;
1204 struct pkt_tx_queue *txq;
1206 txq = &internals->tx_queues[tx_queue_id];
1208 dev->data->tx_queues[tx_queue_id] = txq;
1213 eth_dev_mtu_set(struct rte_eth_dev *dev, uint16_t mtu)
1215 struct pmd_internals *internals = dev->data->dev_private;
1216 struct ifreq ifr = { .ifr_mtu = mtu };
1220 s = socket(PF_INET, SOCK_DGRAM, 0);
1224 strlcpy(ifr.ifr_name, internals->if_name, IFNAMSIZ);
1225 ret = ioctl(s, SIOCSIFMTU, &ifr);
1228 return (ret < 0) ? -errno : 0;
1232 eth_dev_change_flags(char *if_name, uint32_t flags, uint32_t mask)
1238 s = socket(PF_INET, SOCK_DGRAM, 0);
1242 strlcpy(ifr.ifr_name, if_name, IFNAMSIZ);
1243 if (ioctl(s, SIOCGIFFLAGS, &ifr) < 0) {
1247 ifr.ifr_flags &= mask;
1248 ifr.ifr_flags |= flags;
1249 if (ioctl(s, SIOCSIFFLAGS, &ifr) < 0) {
1259 eth_dev_promiscuous_enable(struct rte_eth_dev *dev)
1261 struct pmd_internals *internals = dev->data->dev_private;
1263 return eth_dev_change_flags(internals->if_name, IFF_PROMISC, ~0);
1267 eth_dev_promiscuous_disable(struct rte_eth_dev *dev)
1269 struct pmd_internals *internals = dev->data->dev_private;
1271 return eth_dev_change_flags(internals->if_name, 0, ~IFF_PROMISC);
1274 static const struct eth_dev_ops ops = {
1275 .dev_start = eth_dev_start,
1276 .dev_stop = eth_dev_stop,
1277 .dev_close = eth_dev_close,
1278 .dev_configure = eth_dev_configure,
1279 .dev_infos_get = eth_dev_info,
1280 .mtu_set = eth_dev_mtu_set,
1281 .promiscuous_enable = eth_dev_promiscuous_enable,
1282 .promiscuous_disable = eth_dev_promiscuous_disable,
1283 .rx_queue_setup = eth_rx_queue_setup,
1284 .tx_queue_setup = eth_tx_queue_setup,
1285 .rx_queue_release = eth_queue_release,
1286 .tx_queue_release = eth_queue_release,
1287 .link_update = eth_link_update,
1288 .stats_get = eth_stats_get,
1289 .stats_reset = eth_stats_reset,
1292 /** parse integer from integer argument */
1294 parse_integer_arg(const char *key __rte_unused,
1295 const char *value, void *extra_args)
1297 int *i = (int *)extra_args;
1300 *i = strtol(value, &end, 10);
1302 AF_XDP_LOG(ERR, "Argument has to be positive.\n");
1309 /** parse name argument */
1311 parse_name_arg(const char *key __rte_unused,
1312 const char *value, void *extra_args)
1314 char *name = extra_args;
1316 if (strnlen(value, IFNAMSIZ) > IFNAMSIZ - 1) {
1317 AF_XDP_LOG(ERR, "Invalid name %s, should be less than %u bytes.\n",
1322 strlcpy(name, value, IFNAMSIZ);
1327 /** parse xdp prog argument */
1329 parse_prog_arg(const char *key __rte_unused,
1330 const char *value, void *extra_args)
1332 char *path = extra_args;
1334 if (strnlen(value, PATH_MAX) == PATH_MAX) {
1335 AF_XDP_LOG(ERR, "Invalid path %s, should be less than %u bytes.\n",
1340 if (access(value, F_OK) != 0) {
1341 AF_XDP_LOG(ERR, "Error accessing %s: %s\n",
1342 value, strerror(errno));
1346 strlcpy(path, value, PATH_MAX);
1352 xdp_get_channels_info(const char *if_name, int *max_queues,
1353 int *combined_queues)
1355 struct ethtool_channels channels;
1359 fd = socket(AF_INET, SOCK_DGRAM, 0);
1363 channels.cmd = ETHTOOL_GCHANNELS;
1364 ifr.ifr_data = (void *)&channels;
1365 strncpy(ifr.ifr_name, if_name, IFNAMSIZ);
1366 ret = ioctl(fd, SIOCETHTOOL, &ifr);
1368 if (errno == EOPNOTSUPP) {
1376 if (channels.max_combined == 0 || errno == EOPNOTSUPP) {
1377 /* If the device says it has no channels, then all traffic
1378 * is sent to a single stream, so max queues = 1.
1381 *combined_queues = 1;
1383 *max_queues = channels.max_combined;
1384 *combined_queues = channels.combined_count;
1393 parse_parameters(struct rte_kvargs *kvlist, char *if_name, int *start_queue,
1394 int *queue_cnt, int *shared_umem, char *prog_path)
1398 ret = rte_kvargs_process(kvlist, ETH_AF_XDP_IFACE_ARG,
1399 &parse_name_arg, if_name);
1403 ret = rte_kvargs_process(kvlist, ETH_AF_XDP_START_QUEUE_ARG,
1404 &parse_integer_arg, start_queue);
1408 ret = rte_kvargs_process(kvlist, ETH_AF_XDP_QUEUE_COUNT_ARG,
1409 &parse_integer_arg, queue_cnt);
1410 if (ret < 0 || *queue_cnt <= 0) {
1415 ret = rte_kvargs_process(kvlist, ETH_AF_XDP_SHARED_UMEM_ARG,
1416 &parse_integer_arg, shared_umem);
1420 ret = rte_kvargs_process(kvlist, ETH_AF_XDP_PROG_ARG,
1421 &parse_prog_arg, prog_path);
1426 rte_kvargs_free(kvlist);
1431 get_iface_info(const char *if_name,
1432 struct rte_ether_addr *eth_addr,
1436 int sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);
1441 strlcpy(ifr.ifr_name, if_name, IFNAMSIZ);
1442 if (ioctl(sock, SIOCGIFINDEX, &ifr))
1445 *if_index = ifr.ifr_ifindex;
1447 if (ioctl(sock, SIOCGIFHWADDR, &ifr))
1450 rte_memcpy(eth_addr, ifr.ifr_hwaddr.sa_data, RTE_ETHER_ADDR_LEN);
1460 static struct rte_eth_dev *
1461 init_internals(struct rte_vdev_device *dev, const char *if_name,
1462 int start_queue_idx, int queue_cnt, int shared_umem,
1463 const char *prog_path)
1465 const char *name = rte_vdev_device_name(dev);
1466 const unsigned int numa_node = dev->device.numa_node;
1467 struct pmd_internals *internals;
1468 struct rte_eth_dev *eth_dev;
1472 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
1473 if (internals == NULL)
1476 internals->start_queue_idx = start_queue_idx;
1477 internals->queue_cnt = queue_cnt;
1478 strlcpy(internals->if_name, if_name, IFNAMSIZ);
1479 strlcpy(internals->prog_path, prog_path, PATH_MAX);
1480 internals->custom_prog_configured = 0;
1482 #ifndef ETH_AF_XDP_SHARED_UMEM
1484 AF_XDP_LOG(ERR, "Shared UMEM feature not available. "
1485 "Check kernel and libbpf version\n");
1486 goto err_free_internals;
1489 internals->shared_umem = shared_umem;
1491 if (xdp_get_channels_info(if_name, &internals->max_queue_cnt,
1492 &internals->combined_queue_cnt)) {
1493 AF_XDP_LOG(ERR, "Failed to get channel info of interface: %s\n",
1495 goto err_free_internals;
1498 if (queue_cnt > internals->combined_queue_cnt) {
1499 AF_XDP_LOG(ERR, "Specified queue count %d is larger than combined queue count %d.\n",
1500 queue_cnt, internals->combined_queue_cnt);
1501 goto err_free_internals;
1504 internals->rx_queues = rte_zmalloc_socket(NULL,
1505 sizeof(struct pkt_rx_queue) * queue_cnt,
1507 if (internals->rx_queues == NULL) {
1508 AF_XDP_LOG(ERR, "Failed to allocate memory for rx queues.\n");
1509 goto err_free_internals;
1512 internals->tx_queues = rte_zmalloc_socket(NULL,
1513 sizeof(struct pkt_tx_queue) * queue_cnt,
1515 if (internals->tx_queues == NULL) {
1516 AF_XDP_LOG(ERR, "Failed to allocate memory for tx queues.\n");
1519 for (i = 0; i < queue_cnt; i++) {
1520 internals->tx_queues[i].pair = &internals->rx_queues[i];
1521 internals->rx_queues[i].pair = &internals->tx_queues[i];
1522 internals->rx_queues[i].xsk_queue_idx = start_queue_idx + i;
1523 internals->tx_queues[i].xsk_queue_idx = start_queue_idx + i;
1526 ret = get_iface_info(if_name, &internals->eth_addr,
1527 &internals->if_index);
1531 eth_dev = rte_eth_vdev_allocate(dev, 0);
1532 if (eth_dev == NULL)
1535 eth_dev->data->dev_private = internals;
1536 eth_dev->data->dev_link = pmd_link;
1537 eth_dev->data->mac_addrs = &internals->eth_addr;
1538 eth_dev->dev_ops = &ops;
1539 eth_dev->rx_pkt_burst = eth_af_xdp_rx;
1540 eth_dev->tx_pkt_burst = eth_af_xdp_tx;
1542 #if defined(XDP_UMEM_UNALIGNED_CHUNK_FLAG)
1543 AF_XDP_LOG(INFO, "Zero copy between umem and mbuf enabled.\n");
1549 rte_free(internals->tx_queues);
1551 rte_free(internals->rx_queues);
1553 rte_free(internals);
1558 rte_pmd_af_xdp_probe(struct rte_vdev_device *dev)
1560 struct rte_kvargs *kvlist;
1561 char if_name[IFNAMSIZ] = {'\0'};
1562 int xsk_start_queue_idx = ETH_AF_XDP_DFLT_START_QUEUE_IDX;
1563 int xsk_queue_cnt = ETH_AF_XDP_DFLT_QUEUE_COUNT;
1564 int shared_umem = 0;
1565 char prog_path[PATH_MAX] = {'\0'};
1566 struct rte_eth_dev *eth_dev = NULL;
1569 AF_XDP_LOG(INFO, "Initializing pmd_af_xdp for %s\n",
1570 rte_vdev_device_name(dev));
1572 name = rte_vdev_device_name(dev);
1573 if (rte_eal_process_type() == RTE_PROC_SECONDARY &&
1574 strlen(rte_vdev_device_args(dev)) == 0) {
1575 eth_dev = rte_eth_dev_attach_secondary(name);
1576 if (eth_dev == NULL) {
1577 AF_XDP_LOG(ERR, "Failed to probe %s\n", name);
1580 eth_dev->dev_ops = &ops;
1581 rte_eth_dev_probing_finish(eth_dev);
1585 kvlist = rte_kvargs_parse(rte_vdev_device_args(dev), valid_arguments);
1586 if (kvlist == NULL) {
1587 AF_XDP_LOG(ERR, "Invalid kvargs key\n");
1591 if (dev->device.numa_node == SOCKET_ID_ANY)
1592 dev->device.numa_node = rte_socket_id();
1594 if (parse_parameters(kvlist, if_name, &xsk_start_queue_idx,
1595 &xsk_queue_cnt, &shared_umem, prog_path) < 0) {
1596 AF_XDP_LOG(ERR, "Invalid kvargs value\n");
1600 if (strlen(if_name) == 0) {
1601 AF_XDP_LOG(ERR, "Network interface must be specified\n");
1605 eth_dev = init_internals(dev, if_name, xsk_start_queue_idx,
1606 xsk_queue_cnt, shared_umem, prog_path);
1607 if (eth_dev == NULL) {
1608 AF_XDP_LOG(ERR, "Failed to init internals\n");
1612 rte_eth_dev_probing_finish(eth_dev);
1618 rte_pmd_af_xdp_remove(struct rte_vdev_device *dev)
1620 struct rte_eth_dev *eth_dev = NULL;
1622 AF_XDP_LOG(INFO, "Removing AF_XDP ethdev on numa socket %u\n",
1628 /* find the ethdev entry */
1629 eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(dev));
1630 if (eth_dev == NULL)
1633 eth_dev_close(eth_dev);
1634 rte_eth_dev_release_port(eth_dev);
1640 static struct rte_vdev_driver pmd_af_xdp_drv = {
1641 .probe = rte_pmd_af_xdp_probe,
1642 .remove = rte_pmd_af_xdp_remove,
1645 RTE_PMD_REGISTER_VDEV(net_af_xdp, pmd_af_xdp_drv);
1646 RTE_PMD_REGISTER_PARAM_STRING(net_af_xdp,
1648 "start_queue=<int> "
1649 "queue_count=<int> "
1650 "shared_umem=<int> "
1651 "xdp_prog=<string> ");