1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018-2019 Cisco Systems, Inc. All rights reserved.
9 #include <sys/socket.h>
11 #include <sys/ioctl.h>
13 #include <linux/if_ether.h>
15 #include <sys/eventfd.h>
17 #include <rte_version.h>
19 #include <rte_ether.h>
20 #include <rte_ethdev_driver.h>
21 #include <rte_ethdev_vdev.h>
22 #include <rte_malloc.h>
23 #include <rte_kvargs.h>
24 #include <rte_bus_vdev.h>
25 #include <rte_string_fns.h>
27 #include "rte_eth_memif.h"
28 #include "memif_socket.h"
30 #define ETH_MEMIF_ID_ARG "id"
31 #define ETH_MEMIF_ROLE_ARG "role"
32 #define ETH_MEMIF_PKT_BUFFER_SIZE_ARG "bsize"
33 #define ETH_MEMIF_RING_SIZE_ARG "rsize"
34 #define ETH_MEMIF_SOCKET_ARG "socket"
35 #define ETH_MEMIF_MAC_ARG "mac"
36 #define ETH_MEMIF_ZC_ARG "zero-copy"
37 #define ETH_MEMIF_SECRET_ARG "secret"
39 static const char * const valid_arguments[] = {
42 ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
43 ETH_MEMIF_RING_SIZE_ARG,
51 #define MEMIF_MP_SEND_REGION "memif_mp_send_region"
56 return ("memif-" RTE_STR(MEMIF_VERSION_MAJOR) "." RTE_STR(MEMIF_VERSION_MINOR));
59 /* Message header to synchronize regions */
60 struct mp_region_msg {
61 char port_name[RTE_DEV_NAME_MAX_LEN];
62 memif_region_index_t idx;
63 memif_region_size_t size;
67 memif_mp_send_region(const struct rte_mp_msg *msg, const void *peer)
69 struct rte_eth_dev *dev;
70 struct pmd_process_private *proc_private;
71 const struct mp_region_msg *msg_param = (const struct mp_region_msg *)msg->param;
72 struct rte_mp_msg reply;
73 struct mp_region_msg *reply_param = (struct mp_region_msg *)reply.param;
77 /* Get requested port */
78 ret = rte_eth_dev_get_port_by_name(msg_param->port_name, &port_id);
80 MIF_LOG(ERR, "Failed to get port id for %s",
81 msg_param->port_name);
84 dev = &rte_eth_devices[port_id];
85 proc_private = dev->process_private;
87 memset(&reply, 0, sizeof(reply));
88 strlcpy(reply.name, msg->name, sizeof(reply.name));
89 reply_param->idx = msg_param->idx;
90 if (proc_private->regions[msg_param->idx] != NULL) {
91 reply_param->size = proc_private->regions[msg_param->idx]->region_size;
92 reply.fds[0] = proc_private->regions[msg_param->idx]->fd;
95 reply.len_param = sizeof(*reply_param);
96 if (rte_mp_reply(&reply, peer) < 0) {
97 MIF_LOG(ERR, "Failed to reply to an add region request");
106 * Called by secondary process, when ports link status goes up.
109 memif_mp_request_regions(struct rte_eth_dev *dev)
112 struct timespec timeout = {.tv_sec = 5, .tv_nsec = 0};
113 struct rte_mp_msg msg, *reply;
114 struct rte_mp_reply replies;
115 struct mp_region_msg *msg_param = (struct mp_region_msg *)msg.param;
116 struct mp_region_msg *reply_param;
117 struct memif_region *r;
118 struct pmd_process_private *proc_private = dev->process_private;
120 MIF_LOG(DEBUG, "Requesting memory regions");
122 for (i = 0; i < ETH_MEMIF_MAX_REGION_NUM; i++) {
123 /* Prepare the message */
124 memset(&msg, 0, sizeof(msg));
125 strlcpy(msg.name, MEMIF_MP_SEND_REGION, sizeof(msg.name));
126 strlcpy(msg_param->port_name, dev->data->name,
127 sizeof(msg_param->port_name));
129 msg.len_param = sizeof(*msg_param);
132 ret = rte_mp_request_sync(&msg, &replies, &timeout);
133 if (ret < 0 || replies.nb_received != 1) {
134 MIF_LOG(ERR, "Failed to send mp msg: %d",
139 reply = &replies.msgs[0];
140 reply_param = (struct mp_region_msg *)reply->param;
142 if (reply_param->size > 0) {
143 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
145 MIF_LOG(ERR, "Failed to alloc memif region.");
149 r->region_size = reply_param->size;
150 if (reply->num_fds < 1) {
151 MIF_LOG(ERR, "Missing file descriptor.");
155 r->fd = reply->fds[0];
158 proc_private->regions[reply_param->idx] = r;
159 proc_private->regions_num++;
164 return memif_connect(dev);
168 memif_dev_info(struct rte_eth_dev *dev __rte_unused, struct rte_eth_dev_info *dev_info)
170 dev_info->max_mac_addrs = 1;
171 dev_info->max_rx_pktlen = (uint32_t)ETH_FRAME_LEN;
172 dev_info->max_rx_queues = ETH_MEMIF_MAX_NUM_Q_PAIRS;
173 dev_info->max_tx_queues = ETH_MEMIF_MAX_NUM_Q_PAIRS;
174 dev_info->min_rx_bufsize = 0;
177 static memif_ring_t *
178 memif_get_ring(struct pmd_internals *pmd, struct pmd_process_private *proc_private,
179 memif_ring_type_t type, uint16_t ring_num)
181 /* rings only in region 0 */
182 void *p = proc_private->regions[0]->addr;
183 int ring_size = sizeof(memif_ring_t) + sizeof(memif_desc_t) *
184 (1 << pmd->run.log2_ring_size);
186 p = (uint8_t *)p + (ring_num + type * pmd->run.num_s2m_rings) * ring_size;
188 return (memif_ring_t *)p;
191 static memif_region_offset_t
192 memif_get_ring_offset(struct rte_eth_dev *dev, struct memif_queue *mq,
193 memif_ring_type_t type, uint16_t num)
195 struct pmd_internals *pmd = dev->data->dev_private;
196 struct pmd_process_private *proc_private = dev->process_private;
198 return ((uint8_t *)memif_get_ring(pmd, proc_private, type, num) -
199 (uint8_t *)proc_private->regions[mq->region]->addr);
202 static memif_ring_t *
203 memif_get_ring_from_queue(struct pmd_process_private *proc_private,
204 struct memif_queue *mq)
206 struct memif_region *r;
208 r = proc_private->regions[mq->region];
212 return (memif_ring_t *)((uint8_t *)r->addr + mq->ring_offset);
216 memif_get_buffer(struct pmd_process_private *proc_private, memif_desc_t *d)
218 return ((uint8_t *)proc_private->regions[d->region]->addr + d->offset);
222 memif_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *cur_tail,
223 struct rte_mbuf *tail)
225 /* Check for number-of-segments-overflow */
226 if (unlikely(head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS))
229 /* Chain 'tail' onto the old tail */
230 cur_tail->next = tail;
232 /* accumulate number of segments and total length. */
233 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
235 tail->pkt_len = tail->data_len;
236 head->pkt_len += tail->pkt_len;
242 eth_memif_rx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
244 struct memif_queue *mq = queue;
245 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
246 struct pmd_process_private *proc_private =
247 rte_eth_devices[mq->in_port].process_private;
248 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
249 uint16_t cur_slot, last_slot, n_slots, ring_size, mask, s0;
250 uint16_t n_rx_pkts = 0;
251 uint16_t mbuf_size = rte_pktmbuf_data_room_size(mq->mempool) -
252 RTE_PKTMBUF_HEADROOM;
253 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
254 memif_ring_type_t type = mq->type;
256 struct rte_mbuf *mbuf, *mbuf_head, *mbuf_tail;
258 ssize_t size __rte_unused;
261 struct rte_eth_link link;
263 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
265 if (unlikely(ring == NULL)) {
266 /* Secondary process will attempt to request regions. */
267 rte_eth_link_get(mq->in_port, &link);
271 /* consume interrupt */
272 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0)
273 size = read(mq->intr_handle.fd, &b, sizeof(b));
275 ring_size = 1 << mq->log2_ring_size;
276 mask = ring_size - 1;
278 cur_slot = (type == MEMIF_RING_S2M) ? mq->last_head : mq->last_tail;
279 last_slot = (type == MEMIF_RING_S2M) ? ring->head : ring->tail;
280 if (cur_slot == last_slot)
282 n_slots = last_slot - cur_slot;
284 while (n_slots && n_rx_pkts < nb_pkts) {
285 mbuf_head = rte_pktmbuf_alloc(mq->mempool);
286 if (unlikely(mbuf_head == NULL))
289 mbuf->port = mq->in_port;
292 s0 = cur_slot & mask;
293 d0 = &ring->desc[s0];
295 src_len = d0->length;
300 dst_len = mbuf_size - dst_off;
305 /* store pointer to tail */
307 mbuf = rte_pktmbuf_alloc(mq->mempool);
308 if (unlikely(mbuf == NULL))
310 mbuf->port = mq->in_port;
311 ret = memif_pktmbuf_chain(mbuf_head, mbuf_tail, mbuf);
312 if (unlikely(ret < 0)) {
313 MIF_LOG(ERR, "number-of-segments-overflow");
314 rte_pktmbuf_free(mbuf);
318 cp_len = RTE_MIN(dst_len, src_len);
320 rte_pktmbuf_data_len(mbuf) += cp_len;
321 rte_pktmbuf_pkt_len(mbuf) = rte_pktmbuf_data_len(mbuf);
322 if (mbuf != mbuf_head)
323 rte_pktmbuf_pkt_len(mbuf_head) += cp_len;
325 memcpy(rte_pktmbuf_mtod_offset(mbuf, void *, dst_off),
326 (uint8_t *)memif_get_buffer(proc_private, d0) +
337 if (d0->flags & MEMIF_DESC_FLAG_NEXT)
340 mq->n_bytes += rte_pktmbuf_pkt_len(mbuf_head);
346 if (type == MEMIF_RING_S2M) {
348 ring->tail = cur_slot;
349 mq->last_head = cur_slot;
351 mq->last_tail = cur_slot;
355 if (type == MEMIF_RING_M2S) {
357 n_slots = ring_size - head + mq->last_tail;
361 d0 = &ring->desc[s0];
362 d0->length = pmd->run.pkt_buffer_size;
368 mq->n_pkts += n_rx_pkts;
373 eth_memif_tx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
375 struct memif_queue *mq = queue;
376 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
377 struct pmd_process_private *proc_private =
378 rte_eth_devices[mq->in_port].process_private;
379 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
380 uint16_t slot, saved_slot, n_free, ring_size, mask, n_tx_pkts = 0;
381 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
382 memif_ring_type_t type = mq->type;
384 struct rte_mbuf *mbuf;
385 struct rte_mbuf *mbuf_head;
388 struct rte_eth_link link;
390 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
392 if (unlikely(ring == NULL)) {
393 /* Secondary process will attempt to request regions. */
394 rte_eth_link_get(mq->in_port, &link);
398 ring_size = 1 << mq->log2_ring_size;
399 mask = ring_size - 1;
401 n_free = ring->tail - mq->last_tail;
402 mq->last_tail += n_free;
403 slot = (type == MEMIF_RING_S2M) ? ring->head : ring->tail;
405 if (type == MEMIF_RING_S2M)
406 n_free = ring_size - ring->head + mq->last_tail;
408 n_free = ring->head - ring->tail;
410 while (n_tx_pkts < nb_pkts && n_free) {
415 d0 = &ring->desc[slot & mask];
417 dst_len = (type == MEMIF_RING_S2M) ?
418 pmd->run.pkt_buffer_size : d0->length;
422 src_len = rte_pktmbuf_data_len(mbuf);
429 d0->flags |= MEMIF_DESC_FLAG_NEXT;
430 d0 = &ring->desc[slot & mask];
432 dst_len = (type == MEMIF_RING_S2M) ?
433 pmd->run.pkt_buffer_size : d0->length;
440 cp_len = RTE_MIN(dst_len, src_len);
442 memcpy((uint8_t *)memif_get_buffer(proc_private, d0) + dst_off,
443 rte_pktmbuf_mtod_offset(mbuf, void *, src_off),
446 mq->n_bytes += cp_len;
452 d0->length = dst_off;
455 if (rte_pktmbuf_is_contiguous(mbuf) == 0) {
463 rte_pktmbuf_free(mbuf_head);
468 if (type == MEMIF_RING_S2M)
473 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
475 size = write(mq->intr_handle.fd, &a, sizeof(a));
476 if (unlikely(size < 0)) {
478 "Failed to send interrupt. %s", strerror(errno));
482 mq->n_err += nb_pkts - n_tx_pkts;
483 mq->n_pkts += n_tx_pkts;
488 memif_free_regions(struct pmd_process_private *proc_private)
491 struct memif_region *r;
493 MIF_LOG(DEBUG, "Free memory regions");
494 /* regions are allocated contiguously, so it's
495 * enough to loop until 'proc_private->regions_num'
497 for (i = 0; i < proc_private->regions_num; i++) {
498 r = proc_private->regions[i];
500 if (r->addr != NULL) {
501 munmap(r->addr, r->region_size);
508 proc_private->regions[i] = NULL;
511 proc_private->regions_num = 0;
515 memif_region_init_shm(struct rte_eth_dev *dev, uint8_t has_buffers)
517 struct pmd_internals *pmd = dev->data->dev_private;
518 struct pmd_process_private *proc_private = dev->process_private;
519 char shm_name[ETH_MEMIF_SHM_NAME_SIZE];
521 struct memif_region *r;
523 if (proc_private->regions_num >= ETH_MEMIF_MAX_REGION_NUM) {
524 MIF_LOG(ERR, "Too many regions.");
528 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
530 MIF_LOG(ERR, "Failed to alloc memif region.");
534 /* calculate buffer offset */
535 r->pkt_buffer_offset = (pmd->run.num_s2m_rings + pmd->run.num_m2s_rings) *
536 (sizeof(memif_ring_t) + sizeof(memif_desc_t) *
537 (1 << pmd->run.log2_ring_size));
539 r->region_size = r->pkt_buffer_offset;
540 /* if region has buffers, add buffers size to region_size */
541 if (has_buffers == 1)
542 r->region_size += (uint32_t)(pmd->run.pkt_buffer_size *
543 (1 << pmd->run.log2_ring_size) *
544 (pmd->run.num_s2m_rings +
545 pmd->run.num_m2s_rings));
547 memset(shm_name, 0, sizeof(char) * ETH_MEMIF_SHM_NAME_SIZE);
548 snprintf(shm_name, ETH_MEMIF_SHM_NAME_SIZE, "memif_region_%d",
549 proc_private->regions_num);
551 r->fd = memfd_create(shm_name, MFD_ALLOW_SEALING);
553 MIF_LOG(ERR, "Failed to create shm file: %s.", strerror(errno));
558 ret = fcntl(r->fd, F_ADD_SEALS, F_SEAL_SHRINK);
560 MIF_LOG(ERR, "Failed to add seals to shm file: %s.", strerror(errno));
564 ret = ftruncate(r->fd, r->region_size);
566 MIF_LOG(ERR, "Failed to truncate shm file: %s.", strerror(errno));
570 r->addr = mmap(NULL, r->region_size, PROT_READ |
571 PROT_WRITE, MAP_SHARED, r->fd, 0);
572 if (r->addr == MAP_FAILED) {
573 MIF_LOG(ERR, "Failed to mmap shm region: %s.", strerror(ret));
578 proc_private->regions[proc_private->regions_num] = r;
579 proc_private->regions_num++;
592 memif_regions_init(struct rte_eth_dev *dev)
596 /* create one buffer region */
597 ret = memif_region_init_shm(dev, /* has buffer */ 1);
605 memif_init_rings(struct rte_eth_dev *dev)
607 struct pmd_internals *pmd = dev->data->dev_private;
608 struct pmd_process_private *proc_private = dev->process_private;
613 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
614 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_S2M, i);
617 ring->cookie = MEMIF_COOKIE;
619 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
620 slot = i * (1 << pmd->run.log2_ring_size) + j;
621 ring->desc[j].region = 0;
622 ring->desc[j].offset =
623 proc_private->regions[0]->pkt_buffer_offset +
624 (uint32_t)(slot * pmd->run.pkt_buffer_size);
625 ring->desc[j].length = pmd->run.pkt_buffer_size;
629 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
630 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_M2S, i);
633 ring->cookie = MEMIF_COOKIE;
635 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
636 slot = (i + pmd->run.num_s2m_rings) *
637 (1 << pmd->run.log2_ring_size) + j;
638 ring->desc[j].region = 0;
639 ring->desc[j].offset =
640 proc_private->regions[0]->pkt_buffer_offset +
641 (uint32_t)(slot * pmd->run.pkt_buffer_size);
642 ring->desc[j].length = pmd->run.pkt_buffer_size;
647 /* called only by slave */
649 memif_init_queues(struct rte_eth_dev *dev)
651 struct pmd_internals *pmd = dev->data->dev_private;
652 struct memif_queue *mq;
655 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
656 mq = dev->data->tx_queues[i];
657 mq->log2_ring_size = pmd->run.log2_ring_size;
658 /* queues located only in region 0 */
660 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_S2M, i);
663 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
664 if (mq->intr_handle.fd < 0) {
666 "Failed to create eventfd for tx queue %d: %s.", i,
671 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
672 mq = dev->data->rx_queues[i];
673 mq->log2_ring_size = pmd->run.log2_ring_size;
674 /* queues located only in region 0 */
676 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_M2S, i);
679 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
680 if (mq->intr_handle.fd < 0) {
682 "Failed to create eventfd for rx queue %d: %s.", i,
689 memif_init_regions_and_queues(struct rte_eth_dev *dev)
693 ret = memif_regions_init(dev);
697 memif_init_rings(dev);
699 memif_init_queues(dev);
705 memif_connect(struct rte_eth_dev *dev)
707 struct pmd_internals *pmd = dev->data->dev_private;
708 struct pmd_process_private *proc_private = dev->process_private;
709 struct memif_region *mr;
710 struct memif_queue *mq;
714 for (i = 0; i < proc_private->regions_num; i++) {
715 mr = proc_private->regions[i];
717 if (mr->addr == NULL) {
720 mr->addr = mmap(NULL, mr->region_size,
721 PROT_READ | PROT_WRITE,
722 MAP_SHARED, mr->fd, 0);
723 if (mr->addr == NULL)
729 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
730 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
731 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
732 dev->data->tx_queues[i] : dev->data->rx_queues[i];
733 ring = memif_get_ring_from_queue(proc_private, mq);
734 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
735 MIF_LOG(ERR, "Wrong ring");
742 /* enable polling mode */
743 if (pmd->role == MEMIF_ROLE_MASTER)
744 ring->flags = MEMIF_RING_FLAG_MASK_INT;
746 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
747 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
748 dev->data->rx_queues[i] : dev->data->tx_queues[i];
749 ring = memif_get_ring_from_queue(proc_private, mq);
750 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
751 MIF_LOG(ERR, "Wrong ring");
758 /* enable polling mode */
759 if (pmd->role == MEMIF_ROLE_SLAVE)
760 ring->flags = MEMIF_RING_FLAG_MASK_INT;
763 pmd->flags &= ~ETH_MEMIF_FLAG_CONNECTING;
764 pmd->flags |= ETH_MEMIF_FLAG_CONNECTED;
765 dev->data->dev_link.link_status = ETH_LINK_UP;
767 MIF_LOG(INFO, "Connected.");
772 memif_dev_start(struct rte_eth_dev *dev)
774 struct pmd_internals *pmd = dev->data->dev_private;
778 case MEMIF_ROLE_SLAVE:
779 ret = memif_connect_slave(dev);
781 case MEMIF_ROLE_MASTER:
782 ret = memif_connect_master(dev);
785 MIF_LOG(ERR, "%s: Unknown role: %d.",
786 rte_vdev_device_name(pmd->vdev), pmd->role);
795 memif_dev_close(struct rte_eth_dev *dev)
797 struct pmd_internals *pmd = dev->data->dev_private;
800 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
801 memif_msg_enq_disconnect(pmd->cc, "Device closed", 0);
802 memif_disconnect(dev);
804 for (i = 0; i < dev->data->nb_rx_queues; i++)
805 (*dev->dev_ops->rx_queue_release)(dev->data->rx_queues[i]);
806 for (i = 0; i < dev->data->nb_tx_queues; i++)
807 (*dev->dev_ops->tx_queue_release)(dev->data->tx_queues[i]);
809 memif_socket_remove_device(dev);
811 memif_disconnect(dev);
814 rte_free(dev->process_private);
818 memif_dev_configure(struct rte_eth_dev *dev)
820 struct pmd_internals *pmd = dev->data->dev_private;
826 pmd->cfg.num_s2m_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
827 dev->data->nb_tx_queues : dev->data->nb_rx_queues;
833 pmd->cfg.num_m2s_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
834 dev->data->nb_rx_queues : dev->data->nb_tx_queues;
840 memif_tx_queue_setup(struct rte_eth_dev *dev,
842 uint16_t nb_tx_desc __rte_unused,
843 unsigned int socket_id __rte_unused,
844 const struct rte_eth_txconf *tx_conf __rte_unused)
846 struct pmd_internals *pmd = dev->data->dev_private;
847 struct memif_queue *mq;
849 mq = rte_zmalloc("tx-queue", sizeof(struct memif_queue), 0);
851 MIF_LOG(ERR, "%s: Failed to allocate tx queue id: %u",
852 rte_vdev_device_name(pmd->vdev), qid);
857 (pmd->role == MEMIF_ROLE_SLAVE) ? MEMIF_RING_S2M : MEMIF_RING_M2S;
861 mq->intr_handle.fd = -1;
862 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
863 dev->data->tx_queues[qid] = mq;
869 memif_rx_queue_setup(struct rte_eth_dev *dev,
871 uint16_t nb_rx_desc __rte_unused,
872 unsigned int socket_id __rte_unused,
873 const struct rte_eth_rxconf *rx_conf __rte_unused,
874 struct rte_mempool *mb_pool)
876 struct pmd_internals *pmd = dev->data->dev_private;
877 struct memif_queue *mq;
879 mq = rte_zmalloc("rx-queue", sizeof(struct memif_queue), 0);
881 MIF_LOG(ERR, "%s: Failed to allocate rx queue id: %u",
882 rte_vdev_device_name(pmd->vdev), qid);
886 mq->type = (pmd->role == MEMIF_ROLE_SLAVE) ? MEMIF_RING_M2S : MEMIF_RING_S2M;
890 mq->intr_handle.fd = -1;
891 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
892 mq->mempool = mb_pool;
893 mq->in_port = dev->data->port_id;
894 dev->data->rx_queues[qid] = mq;
900 memif_queue_release(void *queue)
902 struct memif_queue *mq = (struct memif_queue *)queue;
911 memif_link_update(struct rte_eth_dev *dev,
912 int wait_to_complete __rte_unused)
914 struct pmd_process_private *proc_private;
916 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
917 proc_private = dev->process_private;
918 if (dev->data->dev_link.link_status == ETH_LINK_UP &&
919 proc_private->regions_num == 0) {
920 memif_mp_request_regions(dev);
921 } else if (dev->data->dev_link.link_status == ETH_LINK_DOWN &&
922 proc_private->regions_num > 0) {
923 memif_free_regions(proc_private);
930 memif_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
932 struct pmd_internals *pmd = dev->data->dev_private;
933 struct memif_queue *mq;
943 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_s2m_rings :
944 pmd->run.num_m2s_rings;
945 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
946 RTE_ETHDEV_QUEUE_STAT_CNTRS;
949 for (i = 0; i < nq; i++) {
950 mq = dev->data->rx_queues[i];
951 stats->q_ipackets[i] = mq->n_pkts;
952 stats->q_ibytes[i] = mq->n_bytes;
953 stats->ipackets += mq->n_pkts;
954 stats->ibytes += mq->n_bytes;
957 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_m2s_rings :
958 pmd->run.num_s2m_rings;
959 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
960 RTE_ETHDEV_QUEUE_STAT_CNTRS;
963 for (i = 0; i < nq; i++) {
964 mq = dev->data->tx_queues[i];
965 stats->q_opackets[i] = mq->n_pkts;
966 stats->q_obytes[i] = mq->n_bytes;
967 stats->opackets += mq->n_pkts;
968 stats->obytes += mq->n_bytes;
969 stats->oerrors += mq->n_err;
975 memif_stats_reset(struct rte_eth_dev *dev)
977 struct pmd_internals *pmd = dev->data->dev_private;
979 struct memif_queue *mq;
981 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
982 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->tx_queues[i] :
983 dev->data->rx_queues[i];
988 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
989 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->rx_queues[i] :
990 dev->data->tx_queues[i];
998 memif_rx_queue_intr_enable(struct rte_eth_dev *dev __rte_unused,
999 uint16_t qid __rte_unused)
1001 MIF_LOG(WARNING, "Interrupt mode not supported.");
1007 memif_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t qid __rte_unused)
1009 struct pmd_internals *pmd __rte_unused = dev->data->dev_private;
1014 static const struct eth_dev_ops ops = {
1015 .dev_start = memif_dev_start,
1016 .dev_close = memif_dev_close,
1017 .dev_infos_get = memif_dev_info,
1018 .dev_configure = memif_dev_configure,
1019 .tx_queue_setup = memif_tx_queue_setup,
1020 .rx_queue_setup = memif_rx_queue_setup,
1021 .rx_queue_release = memif_queue_release,
1022 .tx_queue_release = memif_queue_release,
1023 .rx_queue_intr_enable = memif_rx_queue_intr_enable,
1024 .rx_queue_intr_disable = memif_rx_queue_intr_disable,
1025 .link_update = memif_link_update,
1026 .stats_get = memif_stats_get,
1027 .stats_reset = memif_stats_reset,
1031 memif_create(struct rte_vdev_device *vdev, enum memif_role_t role,
1032 memif_interface_id_t id, uint32_t flags,
1033 const char *socket_filename,
1034 memif_log2_ring_size_t log2_ring_size,
1035 uint16_t pkt_buffer_size, const char *secret,
1036 struct rte_ether_addr *ether_addr)
1039 struct rte_eth_dev *eth_dev;
1040 struct rte_eth_dev_data *data;
1041 struct pmd_internals *pmd;
1042 struct pmd_process_private *process_private;
1043 const unsigned int numa_node = vdev->device.numa_node;
1044 const char *name = rte_vdev_device_name(vdev);
1046 if (flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1047 MIF_LOG(ERR, "Zero-copy slave not supported.");
1051 eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*pmd));
1052 if (eth_dev == NULL) {
1053 MIF_LOG(ERR, "%s: Unable to allocate device struct.", name);
1057 process_private = (struct pmd_process_private *)
1058 rte_zmalloc(name, sizeof(struct pmd_process_private),
1059 RTE_CACHE_LINE_SIZE);
1061 if (process_private == NULL) {
1062 MIF_LOG(ERR, "Failed to alloc memory for process private");
1065 eth_dev->process_private = process_private;
1067 pmd = eth_dev->data->dev_private;
1068 memset(pmd, 0, sizeof(*pmd));
1072 pmd->flags |= ETH_MEMIF_FLAG_DISABLED;
1075 ret = memif_socket_init(eth_dev, socket_filename);
1079 memset(pmd->secret, 0, sizeof(char) * ETH_MEMIF_SECRET_SIZE);
1081 strlcpy(pmd->secret, secret, sizeof(pmd->secret));
1083 pmd->cfg.log2_ring_size = log2_ring_size;
1084 /* set in .dev_configure() */
1085 pmd->cfg.num_s2m_rings = 0;
1086 pmd->cfg.num_m2s_rings = 0;
1088 pmd->cfg.pkt_buffer_size = pkt_buffer_size;
1090 data = eth_dev->data;
1091 data->dev_private = pmd;
1092 data->numa_node = numa_node;
1093 data->mac_addrs = ether_addr;
1095 eth_dev->dev_ops = &ops;
1096 eth_dev->device = &vdev->device;
1097 eth_dev->rx_pkt_burst = eth_memif_rx;
1098 eth_dev->tx_pkt_burst = eth_memif_tx;
1100 eth_dev->data->dev_flags &= RTE_ETH_DEV_CLOSE_REMOVE;
1102 rte_eth_dev_probing_finish(eth_dev);
1108 memif_set_role(const char *key __rte_unused, const char *value,
1111 enum memif_role_t *role = (enum memif_role_t *)extra_args;
1113 if (strstr(value, "master") != NULL) {
1114 *role = MEMIF_ROLE_MASTER;
1115 } else if (strstr(value, "slave") != NULL) {
1116 *role = MEMIF_ROLE_SLAVE;
1118 MIF_LOG(ERR, "Unknown role: %s.", value);
1125 memif_set_zc(const char *key __rte_unused, const char *value, void *extra_args)
1127 uint32_t *flags = (uint32_t *)extra_args;
1129 if (strstr(value, "yes") != NULL) {
1130 *flags |= ETH_MEMIF_FLAG_ZERO_COPY;
1131 } else if (strstr(value, "no") != NULL) {
1132 *flags &= ~ETH_MEMIF_FLAG_ZERO_COPY;
1134 MIF_LOG(ERR, "Failed to parse zero-copy param: %s.", value);
1141 memif_set_id(const char *key __rte_unused, const char *value, void *extra_args)
1143 memif_interface_id_t *id = (memif_interface_id_t *)extra_args;
1145 /* even if parsing fails, 0 is a valid id */
1146 *id = strtoul(value, NULL, 10);
1151 memif_set_bs(const char *key __rte_unused, const char *value, void *extra_args)
1154 uint16_t *pkt_buffer_size = (uint16_t *)extra_args;
1156 tmp = strtoul(value, NULL, 10);
1157 if (tmp == 0 || tmp > 0xFFFF) {
1158 MIF_LOG(ERR, "Invalid buffer size: %s.", value);
1161 *pkt_buffer_size = tmp;
1166 memif_set_rs(const char *key __rte_unused, const char *value, void *extra_args)
1169 memif_log2_ring_size_t *log2_ring_size =
1170 (memif_log2_ring_size_t *)extra_args;
1172 tmp = strtoul(value, NULL, 10);
1173 if (tmp == 0 || tmp > ETH_MEMIF_MAX_LOG2_RING_SIZE) {
1174 MIF_LOG(ERR, "Invalid ring size: %s (max %u).",
1175 value, ETH_MEMIF_MAX_LOG2_RING_SIZE);
1178 *log2_ring_size = tmp;
1182 /* check if directory exists and if we have permission to read/write */
1184 memif_check_socket_filename(const char *filename)
1186 char *dir = NULL, *tmp;
1190 tmp = strrchr(filename, '/');
1192 idx = tmp - filename;
1193 dir = rte_zmalloc("memif_tmp", sizeof(char) * (idx + 1), 0);
1195 MIF_LOG(ERR, "Failed to allocate memory.");
1198 strlcpy(dir, filename, sizeof(char) * (idx + 1));
1201 if (dir == NULL || (faccessat(-1, dir, F_OK | R_OK |
1202 W_OK, AT_EACCESS) < 0)) {
1203 MIF_LOG(ERR, "Invalid socket directory.");
1214 memif_set_socket_filename(const char *key __rte_unused, const char *value,
1217 const char **socket_filename = (const char **)extra_args;
1219 *socket_filename = value;
1220 return memif_check_socket_filename(*socket_filename);
1224 memif_set_mac(const char *key __rte_unused, const char *value, void *extra_args)
1226 struct rte_ether_addr *ether_addr = (struct rte_ether_addr *)extra_args;
1228 if (rte_ether_unformat_addr(value, ether_addr) < 0)
1229 MIF_LOG(WARNING, "Failed to parse mac '%s'.", value);
1234 memif_set_secret(const char *key __rte_unused, const char *value, void *extra_args)
1236 const char **secret = (const char **)extra_args;
1243 rte_pmd_memif_probe(struct rte_vdev_device *vdev)
1245 RTE_BUILD_BUG_ON(sizeof(memif_msg_t) != 128);
1246 RTE_BUILD_BUG_ON(sizeof(memif_desc_t) != 16);
1248 struct rte_kvargs *kvlist;
1249 const char *name = rte_vdev_device_name(vdev);
1250 enum memif_role_t role = MEMIF_ROLE_SLAVE;
1251 memif_interface_id_t id = 0;
1252 uint16_t pkt_buffer_size = ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE;
1253 memif_log2_ring_size_t log2_ring_size = ETH_MEMIF_DEFAULT_RING_SIZE;
1254 const char *socket_filename = ETH_MEMIF_DEFAULT_SOCKET_FILENAME;
1256 const char *secret = NULL;
1257 struct rte_ether_addr *ether_addr = rte_zmalloc("",
1258 sizeof(struct rte_ether_addr), 0);
1259 struct rte_eth_dev *eth_dev;
1261 rte_eth_random_addr(ether_addr->addr_bytes);
1263 MIF_LOG(INFO, "Initialize MEMIF: %s.", name);
1265 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1266 eth_dev = rte_eth_dev_attach_secondary(name);
1268 MIF_LOG(ERR, "Failed to probe %s", name);
1272 eth_dev->dev_ops = &ops;
1273 eth_dev->device = &vdev->device;
1274 eth_dev->rx_pkt_burst = eth_memif_rx;
1275 eth_dev->tx_pkt_burst = eth_memif_rx;
1277 if (!rte_eal_primary_proc_alive(NULL)) {
1278 MIF_LOG(ERR, "Primary process is missing");
1282 eth_dev->process_private = (struct pmd_process_private *)
1284 sizeof(struct pmd_process_private),
1285 RTE_CACHE_LINE_SIZE);
1286 if (eth_dev->process_private == NULL) {
1288 "Failed to alloc memory for process private");
1292 rte_eth_dev_probing_finish(eth_dev);
1297 ret = rte_mp_action_register(MEMIF_MP_SEND_REGION, memif_mp_send_region);
1299 * Primary process can continue probing, but secondary process won't
1300 * be able to get memory regions information
1302 if (ret < 0 && rte_errno != EEXIST)
1303 MIF_LOG(WARNING, "Failed to register mp action callback: %s",
1304 strerror(rte_errno));
1306 kvlist = rte_kvargs_parse(rte_vdev_device_args(vdev), valid_arguments);
1308 /* parse parameters */
1309 if (kvlist != NULL) {
1310 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ROLE_ARG,
1311 &memif_set_role, &role);
1314 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ID_ARG,
1315 &memif_set_id, &id);
1318 ret = rte_kvargs_process(kvlist, ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
1319 &memif_set_bs, &pkt_buffer_size);
1322 ret = rte_kvargs_process(kvlist, ETH_MEMIF_RING_SIZE_ARG,
1323 &memif_set_rs, &log2_ring_size);
1326 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SOCKET_ARG,
1327 &memif_set_socket_filename,
1328 (void *)(&socket_filename));
1331 ret = rte_kvargs_process(kvlist, ETH_MEMIF_MAC_ARG,
1332 &memif_set_mac, ether_addr);
1335 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ZC_ARG,
1336 &memif_set_zc, &flags);
1339 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SECRET_ARG,
1340 &memif_set_secret, (void *)(&secret));
1345 /* create interface */
1346 ret = memif_create(vdev, role, id, flags, socket_filename,
1347 log2_ring_size, pkt_buffer_size, secret, ether_addr);
1351 rte_kvargs_free(kvlist);
1356 rte_pmd_memif_remove(struct rte_vdev_device *vdev)
1358 struct rte_eth_dev *eth_dev;
1360 eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
1361 if (eth_dev == NULL)
1364 rte_eth_dev_close(eth_dev->data->port_id);
1369 static struct rte_vdev_driver pmd_memif_drv = {
1370 .probe = rte_pmd_memif_probe,
1371 .remove = rte_pmd_memif_remove,
1374 RTE_PMD_REGISTER_VDEV(net_memif, pmd_memif_drv);
1376 RTE_PMD_REGISTER_PARAM_STRING(net_memif,
1377 ETH_MEMIF_ID_ARG "=<int>"
1378 ETH_MEMIF_ROLE_ARG "=master|slave"
1379 ETH_MEMIF_PKT_BUFFER_SIZE_ARG "=<int>"
1380 ETH_MEMIF_RING_SIZE_ARG "=<int>"
1381 ETH_MEMIF_SOCKET_ARG "=<string>"
1382 ETH_MEMIF_MAC_ARG "=xx:xx:xx:xx:xx:xx"
1383 ETH_MEMIF_ZC_ARG "=yes|no"
1384 ETH_MEMIF_SECRET_ARG "=<string>");
1388 RTE_INIT(memif_init_log)
1390 memif_logtype = rte_log_register("pmd.net.memif");
1391 if (memif_logtype >= 0)
1392 rte_log_set_level(memif_logtype, RTE_LOG_NOTICE);