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;
179 static memif_ring_t *
180 memif_get_ring(struct pmd_internals *pmd, struct pmd_process_private *proc_private,
181 memif_ring_type_t type, uint16_t ring_num)
183 /* rings only in region 0 */
184 void *p = proc_private->regions[0]->addr;
185 int ring_size = sizeof(memif_ring_t) + sizeof(memif_desc_t) *
186 (1 << pmd->run.log2_ring_size);
188 p = (uint8_t *)p + (ring_num + type * pmd->run.num_s2m_rings) * ring_size;
190 return (memif_ring_t *)p;
193 static memif_region_offset_t
194 memif_get_ring_offset(struct rte_eth_dev *dev, struct memif_queue *mq,
195 memif_ring_type_t type, uint16_t num)
197 struct pmd_internals *pmd = dev->data->dev_private;
198 struct pmd_process_private *proc_private = dev->process_private;
200 return ((uint8_t *)memif_get_ring(pmd, proc_private, type, num) -
201 (uint8_t *)proc_private->regions[mq->region]->addr);
204 static memif_ring_t *
205 memif_get_ring_from_queue(struct pmd_process_private *proc_private,
206 struct memif_queue *mq)
208 struct memif_region *r;
210 r = proc_private->regions[mq->region];
214 return (memif_ring_t *)((uint8_t *)r->addr + mq->ring_offset);
218 memif_get_buffer(struct pmd_process_private *proc_private, memif_desc_t *d)
220 return ((uint8_t *)proc_private->regions[d->region]->addr + d->offset);
224 memif_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *cur_tail,
225 struct rte_mbuf *tail)
227 /* Check for number-of-segments-overflow */
228 if (unlikely(head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS))
231 /* Chain 'tail' onto the old tail */
232 cur_tail->next = tail;
234 /* accumulate number of segments and total length. */
235 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
237 tail->pkt_len = tail->data_len;
238 head->pkt_len += tail->pkt_len;
244 eth_memif_rx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
246 struct memif_queue *mq = queue;
247 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
248 struct pmd_process_private *proc_private =
249 rte_eth_devices[mq->in_port].process_private;
250 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
251 uint16_t cur_slot, last_slot, n_slots, ring_size, mask, s0;
252 uint16_t n_rx_pkts = 0;
253 uint16_t mbuf_size = rte_pktmbuf_data_room_size(mq->mempool) -
254 RTE_PKTMBUF_HEADROOM;
255 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
256 memif_ring_type_t type = mq->type;
258 struct rte_mbuf *mbuf, *mbuf_head, *mbuf_tail;
260 ssize_t size __rte_unused;
263 struct rte_eth_link link;
265 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
267 if (unlikely(ring == NULL)) {
268 /* Secondary process will attempt to request regions. */
269 rte_eth_link_get(mq->in_port, &link);
273 /* consume interrupt */
274 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0)
275 size = read(mq->intr_handle.fd, &b, sizeof(b));
277 ring_size = 1 << mq->log2_ring_size;
278 mask = ring_size - 1;
280 cur_slot = (type == MEMIF_RING_S2M) ? mq->last_head : mq->last_tail;
281 last_slot = (type == MEMIF_RING_S2M) ? ring->head : ring->tail;
282 if (cur_slot == last_slot)
284 n_slots = last_slot - cur_slot;
286 while (n_slots && n_rx_pkts < nb_pkts) {
287 mbuf_head = rte_pktmbuf_alloc(mq->mempool);
288 if (unlikely(mbuf_head == NULL))
291 mbuf->port = mq->in_port;
294 s0 = cur_slot & mask;
295 d0 = &ring->desc[s0];
297 src_len = d0->length;
302 dst_len = mbuf_size - dst_off;
307 /* store pointer to tail */
309 mbuf = rte_pktmbuf_alloc(mq->mempool);
310 if (unlikely(mbuf == NULL))
312 mbuf->port = mq->in_port;
313 ret = memif_pktmbuf_chain(mbuf_head, mbuf_tail, mbuf);
314 if (unlikely(ret < 0)) {
315 MIF_LOG(ERR, "number-of-segments-overflow");
316 rte_pktmbuf_free(mbuf);
320 cp_len = RTE_MIN(dst_len, src_len);
322 rte_pktmbuf_data_len(mbuf) += cp_len;
323 rte_pktmbuf_pkt_len(mbuf) = rte_pktmbuf_data_len(mbuf);
324 if (mbuf != mbuf_head)
325 rte_pktmbuf_pkt_len(mbuf_head) += cp_len;
327 memcpy(rte_pktmbuf_mtod_offset(mbuf, void *, dst_off),
328 (uint8_t *)memif_get_buffer(proc_private, d0) +
339 if (d0->flags & MEMIF_DESC_FLAG_NEXT)
342 mq->n_bytes += rte_pktmbuf_pkt_len(mbuf_head);
348 if (type == MEMIF_RING_S2M) {
350 ring->tail = cur_slot;
351 mq->last_head = cur_slot;
353 mq->last_tail = cur_slot;
357 if (type == MEMIF_RING_M2S) {
359 n_slots = ring_size - head + mq->last_tail;
363 d0 = &ring->desc[s0];
364 d0->length = pmd->run.pkt_buffer_size;
370 mq->n_pkts += n_rx_pkts;
375 eth_memif_tx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
377 struct memif_queue *mq = queue;
378 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
379 struct pmd_process_private *proc_private =
380 rte_eth_devices[mq->in_port].process_private;
381 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
382 uint16_t slot, saved_slot, n_free, ring_size, mask, n_tx_pkts = 0;
383 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
384 memif_ring_type_t type = mq->type;
386 struct rte_mbuf *mbuf;
387 struct rte_mbuf *mbuf_head;
390 struct rte_eth_link link;
392 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
394 if (unlikely(ring == NULL)) {
395 /* Secondary process will attempt to request regions. */
396 rte_eth_link_get(mq->in_port, &link);
400 ring_size = 1 << mq->log2_ring_size;
401 mask = ring_size - 1;
403 n_free = ring->tail - mq->last_tail;
404 mq->last_tail += n_free;
405 slot = (type == MEMIF_RING_S2M) ? ring->head : ring->tail;
407 if (type == MEMIF_RING_S2M)
408 n_free = ring_size - ring->head + mq->last_tail;
410 n_free = ring->head - ring->tail;
412 while (n_tx_pkts < nb_pkts && n_free) {
417 d0 = &ring->desc[slot & mask];
419 dst_len = (type == MEMIF_RING_S2M) ?
420 pmd->run.pkt_buffer_size : d0->length;
424 src_len = rte_pktmbuf_data_len(mbuf);
431 d0->flags |= MEMIF_DESC_FLAG_NEXT;
432 d0 = &ring->desc[slot & mask];
434 dst_len = (type == MEMIF_RING_S2M) ?
435 pmd->run.pkt_buffer_size : d0->length;
442 cp_len = RTE_MIN(dst_len, src_len);
444 memcpy((uint8_t *)memif_get_buffer(proc_private, d0) + dst_off,
445 rte_pktmbuf_mtod_offset(mbuf, void *, src_off),
448 mq->n_bytes += cp_len;
454 d0->length = dst_off;
457 if (rte_pktmbuf_is_contiguous(mbuf) == 0) {
465 rte_pktmbuf_free(mbuf_head);
470 if (type == MEMIF_RING_S2M)
475 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
477 size = write(mq->intr_handle.fd, &a, sizeof(a));
478 if (unlikely(size < 0)) {
480 "Failed to send interrupt. %s", strerror(errno));
484 mq->n_pkts += n_tx_pkts;
489 memif_free_regions(struct pmd_process_private *proc_private)
492 struct memif_region *r;
494 MIF_LOG(DEBUG, "Free memory regions");
495 /* regions are allocated contiguously, so it's
496 * enough to loop until 'proc_private->regions_num'
498 for (i = 0; i < proc_private->regions_num; i++) {
499 r = proc_private->regions[i];
501 if (r->addr != NULL) {
502 munmap(r->addr, r->region_size);
509 proc_private->regions[i] = NULL;
512 proc_private->regions_num = 0;
516 memif_region_init_shm(struct rte_eth_dev *dev, uint8_t has_buffers)
518 struct pmd_internals *pmd = dev->data->dev_private;
519 struct pmd_process_private *proc_private = dev->process_private;
520 char shm_name[ETH_MEMIF_SHM_NAME_SIZE];
522 struct memif_region *r;
524 if (proc_private->regions_num >= ETH_MEMIF_MAX_REGION_NUM) {
525 MIF_LOG(ERR, "Too many regions.");
529 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
531 MIF_LOG(ERR, "Failed to alloc memif region.");
535 /* calculate buffer offset */
536 r->pkt_buffer_offset = (pmd->run.num_s2m_rings + pmd->run.num_m2s_rings) *
537 (sizeof(memif_ring_t) + sizeof(memif_desc_t) *
538 (1 << pmd->run.log2_ring_size));
540 r->region_size = r->pkt_buffer_offset;
541 /* if region has buffers, add buffers size to region_size */
542 if (has_buffers == 1)
543 r->region_size += (uint32_t)(pmd->run.pkt_buffer_size *
544 (1 << pmd->run.log2_ring_size) *
545 (pmd->run.num_s2m_rings +
546 pmd->run.num_m2s_rings));
548 memset(shm_name, 0, sizeof(char) * ETH_MEMIF_SHM_NAME_SIZE);
549 snprintf(shm_name, ETH_MEMIF_SHM_NAME_SIZE, "memif_region_%d",
550 proc_private->regions_num);
552 r->fd = memfd_create(shm_name, MFD_ALLOW_SEALING);
554 MIF_LOG(ERR, "Failed to create shm file: %s.", strerror(errno));
559 ret = fcntl(r->fd, F_ADD_SEALS, F_SEAL_SHRINK);
561 MIF_LOG(ERR, "Failed to add seals to shm file: %s.", strerror(errno));
565 ret = ftruncate(r->fd, r->region_size);
567 MIF_LOG(ERR, "Failed to truncate shm file: %s.", strerror(errno));
571 r->addr = mmap(NULL, r->region_size, PROT_READ |
572 PROT_WRITE, MAP_SHARED, r->fd, 0);
573 if (r->addr == MAP_FAILED) {
574 MIF_LOG(ERR, "Failed to mmap shm region: %s.", strerror(ret));
579 proc_private->regions[proc_private->regions_num] = r;
580 proc_private->regions_num++;
593 memif_regions_init(struct rte_eth_dev *dev)
597 /* create one buffer region */
598 ret = memif_region_init_shm(dev, /* has buffer */ 1);
606 memif_init_rings(struct rte_eth_dev *dev)
608 struct pmd_internals *pmd = dev->data->dev_private;
609 struct pmd_process_private *proc_private = dev->process_private;
614 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
615 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_S2M, i);
618 ring->cookie = MEMIF_COOKIE;
620 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
621 slot = i * (1 << pmd->run.log2_ring_size) + j;
622 ring->desc[j].region = 0;
623 ring->desc[j].offset =
624 proc_private->regions[0]->pkt_buffer_offset +
625 (uint32_t)(slot * pmd->run.pkt_buffer_size);
626 ring->desc[j].length = pmd->run.pkt_buffer_size;
630 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
631 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_M2S, i);
634 ring->cookie = MEMIF_COOKIE;
636 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
637 slot = (i + pmd->run.num_s2m_rings) *
638 (1 << pmd->run.log2_ring_size) + j;
639 ring->desc[j].region = 0;
640 ring->desc[j].offset =
641 proc_private->regions[0]->pkt_buffer_offset +
642 (uint32_t)(slot * pmd->run.pkt_buffer_size);
643 ring->desc[j].length = pmd->run.pkt_buffer_size;
648 /* called only by slave */
650 memif_init_queues(struct rte_eth_dev *dev)
652 struct pmd_internals *pmd = dev->data->dev_private;
653 struct memif_queue *mq;
656 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
657 mq = dev->data->tx_queues[i];
658 mq->log2_ring_size = pmd->run.log2_ring_size;
659 /* queues located only in region 0 */
661 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_S2M, i);
664 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
665 if (mq->intr_handle.fd < 0) {
667 "Failed to create eventfd for tx queue %d: %s.", i,
672 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
673 mq = dev->data->rx_queues[i];
674 mq->log2_ring_size = pmd->run.log2_ring_size;
675 /* queues located only in region 0 */
677 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_M2S, i);
680 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
681 if (mq->intr_handle.fd < 0) {
683 "Failed to create eventfd for rx queue %d: %s.", i,
690 memif_init_regions_and_queues(struct rte_eth_dev *dev)
694 ret = memif_regions_init(dev);
698 memif_init_rings(dev);
700 memif_init_queues(dev);
706 memif_connect(struct rte_eth_dev *dev)
708 struct pmd_internals *pmd = dev->data->dev_private;
709 struct pmd_process_private *proc_private = dev->process_private;
710 struct memif_region *mr;
711 struct memif_queue *mq;
715 for (i = 0; i < proc_private->regions_num; i++) {
716 mr = proc_private->regions[i];
718 if (mr->addr == NULL) {
721 mr->addr = mmap(NULL, mr->region_size,
722 PROT_READ | PROT_WRITE,
723 MAP_SHARED, mr->fd, 0);
724 if (mr->addr == NULL)
730 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
731 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
732 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
733 dev->data->tx_queues[i] : dev->data->rx_queues[i];
734 ring = memif_get_ring_from_queue(proc_private, mq);
735 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
736 MIF_LOG(ERR, "Wrong ring");
743 /* enable polling mode */
744 if (pmd->role == MEMIF_ROLE_MASTER)
745 ring->flags = MEMIF_RING_FLAG_MASK_INT;
747 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
748 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
749 dev->data->rx_queues[i] : dev->data->tx_queues[i];
750 ring = memif_get_ring_from_queue(proc_private, mq);
751 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
752 MIF_LOG(ERR, "Wrong ring");
759 /* enable polling mode */
760 if (pmd->role == MEMIF_ROLE_SLAVE)
761 ring->flags = MEMIF_RING_FLAG_MASK_INT;
764 pmd->flags &= ~ETH_MEMIF_FLAG_CONNECTING;
765 pmd->flags |= ETH_MEMIF_FLAG_CONNECTED;
766 dev->data->dev_link.link_status = ETH_LINK_UP;
768 MIF_LOG(INFO, "Connected.");
773 memif_dev_start(struct rte_eth_dev *dev)
775 struct pmd_internals *pmd = dev->data->dev_private;
779 case MEMIF_ROLE_SLAVE:
780 ret = memif_connect_slave(dev);
782 case MEMIF_ROLE_MASTER:
783 ret = memif_connect_master(dev);
786 MIF_LOG(ERR, "%s: Unknown role: %d.",
787 rte_vdev_device_name(pmd->vdev), pmd->role);
796 memif_dev_close(struct rte_eth_dev *dev)
798 struct pmd_internals *pmd = dev->data->dev_private;
801 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
802 memif_msg_enq_disconnect(pmd->cc, "Device closed", 0);
803 memif_disconnect(dev);
805 for (i = 0; i < dev->data->nb_rx_queues; i++)
806 (*dev->dev_ops->rx_queue_release)(dev->data->rx_queues[i]);
807 for (i = 0; i < dev->data->nb_tx_queues; i++)
808 (*dev->dev_ops->tx_queue_release)(dev->data->tx_queues[i]);
810 memif_socket_remove_device(dev);
812 memif_disconnect(dev);
815 rte_free(dev->process_private);
819 memif_dev_configure(struct rte_eth_dev *dev)
821 struct pmd_internals *pmd = dev->data->dev_private;
827 pmd->cfg.num_s2m_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
828 dev->data->nb_tx_queues : dev->data->nb_rx_queues;
834 pmd->cfg.num_m2s_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
835 dev->data->nb_rx_queues : dev->data->nb_tx_queues;
841 memif_tx_queue_setup(struct rte_eth_dev *dev,
843 uint16_t nb_tx_desc __rte_unused,
844 unsigned int socket_id __rte_unused,
845 const struct rte_eth_txconf *tx_conf __rte_unused)
847 struct pmd_internals *pmd = dev->data->dev_private;
848 struct memif_queue *mq;
850 mq = rte_zmalloc("tx-queue", sizeof(struct memif_queue), 0);
852 MIF_LOG(ERR, "%s: Failed to allocate tx queue id: %u",
853 rte_vdev_device_name(pmd->vdev), qid);
858 (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;
889 mq->intr_handle.fd = -1;
890 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
891 mq->mempool = mb_pool;
892 mq->in_port = dev->data->port_id;
893 dev->data->rx_queues[qid] = mq;
899 memif_queue_release(void *queue)
901 struct memif_queue *mq = (struct memif_queue *)queue;
910 memif_link_update(struct rte_eth_dev *dev,
911 int wait_to_complete __rte_unused)
913 struct pmd_process_private *proc_private;
915 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
916 proc_private = dev->process_private;
917 if (dev->data->dev_link.link_status == ETH_LINK_UP &&
918 proc_private->regions_num == 0) {
919 memif_mp_request_regions(dev);
920 } else if (dev->data->dev_link.link_status == ETH_LINK_DOWN &&
921 proc_private->regions_num > 0) {
922 memif_free_regions(proc_private);
929 memif_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
931 struct pmd_internals *pmd = dev->data->dev_private;
932 struct memif_queue *mq;
941 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_s2m_rings :
942 pmd->run.num_m2s_rings;
943 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
944 RTE_ETHDEV_QUEUE_STAT_CNTRS;
947 for (i = 0; i < nq; i++) {
948 mq = dev->data->rx_queues[i];
949 stats->q_ipackets[i] = mq->n_pkts;
950 stats->q_ibytes[i] = mq->n_bytes;
951 stats->ipackets += mq->n_pkts;
952 stats->ibytes += mq->n_bytes;
955 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_m2s_rings :
956 pmd->run.num_s2m_rings;
957 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
958 RTE_ETHDEV_QUEUE_STAT_CNTRS;
961 for (i = 0; i < nq; i++) {
962 mq = dev->data->tx_queues[i];
963 stats->q_opackets[i] = mq->n_pkts;
964 stats->q_obytes[i] = mq->n_bytes;
965 stats->opackets += mq->n_pkts;
966 stats->obytes += mq->n_bytes;
972 memif_stats_reset(struct rte_eth_dev *dev)
974 struct pmd_internals *pmd = dev->data->dev_private;
976 struct memif_queue *mq;
978 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
979 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->tx_queues[i] :
980 dev->data->rx_queues[i];
984 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
985 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->rx_queues[i] :
986 dev->data->tx_queues[i];
993 memif_rx_queue_intr_enable(struct rte_eth_dev *dev __rte_unused,
994 uint16_t qid __rte_unused)
996 MIF_LOG(WARNING, "Interrupt mode not supported.");
1002 memif_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t qid __rte_unused)
1004 struct pmd_internals *pmd __rte_unused = dev->data->dev_private;
1009 static const struct eth_dev_ops ops = {
1010 .dev_start = memif_dev_start,
1011 .dev_close = memif_dev_close,
1012 .dev_infos_get = memif_dev_info,
1013 .dev_configure = memif_dev_configure,
1014 .tx_queue_setup = memif_tx_queue_setup,
1015 .rx_queue_setup = memif_rx_queue_setup,
1016 .rx_queue_release = memif_queue_release,
1017 .tx_queue_release = memif_queue_release,
1018 .rx_queue_intr_enable = memif_rx_queue_intr_enable,
1019 .rx_queue_intr_disable = memif_rx_queue_intr_disable,
1020 .link_update = memif_link_update,
1021 .stats_get = memif_stats_get,
1022 .stats_reset = memif_stats_reset,
1026 memif_create(struct rte_vdev_device *vdev, enum memif_role_t role,
1027 memif_interface_id_t id, uint32_t flags,
1028 const char *socket_filename,
1029 memif_log2_ring_size_t log2_ring_size,
1030 uint16_t pkt_buffer_size, const char *secret,
1031 struct rte_ether_addr *ether_addr)
1034 struct rte_eth_dev *eth_dev;
1035 struct rte_eth_dev_data *data;
1036 struct pmd_internals *pmd;
1037 struct pmd_process_private *process_private;
1038 const unsigned int numa_node = vdev->device.numa_node;
1039 const char *name = rte_vdev_device_name(vdev);
1041 if (flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1042 MIF_LOG(ERR, "Zero-copy slave not supported.");
1046 eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*pmd));
1047 if (eth_dev == NULL) {
1048 MIF_LOG(ERR, "%s: Unable to allocate device struct.", name);
1052 process_private = (struct pmd_process_private *)
1053 rte_zmalloc(name, sizeof(struct pmd_process_private),
1054 RTE_CACHE_LINE_SIZE);
1056 if (process_private == NULL) {
1057 MIF_LOG(ERR, "Failed to alloc memory for process private");
1060 eth_dev->process_private = process_private;
1062 pmd = eth_dev->data->dev_private;
1063 memset(pmd, 0, sizeof(*pmd));
1067 pmd->flags |= ETH_MEMIF_FLAG_DISABLED;
1070 ret = memif_socket_init(eth_dev, socket_filename);
1074 memset(pmd->secret, 0, sizeof(char) * ETH_MEMIF_SECRET_SIZE);
1076 strlcpy(pmd->secret, secret, sizeof(pmd->secret));
1078 pmd->cfg.log2_ring_size = log2_ring_size;
1079 /* set in .dev_configure() */
1080 pmd->cfg.num_s2m_rings = 0;
1081 pmd->cfg.num_m2s_rings = 0;
1083 pmd->cfg.pkt_buffer_size = pkt_buffer_size;
1085 data = eth_dev->data;
1086 data->dev_private = pmd;
1087 data->numa_node = numa_node;
1088 data->mac_addrs = ether_addr;
1090 eth_dev->dev_ops = &ops;
1091 eth_dev->device = &vdev->device;
1092 eth_dev->rx_pkt_burst = eth_memif_rx;
1093 eth_dev->tx_pkt_burst = eth_memif_tx;
1095 eth_dev->data->dev_flags &= RTE_ETH_DEV_CLOSE_REMOVE;
1097 rte_eth_dev_probing_finish(eth_dev);
1103 memif_set_role(const char *key __rte_unused, const char *value,
1106 enum memif_role_t *role = (enum memif_role_t *)extra_args;
1108 if (strstr(value, "master") != NULL) {
1109 *role = MEMIF_ROLE_MASTER;
1110 } else if (strstr(value, "slave") != NULL) {
1111 *role = MEMIF_ROLE_SLAVE;
1113 MIF_LOG(ERR, "Unknown role: %s.", value);
1120 memif_set_zc(const char *key __rte_unused, const char *value, void *extra_args)
1122 uint32_t *flags = (uint32_t *)extra_args;
1124 if (strstr(value, "yes") != NULL) {
1125 *flags |= ETH_MEMIF_FLAG_ZERO_COPY;
1126 } else if (strstr(value, "no") != NULL) {
1127 *flags &= ~ETH_MEMIF_FLAG_ZERO_COPY;
1129 MIF_LOG(ERR, "Failed to parse zero-copy param: %s.", value);
1136 memif_set_id(const char *key __rte_unused, const char *value, void *extra_args)
1138 memif_interface_id_t *id = (memif_interface_id_t *)extra_args;
1140 /* even if parsing fails, 0 is a valid id */
1141 *id = strtoul(value, NULL, 10);
1146 memif_set_bs(const char *key __rte_unused, const char *value, void *extra_args)
1149 uint16_t *pkt_buffer_size = (uint16_t *)extra_args;
1151 tmp = strtoul(value, NULL, 10);
1152 if (tmp == 0 || tmp > 0xFFFF) {
1153 MIF_LOG(ERR, "Invalid buffer size: %s.", value);
1156 *pkt_buffer_size = tmp;
1161 memif_set_rs(const char *key __rte_unused, const char *value, void *extra_args)
1164 memif_log2_ring_size_t *log2_ring_size =
1165 (memif_log2_ring_size_t *)extra_args;
1167 tmp = strtoul(value, NULL, 10);
1168 if (tmp == 0 || tmp > ETH_MEMIF_MAX_LOG2_RING_SIZE) {
1169 MIF_LOG(ERR, "Invalid ring size: %s (max %u).",
1170 value, ETH_MEMIF_MAX_LOG2_RING_SIZE);
1173 *log2_ring_size = tmp;
1177 /* check if directory exists and if we have permission to read/write */
1179 memif_check_socket_filename(const char *filename)
1181 char *dir = NULL, *tmp;
1185 tmp = strrchr(filename, '/');
1187 idx = tmp - filename;
1188 dir = rte_zmalloc("memif_tmp", sizeof(char) * (idx + 1), 0);
1190 MIF_LOG(ERR, "Failed to allocate memory.");
1193 strlcpy(dir, filename, sizeof(char) * (idx + 1));
1196 if (dir == NULL || (faccessat(-1, dir, F_OK | R_OK |
1197 W_OK, AT_EACCESS) < 0)) {
1198 MIF_LOG(ERR, "Invalid socket directory.");
1209 memif_set_socket_filename(const char *key __rte_unused, const char *value,
1212 const char **socket_filename = (const char **)extra_args;
1214 *socket_filename = value;
1215 return memif_check_socket_filename(*socket_filename);
1219 memif_set_mac(const char *key __rte_unused, const char *value, void *extra_args)
1221 struct rte_ether_addr *ether_addr = (struct rte_ether_addr *)extra_args;
1223 if (rte_ether_unformat_addr(value, ether_addr) < 0)
1224 MIF_LOG(WARNING, "Failed to parse mac '%s'.", value);
1229 memif_set_secret(const char *key __rte_unused, const char *value, void *extra_args)
1231 const char **secret = (const char **)extra_args;
1238 rte_pmd_memif_probe(struct rte_vdev_device *vdev)
1240 RTE_BUILD_BUG_ON(sizeof(memif_msg_t) != 128);
1241 RTE_BUILD_BUG_ON(sizeof(memif_desc_t) != 16);
1243 struct rte_kvargs *kvlist;
1244 const char *name = rte_vdev_device_name(vdev);
1245 enum memif_role_t role = MEMIF_ROLE_SLAVE;
1246 memif_interface_id_t id = 0;
1247 uint16_t pkt_buffer_size = ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE;
1248 memif_log2_ring_size_t log2_ring_size = ETH_MEMIF_DEFAULT_RING_SIZE;
1249 const char *socket_filename = ETH_MEMIF_DEFAULT_SOCKET_FILENAME;
1251 const char *secret = NULL;
1252 struct rte_ether_addr *ether_addr = rte_zmalloc("",
1253 sizeof(struct rte_ether_addr), 0);
1254 struct rte_eth_dev *eth_dev;
1256 rte_eth_random_addr(ether_addr->addr_bytes);
1258 MIF_LOG(INFO, "Initialize MEMIF: %s.", name);
1260 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1261 eth_dev = rte_eth_dev_attach_secondary(name);
1263 MIF_LOG(ERR, "Failed to probe %s", name);
1267 eth_dev->dev_ops = &ops;
1268 eth_dev->device = &vdev->device;
1269 eth_dev->rx_pkt_burst = eth_memif_rx;
1270 eth_dev->tx_pkt_burst = eth_memif_tx;
1272 if (!rte_eal_primary_proc_alive(NULL)) {
1273 MIF_LOG(ERR, "Primary process is missing");
1277 eth_dev->process_private = (struct pmd_process_private *)
1279 sizeof(struct pmd_process_private),
1280 RTE_CACHE_LINE_SIZE);
1281 if (eth_dev->process_private == NULL) {
1283 "Failed to alloc memory for process private");
1287 rte_eth_dev_probing_finish(eth_dev);
1292 ret = rte_mp_action_register(MEMIF_MP_SEND_REGION, memif_mp_send_region);
1294 * Primary process can continue probing, but secondary process won't
1295 * be able to get memory regions information
1297 if (ret < 0 && rte_errno != EEXIST)
1298 MIF_LOG(WARNING, "Failed to register mp action callback: %s",
1299 strerror(rte_errno));
1301 kvlist = rte_kvargs_parse(rte_vdev_device_args(vdev), valid_arguments);
1303 /* parse parameters */
1304 if (kvlist != NULL) {
1305 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ROLE_ARG,
1306 &memif_set_role, &role);
1309 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ID_ARG,
1310 &memif_set_id, &id);
1313 ret = rte_kvargs_process(kvlist, ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
1314 &memif_set_bs, &pkt_buffer_size);
1317 ret = rte_kvargs_process(kvlist, ETH_MEMIF_RING_SIZE_ARG,
1318 &memif_set_rs, &log2_ring_size);
1321 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SOCKET_ARG,
1322 &memif_set_socket_filename,
1323 (void *)(&socket_filename));
1326 ret = rte_kvargs_process(kvlist, ETH_MEMIF_MAC_ARG,
1327 &memif_set_mac, ether_addr);
1330 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ZC_ARG,
1331 &memif_set_zc, &flags);
1334 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SECRET_ARG,
1335 &memif_set_secret, (void *)(&secret));
1340 /* create interface */
1341 ret = memif_create(vdev, role, id, flags, socket_filename,
1342 log2_ring_size, pkt_buffer_size, secret, ether_addr);
1346 rte_kvargs_free(kvlist);
1351 rte_pmd_memif_remove(struct rte_vdev_device *vdev)
1353 struct rte_eth_dev *eth_dev;
1355 eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
1356 if (eth_dev == NULL)
1359 rte_eth_dev_close(eth_dev->data->port_id);
1364 static struct rte_vdev_driver pmd_memif_drv = {
1365 .probe = rte_pmd_memif_probe,
1366 .remove = rte_pmd_memif_remove,
1369 RTE_PMD_REGISTER_VDEV(net_memif, pmd_memif_drv);
1371 RTE_PMD_REGISTER_PARAM_STRING(net_memif,
1372 ETH_MEMIF_ID_ARG "=<int>"
1373 ETH_MEMIF_ROLE_ARG "=master|slave"
1374 ETH_MEMIF_PKT_BUFFER_SIZE_ARG "=<int>"
1375 ETH_MEMIF_RING_SIZE_ARG "=<int>"
1376 ETH_MEMIF_SOCKET_ARG "=<string>"
1377 ETH_MEMIF_MAC_ARG "=xx:xx:xx:xx:xx:xx"
1378 ETH_MEMIF_ZC_ARG "=yes|no"
1379 ETH_MEMIF_SECRET_ARG "=<string>");
1383 RTE_INIT(memif_init_log)
1385 memif_logtype = rte_log_register("pmd.net.memif");
1386 if (memif_logtype >= 0)
1387 rte_log_set_level(memif_logtype, RTE_LOG_NOTICE);