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 ret = rte_eth_link_get(mq->in_port, &link);
271 MIF_LOG(ERR, "Failed to get port %u link info: %s",
272 mq->in_port, rte_strerror(-ret));
276 /* consume interrupt */
277 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0)
278 size = read(mq->intr_handle.fd, &b, sizeof(b));
280 ring_size = 1 << mq->log2_ring_size;
281 mask = ring_size - 1;
283 if (type == MEMIF_RING_S2M) {
284 cur_slot = mq->last_head;
285 last_slot = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE);
287 cur_slot = mq->last_tail;
288 last_slot = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
291 if (cur_slot == last_slot)
293 n_slots = last_slot - cur_slot;
295 while (n_slots && n_rx_pkts < nb_pkts) {
296 mbuf_head = rte_pktmbuf_alloc(mq->mempool);
297 if (unlikely(mbuf_head == NULL))
300 mbuf->port = mq->in_port;
303 s0 = cur_slot & mask;
304 d0 = &ring->desc[s0];
306 src_len = d0->length;
311 dst_len = mbuf_size - dst_off;
316 /* store pointer to tail */
318 mbuf = rte_pktmbuf_alloc(mq->mempool);
319 if (unlikely(mbuf == NULL))
321 mbuf->port = mq->in_port;
322 ret = memif_pktmbuf_chain(mbuf_head, mbuf_tail, mbuf);
323 if (unlikely(ret < 0)) {
324 MIF_LOG(ERR, "number-of-segments-overflow");
325 rte_pktmbuf_free(mbuf);
329 cp_len = RTE_MIN(dst_len, src_len);
331 rte_pktmbuf_data_len(mbuf) += cp_len;
332 rte_pktmbuf_pkt_len(mbuf) = rte_pktmbuf_data_len(mbuf);
333 if (mbuf != mbuf_head)
334 rte_pktmbuf_pkt_len(mbuf_head) += cp_len;
336 memcpy(rte_pktmbuf_mtod_offset(mbuf, void *, dst_off),
337 (uint8_t *)memif_get_buffer(proc_private, d0) +
348 if (d0->flags & MEMIF_DESC_FLAG_NEXT)
351 mq->n_bytes += rte_pktmbuf_pkt_len(mbuf_head);
357 if (type == MEMIF_RING_S2M) {
358 __atomic_store_n(&ring->tail, cur_slot, __ATOMIC_RELEASE);
359 mq->last_head = cur_slot;
361 mq->last_tail = cur_slot;
365 if (type == MEMIF_RING_M2S) {
366 head = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE);
367 n_slots = ring_size - head + mq->last_tail;
371 d0 = &ring->desc[s0];
372 d0->length = pmd->run.pkt_buffer_size;
374 __atomic_store_n(&ring->head, head, __ATOMIC_RELEASE);
377 mq->n_pkts += n_rx_pkts;
382 eth_memif_tx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
384 struct memif_queue *mq = queue;
385 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
386 struct pmd_process_private *proc_private =
387 rte_eth_devices[mq->in_port].process_private;
388 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
389 uint16_t slot, saved_slot, n_free, ring_size, mask, n_tx_pkts = 0;
390 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
391 memif_ring_type_t type = mq->type;
393 struct rte_mbuf *mbuf;
394 struct rte_mbuf *mbuf_head;
397 struct rte_eth_link link;
399 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
401 if (unlikely(ring == NULL)) {
404 /* Secondary process will attempt to request regions. */
405 ret = rte_eth_link_get(mq->in_port, &link);
407 MIF_LOG(ERR, "Failed to get port %u link info: %s",
408 mq->in_port, rte_strerror(-ret));
412 ring_size = 1 << mq->log2_ring_size;
413 mask = ring_size - 1;
415 n_free = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE) - mq->last_tail;
416 mq->last_tail += n_free;
418 if (type == MEMIF_RING_S2M) {
419 slot = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE);
420 n_free = ring_size - slot + mq->last_tail;
422 slot = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
423 n_free = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE) - slot;
426 while (n_tx_pkts < nb_pkts && n_free) {
431 d0 = &ring->desc[slot & mask];
433 dst_len = (type == MEMIF_RING_S2M) ?
434 pmd->run.pkt_buffer_size : d0->length;
438 src_len = rte_pktmbuf_data_len(mbuf);
445 d0->flags |= MEMIF_DESC_FLAG_NEXT;
446 d0 = &ring->desc[slot & mask];
448 dst_len = (type == MEMIF_RING_S2M) ?
449 pmd->run.pkt_buffer_size : d0->length;
456 cp_len = RTE_MIN(dst_len, src_len);
458 memcpy((uint8_t *)memif_get_buffer(proc_private, d0) + dst_off,
459 rte_pktmbuf_mtod_offset(mbuf, void *, src_off),
462 mq->n_bytes += cp_len;
468 d0->length = dst_off;
471 if (rte_pktmbuf_is_contiguous(mbuf) == 0) {
479 rte_pktmbuf_free(mbuf_head);
483 if (type == MEMIF_RING_S2M)
484 __atomic_store_n(&ring->head, slot, __ATOMIC_RELEASE);
486 __atomic_store_n(&ring->tail, slot, __ATOMIC_RELEASE);
488 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
490 size = write(mq->intr_handle.fd, &a, sizeof(a));
491 if (unlikely(size < 0)) {
493 "Failed to send interrupt. %s", strerror(errno));
497 mq->n_pkts += n_tx_pkts;
502 memif_free_regions(struct pmd_process_private *proc_private)
505 struct memif_region *r;
507 MIF_LOG(DEBUG, "Free memory regions");
508 /* regions are allocated contiguously, so it's
509 * enough to loop until 'proc_private->regions_num'
511 for (i = 0; i < proc_private->regions_num; i++) {
512 r = proc_private->regions[i];
514 if (r->addr != NULL) {
515 munmap(r->addr, r->region_size);
522 proc_private->regions[i] = NULL;
525 proc_private->regions_num = 0;
529 memif_region_init_shm(struct rte_eth_dev *dev, uint8_t has_buffers)
531 struct pmd_internals *pmd = dev->data->dev_private;
532 struct pmd_process_private *proc_private = dev->process_private;
533 char shm_name[ETH_MEMIF_SHM_NAME_SIZE];
535 struct memif_region *r;
537 if (proc_private->regions_num >= ETH_MEMIF_MAX_REGION_NUM) {
538 MIF_LOG(ERR, "Too many regions.");
542 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
544 MIF_LOG(ERR, "Failed to alloc memif region.");
548 /* calculate buffer offset */
549 r->pkt_buffer_offset = (pmd->run.num_s2m_rings + pmd->run.num_m2s_rings) *
550 (sizeof(memif_ring_t) + sizeof(memif_desc_t) *
551 (1 << pmd->run.log2_ring_size));
553 r->region_size = r->pkt_buffer_offset;
554 /* if region has buffers, add buffers size to region_size */
555 if (has_buffers == 1)
556 r->region_size += (uint32_t)(pmd->run.pkt_buffer_size *
557 (1 << pmd->run.log2_ring_size) *
558 (pmd->run.num_s2m_rings +
559 pmd->run.num_m2s_rings));
561 memset(shm_name, 0, sizeof(char) * ETH_MEMIF_SHM_NAME_SIZE);
562 snprintf(shm_name, ETH_MEMIF_SHM_NAME_SIZE, "memif_region_%d",
563 proc_private->regions_num);
565 r->fd = memfd_create(shm_name, MFD_ALLOW_SEALING);
567 MIF_LOG(ERR, "Failed to create shm file: %s.", strerror(errno));
572 ret = fcntl(r->fd, F_ADD_SEALS, F_SEAL_SHRINK);
574 MIF_LOG(ERR, "Failed to add seals to shm file: %s.", strerror(errno));
578 ret = ftruncate(r->fd, r->region_size);
580 MIF_LOG(ERR, "Failed to truncate shm file: %s.", strerror(errno));
584 r->addr = mmap(NULL, r->region_size, PROT_READ |
585 PROT_WRITE, MAP_SHARED, r->fd, 0);
586 if (r->addr == MAP_FAILED) {
587 MIF_LOG(ERR, "Failed to mmap shm region: %s.", strerror(ret));
592 proc_private->regions[proc_private->regions_num] = r;
593 proc_private->regions_num++;
606 memif_regions_init(struct rte_eth_dev *dev)
610 /* create one buffer region */
611 ret = memif_region_init_shm(dev, /* has buffer */ 1);
619 memif_init_rings(struct rte_eth_dev *dev)
621 struct pmd_internals *pmd = dev->data->dev_private;
622 struct pmd_process_private *proc_private = dev->process_private;
627 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
628 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_S2M, i);
629 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
630 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
631 ring->cookie = MEMIF_COOKIE;
633 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
634 slot = i * (1 << pmd->run.log2_ring_size) + j;
635 ring->desc[j].region = 0;
636 ring->desc[j].offset =
637 proc_private->regions[0]->pkt_buffer_offset +
638 (uint32_t)(slot * pmd->run.pkt_buffer_size);
639 ring->desc[j].length = pmd->run.pkt_buffer_size;
643 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
644 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_M2S, i);
645 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
646 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
647 ring->cookie = MEMIF_COOKIE;
649 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
650 slot = (i + pmd->run.num_s2m_rings) *
651 (1 << pmd->run.log2_ring_size) + j;
652 ring->desc[j].region = 0;
653 ring->desc[j].offset =
654 proc_private->regions[0]->pkt_buffer_offset +
655 (uint32_t)(slot * pmd->run.pkt_buffer_size);
656 ring->desc[j].length = pmd->run.pkt_buffer_size;
661 /* called only by slave */
663 memif_init_queues(struct rte_eth_dev *dev)
665 struct pmd_internals *pmd = dev->data->dev_private;
666 struct memif_queue *mq;
669 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
670 mq = dev->data->tx_queues[i];
671 mq->log2_ring_size = pmd->run.log2_ring_size;
672 /* queues located only in region 0 */
674 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_S2M, i);
677 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
678 if (mq->intr_handle.fd < 0) {
680 "Failed to create eventfd for tx queue %d: %s.", i,
685 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
686 mq = dev->data->rx_queues[i];
687 mq->log2_ring_size = pmd->run.log2_ring_size;
688 /* queues located only in region 0 */
690 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_M2S, i);
693 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
694 if (mq->intr_handle.fd < 0) {
696 "Failed to create eventfd for rx queue %d: %s.", i,
703 memif_init_regions_and_queues(struct rte_eth_dev *dev)
707 ret = memif_regions_init(dev);
711 memif_init_rings(dev);
713 memif_init_queues(dev);
719 memif_connect(struct rte_eth_dev *dev)
721 struct pmd_internals *pmd = dev->data->dev_private;
722 struct pmd_process_private *proc_private = dev->process_private;
723 struct memif_region *mr;
724 struct memif_queue *mq;
728 for (i = 0; i < proc_private->regions_num; i++) {
729 mr = proc_private->regions[i];
731 if (mr->addr == NULL) {
734 mr->addr = mmap(NULL, mr->region_size,
735 PROT_READ | PROT_WRITE,
736 MAP_SHARED, mr->fd, 0);
737 if (mr->addr == NULL)
743 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
744 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
745 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
746 dev->data->tx_queues[i] : dev->data->rx_queues[i];
747 ring = memif_get_ring_from_queue(proc_private, mq);
748 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
749 MIF_LOG(ERR, "Wrong ring");
752 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
753 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
756 /* enable polling mode */
757 if (pmd->role == MEMIF_ROLE_MASTER)
758 ring->flags = MEMIF_RING_FLAG_MASK_INT;
760 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
761 mq = (pmd->role == MEMIF_ROLE_SLAVE) ?
762 dev->data->rx_queues[i] : dev->data->tx_queues[i];
763 ring = memif_get_ring_from_queue(proc_private, mq);
764 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
765 MIF_LOG(ERR, "Wrong ring");
768 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
769 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
772 /* enable polling mode */
773 if (pmd->role == MEMIF_ROLE_SLAVE)
774 ring->flags = MEMIF_RING_FLAG_MASK_INT;
777 pmd->flags &= ~ETH_MEMIF_FLAG_CONNECTING;
778 pmd->flags |= ETH_MEMIF_FLAG_CONNECTED;
779 dev->data->dev_link.link_status = ETH_LINK_UP;
781 MIF_LOG(INFO, "Connected.");
786 memif_dev_start(struct rte_eth_dev *dev)
788 struct pmd_internals *pmd = dev->data->dev_private;
792 case MEMIF_ROLE_SLAVE:
793 ret = memif_connect_slave(dev);
795 case MEMIF_ROLE_MASTER:
796 ret = memif_connect_master(dev);
799 MIF_LOG(ERR, "%s: Unknown role: %d.",
800 rte_vdev_device_name(pmd->vdev), pmd->role);
809 memif_dev_close(struct rte_eth_dev *dev)
811 struct pmd_internals *pmd = dev->data->dev_private;
814 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
815 memif_msg_enq_disconnect(pmd->cc, "Device closed", 0);
816 memif_disconnect(dev);
818 for (i = 0; i < dev->data->nb_rx_queues; i++)
819 (*dev->dev_ops->rx_queue_release)(dev->data->rx_queues[i]);
820 for (i = 0; i < dev->data->nb_tx_queues; i++)
821 (*dev->dev_ops->tx_queue_release)(dev->data->tx_queues[i]);
823 memif_socket_remove_device(dev);
825 memif_disconnect(dev);
828 rte_free(dev->process_private);
832 memif_dev_configure(struct rte_eth_dev *dev)
834 struct pmd_internals *pmd = dev->data->dev_private;
840 pmd->cfg.num_s2m_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
841 dev->data->nb_tx_queues : dev->data->nb_rx_queues;
847 pmd->cfg.num_m2s_rings = (pmd->role == MEMIF_ROLE_SLAVE) ?
848 dev->data->nb_rx_queues : dev->data->nb_tx_queues;
854 memif_tx_queue_setup(struct rte_eth_dev *dev,
856 uint16_t nb_tx_desc __rte_unused,
857 unsigned int socket_id __rte_unused,
858 const struct rte_eth_txconf *tx_conf __rte_unused)
860 struct pmd_internals *pmd = dev->data->dev_private;
861 struct memif_queue *mq;
863 mq = rte_zmalloc("tx-queue", sizeof(struct memif_queue), 0);
865 MIF_LOG(ERR, "%s: Failed to allocate tx queue id: %u",
866 rte_vdev_device_name(pmd->vdev), qid);
871 (pmd->role == MEMIF_ROLE_SLAVE) ? MEMIF_RING_S2M : MEMIF_RING_M2S;
874 mq->intr_handle.fd = -1;
875 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
876 mq->in_port = dev->data->port_id;
877 dev->data->tx_queues[qid] = mq;
883 memif_rx_queue_setup(struct rte_eth_dev *dev,
885 uint16_t nb_rx_desc __rte_unused,
886 unsigned int socket_id __rte_unused,
887 const struct rte_eth_rxconf *rx_conf __rte_unused,
888 struct rte_mempool *mb_pool)
890 struct pmd_internals *pmd = dev->data->dev_private;
891 struct memif_queue *mq;
893 mq = rte_zmalloc("rx-queue", sizeof(struct memif_queue), 0);
895 MIF_LOG(ERR, "%s: Failed to allocate rx queue id: %u",
896 rte_vdev_device_name(pmd->vdev), qid);
900 mq->type = (pmd->role == MEMIF_ROLE_SLAVE) ? MEMIF_RING_M2S : MEMIF_RING_S2M;
903 mq->intr_handle.fd = -1;
904 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
905 mq->mempool = mb_pool;
906 mq->in_port = dev->data->port_id;
907 dev->data->rx_queues[qid] = mq;
913 memif_queue_release(void *queue)
915 struct memif_queue *mq = (struct memif_queue *)queue;
924 memif_link_update(struct rte_eth_dev *dev,
925 int wait_to_complete __rte_unused)
927 struct pmd_process_private *proc_private;
929 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
930 proc_private = dev->process_private;
931 if (dev->data->dev_link.link_status == ETH_LINK_UP &&
932 proc_private->regions_num == 0) {
933 memif_mp_request_regions(dev);
934 } else if (dev->data->dev_link.link_status == ETH_LINK_DOWN &&
935 proc_private->regions_num > 0) {
936 memif_free_regions(proc_private);
943 memif_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
945 struct pmd_internals *pmd = dev->data->dev_private;
946 struct memif_queue *mq;
955 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_s2m_rings :
956 pmd->run.num_m2s_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->rx_queues[i];
963 stats->q_ipackets[i] = mq->n_pkts;
964 stats->q_ibytes[i] = mq->n_bytes;
965 stats->ipackets += mq->n_pkts;
966 stats->ibytes += mq->n_bytes;
969 tmp = (pmd->role == MEMIF_ROLE_SLAVE) ? pmd->run.num_m2s_rings :
970 pmd->run.num_s2m_rings;
971 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
972 RTE_ETHDEV_QUEUE_STAT_CNTRS;
975 for (i = 0; i < nq; i++) {
976 mq = dev->data->tx_queues[i];
977 stats->q_opackets[i] = mq->n_pkts;
978 stats->q_obytes[i] = mq->n_bytes;
979 stats->opackets += mq->n_pkts;
980 stats->obytes += mq->n_bytes;
986 memif_stats_reset(struct rte_eth_dev *dev)
988 struct pmd_internals *pmd = dev->data->dev_private;
990 struct memif_queue *mq;
992 for (i = 0; i < pmd->run.num_s2m_rings; i++) {
993 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->tx_queues[i] :
994 dev->data->rx_queues[i];
998 for (i = 0; i < pmd->run.num_m2s_rings; i++) {
999 mq = (pmd->role == MEMIF_ROLE_SLAVE) ? dev->data->rx_queues[i] :
1000 dev->data->tx_queues[i];
1009 memif_rx_queue_intr_enable(struct rte_eth_dev *dev __rte_unused,
1010 uint16_t qid __rte_unused)
1012 MIF_LOG(WARNING, "Interrupt mode not supported.");
1018 memif_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t qid __rte_unused)
1020 struct pmd_internals *pmd __rte_unused = dev->data->dev_private;
1025 static const struct eth_dev_ops ops = {
1026 .dev_start = memif_dev_start,
1027 .dev_close = memif_dev_close,
1028 .dev_infos_get = memif_dev_info,
1029 .dev_configure = memif_dev_configure,
1030 .tx_queue_setup = memif_tx_queue_setup,
1031 .rx_queue_setup = memif_rx_queue_setup,
1032 .rx_queue_release = memif_queue_release,
1033 .tx_queue_release = memif_queue_release,
1034 .rx_queue_intr_enable = memif_rx_queue_intr_enable,
1035 .rx_queue_intr_disable = memif_rx_queue_intr_disable,
1036 .link_update = memif_link_update,
1037 .stats_get = memif_stats_get,
1038 .stats_reset = memif_stats_reset,
1042 memif_create(struct rte_vdev_device *vdev, enum memif_role_t role,
1043 memif_interface_id_t id, uint32_t flags,
1044 const char *socket_filename,
1045 memif_log2_ring_size_t log2_ring_size,
1046 uint16_t pkt_buffer_size, const char *secret,
1047 struct rte_ether_addr *ether_addr)
1050 struct rte_eth_dev *eth_dev;
1051 struct rte_eth_dev_data *data;
1052 struct pmd_internals *pmd;
1053 struct pmd_process_private *process_private;
1054 const unsigned int numa_node = vdev->device.numa_node;
1055 const char *name = rte_vdev_device_name(vdev);
1057 if (flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1058 MIF_LOG(ERR, "Zero-copy slave not supported.");
1062 eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*pmd));
1063 if (eth_dev == NULL) {
1064 MIF_LOG(ERR, "%s: Unable to allocate device struct.", name);
1068 process_private = (struct pmd_process_private *)
1069 rte_zmalloc(name, sizeof(struct pmd_process_private),
1070 RTE_CACHE_LINE_SIZE);
1072 if (process_private == NULL) {
1073 MIF_LOG(ERR, "Failed to alloc memory for process private");
1076 eth_dev->process_private = process_private;
1078 pmd = eth_dev->data->dev_private;
1079 memset(pmd, 0, sizeof(*pmd));
1083 pmd->flags |= ETH_MEMIF_FLAG_DISABLED;
1086 ret = memif_socket_init(eth_dev, socket_filename);
1090 memset(pmd->secret, 0, sizeof(char) * ETH_MEMIF_SECRET_SIZE);
1092 strlcpy(pmd->secret, secret, sizeof(pmd->secret));
1094 pmd->cfg.log2_ring_size = log2_ring_size;
1095 /* set in .dev_configure() */
1096 pmd->cfg.num_s2m_rings = 0;
1097 pmd->cfg.num_m2s_rings = 0;
1099 pmd->cfg.pkt_buffer_size = pkt_buffer_size;
1101 data = eth_dev->data;
1102 data->dev_private = pmd;
1103 data->numa_node = numa_node;
1104 data->mac_addrs = ether_addr;
1106 eth_dev->dev_ops = &ops;
1107 eth_dev->device = &vdev->device;
1108 eth_dev->rx_pkt_burst = eth_memif_rx;
1109 eth_dev->tx_pkt_burst = eth_memif_tx;
1111 eth_dev->data->dev_flags &= RTE_ETH_DEV_CLOSE_REMOVE;
1113 rte_eth_dev_probing_finish(eth_dev);
1119 memif_set_role(const char *key __rte_unused, const char *value,
1122 enum memif_role_t *role = (enum memif_role_t *)extra_args;
1124 if (strstr(value, "master") != NULL) {
1125 *role = MEMIF_ROLE_MASTER;
1126 } else if (strstr(value, "slave") != NULL) {
1127 *role = MEMIF_ROLE_SLAVE;
1129 MIF_LOG(ERR, "Unknown role: %s.", value);
1136 memif_set_zc(const char *key __rte_unused, const char *value, void *extra_args)
1138 uint32_t *flags = (uint32_t *)extra_args;
1140 if (strstr(value, "yes") != NULL) {
1141 *flags |= ETH_MEMIF_FLAG_ZERO_COPY;
1142 } else if (strstr(value, "no") != NULL) {
1143 *flags &= ~ETH_MEMIF_FLAG_ZERO_COPY;
1145 MIF_LOG(ERR, "Failed to parse zero-copy param: %s.", value);
1152 memif_set_id(const char *key __rte_unused, const char *value, void *extra_args)
1154 memif_interface_id_t *id = (memif_interface_id_t *)extra_args;
1156 /* even if parsing fails, 0 is a valid id */
1157 *id = strtoul(value, NULL, 10);
1162 memif_set_bs(const char *key __rte_unused, const char *value, void *extra_args)
1165 uint16_t *pkt_buffer_size = (uint16_t *)extra_args;
1167 tmp = strtoul(value, NULL, 10);
1168 if (tmp == 0 || tmp > 0xFFFF) {
1169 MIF_LOG(ERR, "Invalid buffer size: %s.", value);
1172 *pkt_buffer_size = tmp;
1177 memif_set_rs(const char *key __rte_unused, const char *value, void *extra_args)
1180 memif_log2_ring_size_t *log2_ring_size =
1181 (memif_log2_ring_size_t *)extra_args;
1183 tmp = strtoul(value, NULL, 10);
1184 if (tmp == 0 || tmp > ETH_MEMIF_MAX_LOG2_RING_SIZE) {
1185 MIF_LOG(ERR, "Invalid ring size: %s (max %u).",
1186 value, ETH_MEMIF_MAX_LOG2_RING_SIZE);
1189 *log2_ring_size = tmp;
1193 /* check if directory exists and if we have permission to read/write */
1195 memif_check_socket_filename(const char *filename)
1197 char *dir = NULL, *tmp;
1201 if (strlen(filename) >= MEMIF_SOCKET_UN_SIZE) {
1202 MIF_LOG(ERR, "Unix socket address too long (max 108).");
1206 tmp = strrchr(filename, '/');
1208 idx = tmp - filename;
1209 dir = rte_zmalloc("memif_tmp", sizeof(char) * (idx + 1), 0);
1211 MIF_LOG(ERR, "Failed to allocate memory.");
1214 strlcpy(dir, filename, sizeof(char) * (idx + 1));
1217 if (dir == NULL || (faccessat(-1, dir, F_OK | R_OK |
1218 W_OK, AT_EACCESS) < 0)) {
1219 MIF_LOG(ERR, "Invalid socket directory.");
1230 memif_set_socket_filename(const char *key __rte_unused, const char *value,
1233 const char **socket_filename = (const char **)extra_args;
1235 *socket_filename = value;
1236 return memif_check_socket_filename(*socket_filename);
1240 memif_set_mac(const char *key __rte_unused, const char *value, void *extra_args)
1242 struct rte_ether_addr *ether_addr = (struct rte_ether_addr *)extra_args;
1244 if (rte_ether_unformat_addr(value, ether_addr) < 0)
1245 MIF_LOG(WARNING, "Failed to parse mac '%s'.", value);
1250 memif_set_secret(const char *key __rte_unused, const char *value, void *extra_args)
1252 const char **secret = (const char **)extra_args;
1259 rte_pmd_memif_probe(struct rte_vdev_device *vdev)
1261 RTE_BUILD_BUG_ON(sizeof(memif_msg_t) != 128);
1262 RTE_BUILD_BUG_ON(sizeof(memif_desc_t) != 16);
1264 struct rte_kvargs *kvlist;
1265 const char *name = rte_vdev_device_name(vdev);
1266 enum memif_role_t role = MEMIF_ROLE_SLAVE;
1267 memif_interface_id_t id = 0;
1268 uint16_t pkt_buffer_size = ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE;
1269 memif_log2_ring_size_t log2_ring_size = ETH_MEMIF_DEFAULT_RING_SIZE;
1270 const char *socket_filename = ETH_MEMIF_DEFAULT_SOCKET_FILENAME;
1272 const char *secret = NULL;
1273 struct rte_ether_addr *ether_addr = rte_zmalloc("",
1274 sizeof(struct rte_ether_addr), 0);
1275 struct rte_eth_dev *eth_dev;
1277 rte_eth_random_addr(ether_addr->addr_bytes);
1279 MIF_LOG(INFO, "Initialize MEMIF: %s.", name);
1281 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1282 eth_dev = rte_eth_dev_attach_secondary(name);
1284 MIF_LOG(ERR, "Failed to probe %s", name);
1288 eth_dev->dev_ops = &ops;
1289 eth_dev->device = &vdev->device;
1290 eth_dev->rx_pkt_burst = eth_memif_rx;
1291 eth_dev->tx_pkt_burst = eth_memif_tx;
1293 if (!rte_eal_primary_proc_alive(NULL)) {
1294 MIF_LOG(ERR, "Primary process is missing");
1298 eth_dev->process_private = (struct pmd_process_private *)
1300 sizeof(struct pmd_process_private),
1301 RTE_CACHE_LINE_SIZE);
1302 if (eth_dev->process_private == NULL) {
1304 "Failed to alloc memory for process private");
1308 rte_eth_dev_probing_finish(eth_dev);
1313 ret = rte_mp_action_register(MEMIF_MP_SEND_REGION, memif_mp_send_region);
1315 * Primary process can continue probing, but secondary process won't
1316 * be able to get memory regions information
1318 if (ret < 0 && rte_errno != EEXIST)
1319 MIF_LOG(WARNING, "Failed to register mp action callback: %s",
1320 strerror(rte_errno));
1322 kvlist = rte_kvargs_parse(rte_vdev_device_args(vdev), valid_arguments);
1324 /* parse parameters */
1325 if (kvlist != NULL) {
1326 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ROLE_ARG,
1327 &memif_set_role, &role);
1330 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ID_ARG,
1331 &memif_set_id, &id);
1334 ret = rte_kvargs_process(kvlist, ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
1335 &memif_set_bs, &pkt_buffer_size);
1338 ret = rte_kvargs_process(kvlist, ETH_MEMIF_RING_SIZE_ARG,
1339 &memif_set_rs, &log2_ring_size);
1342 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SOCKET_ARG,
1343 &memif_set_socket_filename,
1344 (void *)(&socket_filename));
1347 ret = rte_kvargs_process(kvlist, ETH_MEMIF_MAC_ARG,
1348 &memif_set_mac, ether_addr);
1351 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ZC_ARG,
1352 &memif_set_zc, &flags);
1355 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SECRET_ARG,
1356 &memif_set_secret, (void *)(&secret));
1361 /* create interface */
1362 ret = memif_create(vdev, role, id, flags, socket_filename,
1363 log2_ring_size, pkt_buffer_size, secret, ether_addr);
1367 rte_kvargs_free(kvlist);
1372 rte_pmd_memif_remove(struct rte_vdev_device *vdev)
1374 struct rte_eth_dev *eth_dev;
1376 eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
1377 if (eth_dev == NULL)
1380 rte_eth_dev_close(eth_dev->data->port_id);
1385 static struct rte_vdev_driver pmd_memif_drv = {
1386 .probe = rte_pmd_memif_probe,
1387 .remove = rte_pmd_memif_remove,
1390 RTE_PMD_REGISTER_VDEV(net_memif, pmd_memif_drv);
1392 RTE_PMD_REGISTER_PARAM_STRING(net_memif,
1393 ETH_MEMIF_ID_ARG "=<int>"
1394 ETH_MEMIF_ROLE_ARG "=master|slave"
1395 ETH_MEMIF_PKT_BUFFER_SIZE_ARG "=<int>"
1396 ETH_MEMIF_RING_SIZE_ARG "=<int>"
1397 ETH_MEMIF_SOCKET_ARG "=<string>"
1398 ETH_MEMIF_MAC_ARG "=xx:xx:xx:xx:xx:xx"
1399 ETH_MEMIF_ZC_ARG "=yes|no"
1400 ETH_MEMIF_SECRET_ARG "=<string>");
1404 RTE_INIT(memif_init_log)
1406 memif_logtype = rte_log_register("pmd.net.memif");
1407 if (memif_logtype >= 0)
1408 rte_log_set_level(memif_logtype, RTE_LOG_NOTICE);