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>
26 #include <rte_errno.h>
27 #include <rte_memory.h>
28 #include <rte_memzone.h>
29 #include <rte_eal_memconfig.h>
31 #include "rte_eth_memif.h"
32 #include "memif_socket.h"
34 #define ETH_MEMIF_ID_ARG "id"
35 #define ETH_MEMIF_ROLE_ARG "role"
36 #define ETH_MEMIF_PKT_BUFFER_SIZE_ARG "bsize"
37 #define ETH_MEMIF_RING_SIZE_ARG "rsize"
38 #define ETH_MEMIF_SOCKET_ARG "socket"
39 #define ETH_MEMIF_SOCKET_ABSTRACT_ARG "socket-abstract"
40 #define ETH_MEMIF_MAC_ARG "mac"
41 #define ETH_MEMIF_ZC_ARG "zero-copy"
42 #define ETH_MEMIF_SECRET_ARG "secret"
44 static const char * const valid_arguments[] = {
47 ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
48 ETH_MEMIF_RING_SIZE_ARG,
50 ETH_MEMIF_SOCKET_ABSTRACT_ARG,
57 static const struct rte_eth_link pmd_link = {
58 .link_speed = ETH_SPEED_NUM_10G,
59 .link_duplex = ETH_LINK_FULL_DUPLEX,
60 .link_status = ETH_LINK_DOWN,
61 .link_autoneg = ETH_LINK_AUTONEG
64 #define MEMIF_MP_SEND_REGION "memif_mp_send_region"
67 static int memif_region_init_zc(const struct rte_memseg_list *msl,
68 const struct rte_memseg *ms, void *arg);
73 return ("memif-" RTE_STR(MEMIF_VERSION_MAJOR) "." RTE_STR(MEMIF_VERSION_MINOR));
76 /* Message header to synchronize regions */
77 struct mp_region_msg {
78 char port_name[RTE_DEV_NAME_MAX_LEN];
79 memif_region_index_t idx;
80 memif_region_size_t size;
84 memif_mp_send_region(const struct rte_mp_msg *msg, const void *peer)
86 struct rte_eth_dev *dev;
87 struct pmd_process_private *proc_private;
88 const struct mp_region_msg *msg_param = (const struct mp_region_msg *)msg->param;
89 struct rte_mp_msg reply;
90 struct mp_region_msg *reply_param = (struct mp_region_msg *)reply.param;
94 /* Get requested port */
95 ret = rte_eth_dev_get_port_by_name(msg_param->port_name, &port_id);
97 MIF_LOG(ERR, "Failed to get port id for %s",
98 msg_param->port_name);
101 dev = &rte_eth_devices[port_id];
102 proc_private = dev->process_private;
104 memset(&reply, 0, sizeof(reply));
105 strlcpy(reply.name, msg->name, sizeof(reply.name));
106 reply_param->idx = msg_param->idx;
107 if (proc_private->regions[msg_param->idx] != NULL) {
108 reply_param->size = proc_private->regions[msg_param->idx]->region_size;
109 reply.fds[0] = proc_private->regions[msg_param->idx]->fd;
112 reply.len_param = sizeof(*reply_param);
113 if (rte_mp_reply(&reply, peer) < 0) {
114 MIF_LOG(ERR, "Failed to reply to an add region request");
123 * Called by secondary process, when ports link status goes up.
126 memif_mp_request_regions(struct rte_eth_dev *dev)
129 struct timespec timeout = {.tv_sec = 5, .tv_nsec = 0};
130 struct rte_mp_msg msg, *reply;
131 struct rte_mp_reply replies;
132 struct mp_region_msg *msg_param = (struct mp_region_msg *)msg.param;
133 struct mp_region_msg *reply_param;
134 struct memif_region *r;
135 struct pmd_process_private *proc_private = dev->process_private;
136 struct pmd_internals *pmd = dev->data->dev_private;
137 /* in case of zero-copy client, only request region 0 */
138 uint16_t max_region_num = (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) ?
139 1 : ETH_MEMIF_MAX_REGION_NUM;
141 MIF_LOG(DEBUG, "Requesting memory regions");
143 for (i = 0; i < max_region_num; i++) {
144 /* Prepare the message */
145 memset(&msg, 0, sizeof(msg));
146 strlcpy(msg.name, MEMIF_MP_SEND_REGION, sizeof(msg.name));
147 strlcpy(msg_param->port_name, dev->data->name,
148 sizeof(msg_param->port_name));
150 msg.len_param = sizeof(*msg_param);
153 ret = rte_mp_request_sync(&msg, &replies, &timeout);
154 if (ret < 0 || replies.nb_received != 1) {
155 MIF_LOG(ERR, "Failed to send mp msg: %d",
160 reply = &replies.msgs[0];
161 reply_param = (struct mp_region_msg *)reply->param;
163 if (reply_param->size > 0) {
164 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
166 MIF_LOG(ERR, "Failed to alloc memif region.");
170 r->region_size = reply_param->size;
171 if (reply->num_fds < 1) {
172 MIF_LOG(ERR, "Missing file descriptor.");
176 r->fd = reply->fds[0];
179 proc_private->regions[reply_param->idx] = r;
180 proc_private->regions_num++;
185 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) {
186 ret = rte_memseg_walk(memif_region_init_zc, (void *)proc_private);
191 return memif_connect(dev);
195 memif_dev_info(struct rte_eth_dev *dev __rte_unused, struct rte_eth_dev_info *dev_info)
197 dev_info->max_mac_addrs = 1;
198 dev_info->max_rx_pktlen = (uint32_t)ETH_FRAME_LEN;
199 dev_info->max_rx_queues = ETH_MEMIF_MAX_NUM_Q_PAIRS;
200 dev_info->max_tx_queues = ETH_MEMIF_MAX_NUM_Q_PAIRS;
201 dev_info->min_rx_bufsize = 0;
206 static memif_ring_t *
207 memif_get_ring(struct pmd_internals *pmd, struct pmd_process_private *proc_private,
208 memif_ring_type_t type, uint16_t ring_num)
210 /* rings only in region 0 */
211 void *p = proc_private->regions[0]->addr;
212 int ring_size = sizeof(memif_ring_t) + sizeof(memif_desc_t) *
213 (1 << pmd->run.log2_ring_size);
215 p = (uint8_t *)p + (ring_num + type * pmd->run.num_c2s_rings) * ring_size;
217 return (memif_ring_t *)p;
220 static memif_region_offset_t
221 memif_get_ring_offset(struct rte_eth_dev *dev, struct memif_queue *mq,
222 memif_ring_type_t type, uint16_t num)
224 struct pmd_internals *pmd = dev->data->dev_private;
225 struct pmd_process_private *proc_private = dev->process_private;
227 return ((uint8_t *)memif_get_ring(pmd, proc_private, type, num) -
228 (uint8_t *)proc_private->regions[mq->region]->addr);
231 static memif_ring_t *
232 memif_get_ring_from_queue(struct pmd_process_private *proc_private,
233 struct memif_queue *mq)
235 struct memif_region *r;
237 r = proc_private->regions[mq->region];
241 return (memif_ring_t *)((uint8_t *)r->addr + mq->ring_offset);
245 memif_get_buffer(struct pmd_process_private *proc_private, memif_desc_t *d)
247 return ((uint8_t *)proc_private->regions[d->region]->addr + d->offset);
250 /* Free mbufs received by server */
252 memif_free_stored_mbufs(struct pmd_process_private *proc_private, struct memif_queue *mq)
255 uint16_t mask = (1 << mq->log2_ring_size) - 1;
256 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
258 /* FIXME: improve performance */
259 /* The ring->tail acts as a guard variable between Tx and Rx
260 * threads, so using load-acquire pairs with store-release
261 * in function eth_memif_rx for C2S queues.
263 cur_tail = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
264 while (mq->last_tail != cur_tail) {
265 RTE_MBUF_PREFETCH_TO_FREE(mq->buffers[(mq->last_tail + 1) & mask]);
266 /* Decrement refcnt and free mbuf. (current segment) */
267 rte_mbuf_refcnt_update(mq->buffers[mq->last_tail & mask], -1);
268 rte_pktmbuf_free_seg(mq->buffers[mq->last_tail & mask]);
274 memif_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *cur_tail,
275 struct rte_mbuf *tail)
277 /* Check for number-of-segments-overflow */
278 if (unlikely(head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS))
281 /* Chain 'tail' onto the old tail */
282 cur_tail->next = tail;
284 /* accumulate number of segments and total length. */
285 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
287 tail->pkt_len = tail->data_len;
288 head->pkt_len += tail->pkt_len;
294 eth_memif_rx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
296 struct memif_queue *mq = queue;
297 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
298 struct pmd_process_private *proc_private =
299 rte_eth_devices[mq->in_port].process_private;
300 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
301 uint16_t cur_slot, last_slot, n_slots, ring_size, mask, s0;
302 uint16_t n_rx_pkts = 0;
303 uint16_t mbuf_size = rte_pktmbuf_data_room_size(mq->mempool) -
304 RTE_PKTMBUF_HEADROOM;
305 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
306 memif_ring_type_t type = mq->type;
308 struct rte_mbuf *mbuf, *mbuf_head, *mbuf_tail;
310 ssize_t size __rte_unused;
313 struct rte_eth_link link;
315 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
317 if (unlikely(ring == NULL)) {
318 /* Secondary process will attempt to request regions. */
319 ret = rte_eth_link_get(mq->in_port, &link);
321 MIF_LOG(ERR, "Failed to get port %u link info: %s",
322 mq->in_port, rte_strerror(-ret));
326 /* consume interrupt */
327 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0)
328 size = read(mq->intr_handle.fd, &b, sizeof(b));
330 ring_size = 1 << mq->log2_ring_size;
331 mask = ring_size - 1;
333 if (type == MEMIF_RING_C2S) {
334 cur_slot = mq->last_head;
335 last_slot = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE);
337 cur_slot = mq->last_tail;
338 last_slot = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
341 if (cur_slot == last_slot)
343 n_slots = last_slot - cur_slot;
345 while (n_slots && n_rx_pkts < nb_pkts) {
346 mbuf_head = rte_pktmbuf_alloc(mq->mempool);
347 if (unlikely(mbuf_head == NULL))
350 mbuf->port = mq->in_port;
353 s0 = cur_slot & mask;
354 d0 = &ring->desc[s0];
356 src_len = d0->length;
361 dst_len = mbuf_size - dst_off;
366 /* store pointer to tail */
368 mbuf = rte_pktmbuf_alloc(mq->mempool);
369 if (unlikely(mbuf == NULL))
371 mbuf->port = mq->in_port;
372 ret = memif_pktmbuf_chain(mbuf_head, mbuf_tail, mbuf);
373 if (unlikely(ret < 0)) {
374 MIF_LOG(ERR, "number-of-segments-overflow");
375 rte_pktmbuf_free(mbuf);
379 cp_len = RTE_MIN(dst_len, src_len);
381 rte_pktmbuf_data_len(mbuf) += cp_len;
382 rte_pktmbuf_pkt_len(mbuf) = rte_pktmbuf_data_len(mbuf);
383 if (mbuf != mbuf_head)
384 rte_pktmbuf_pkt_len(mbuf_head) += cp_len;
386 memcpy(rte_pktmbuf_mtod_offset(mbuf, void *, dst_off),
387 (uint8_t *)memif_get_buffer(proc_private, d0) + src_off,
398 if (d0->flags & MEMIF_DESC_FLAG_NEXT)
401 mq->n_bytes += rte_pktmbuf_pkt_len(mbuf_head);
407 if (type == MEMIF_RING_C2S) {
408 __atomic_store_n(&ring->tail, cur_slot, __ATOMIC_RELEASE);
409 mq->last_head = cur_slot;
411 mq->last_tail = cur_slot;
415 if (type == MEMIF_RING_S2C) {
416 /* ring->head is updated by the receiver and this function
417 * is called in the context of receiver thread. The loads in
418 * the receiver do not need to synchronize with its own stores.
420 head = __atomic_load_n(&ring->head, __ATOMIC_RELAXED);
421 n_slots = ring_size - head + mq->last_tail;
425 d0 = &ring->desc[s0];
426 d0->length = pmd->run.pkt_buffer_size;
428 __atomic_store_n(&ring->head, head, __ATOMIC_RELEASE);
431 mq->n_pkts += n_rx_pkts;
436 eth_memif_rx_zc(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
438 struct memif_queue *mq = queue;
439 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
440 struct pmd_process_private *proc_private =
441 rte_eth_devices[mq->in_port].process_private;
442 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
443 uint16_t cur_slot, last_slot, n_slots, ring_size, mask, s0, head;
444 uint16_t n_rx_pkts = 0;
446 struct rte_mbuf *mbuf, *mbuf_tail;
447 struct rte_mbuf *mbuf_head = NULL;
449 struct rte_eth_link link;
451 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
453 if (unlikely(ring == NULL)) {
454 /* Secondary process will attempt to request regions. */
455 rte_eth_link_get(mq->in_port, &link);
459 /* consume interrupt */
460 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
462 ssize_t size __rte_unused;
463 size = read(mq->intr_handle.fd, &b, sizeof(b));
466 ring_size = 1 << mq->log2_ring_size;
467 mask = ring_size - 1;
469 cur_slot = mq->last_tail;
470 /* The ring->tail acts as a guard variable between Tx and Rx
471 * threads, so using load-acquire pairs with store-release
472 * to synchronize it between threads.
474 last_slot = __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
475 if (cur_slot == last_slot)
477 n_slots = last_slot - cur_slot;
479 while (n_slots && n_rx_pkts < nb_pkts) {
480 s0 = cur_slot & mask;
482 d0 = &ring->desc[s0];
483 mbuf_head = mq->buffers[s0];
487 /* prefetch next descriptor */
488 if (n_rx_pkts + 1 < nb_pkts)
489 rte_prefetch0(&ring->desc[(cur_slot + 1) & mask]);
491 mbuf->port = mq->in_port;
492 rte_pktmbuf_data_len(mbuf) = d0->length;
493 rte_pktmbuf_pkt_len(mbuf) = rte_pktmbuf_data_len(mbuf);
495 mq->n_bytes += rte_pktmbuf_data_len(mbuf);
499 if (d0->flags & MEMIF_DESC_FLAG_NEXT) {
500 s0 = cur_slot & mask;
501 d0 = &ring->desc[s0];
503 mbuf = mq->buffers[s0];
504 ret = memif_pktmbuf_chain(mbuf_head, mbuf_tail, mbuf);
505 if (unlikely(ret < 0)) {
506 MIF_LOG(ERR, "number-of-segments-overflow");
516 mq->last_tail = cur_slot;
518 /* Supply server with new buffers */
520 /* ring->head is updated by the receiver and this function
521 * is called in the context of receiver thread. The loads in
522 * the receiver do not need to synchronize with its own stores.
524 head = __atomic_load_n(&ring->head, __ATOMIC_RELAXED);
525 n_slots = ring_size - head + mq->last_tail;
530 ret = rte_pktmbuf_alloc_bulk(mq->mempool, &mq->buffers[head & mask], n_slots);
531 if (unlikely(ret < 0))
537 rte_prefetch0(mq->buffers[head & mask]);
538 d0 = &ring->desc[s0];
539 /* store buffer header */
540 mbuf = mq->buffers[s0];
541 /* populate descriptor */
542 d0->length = rte_pktmbuf_data_room_size(mq->mempool) -
543 RTE_PKTMBUF_HEADROOM;
545 d0->offset = rte_pktmbuf_mtod(mbuf, uint8_t *) -
546 (uint8_t *)proc_private->regions[d0->region]->addr;
549 /* The ring->head acts as a guard variable between Tx and Rx
550 * threads, so using store-release pairs with load-acquire
551 * in function eth_memif_tx.
553 __atomic_store_n(&ring->head, head, __ATOMIC_RELEASE);
555 mq->n_pkts += n_rx_pkts;
561 eth_memif_tx(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
563 struct memif_queue *mq = queue;
564 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
565 struct pmd_process_private *proc_private =
566 rte_eth_devices[mq->in_port].process_private;
567 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
568 uint16_t slot, saved_slot, n_free, ring_size, mask, n_tx_pkts = 0;
569 uint16_t src_len, src_off, dst_len, dst_off, cp_len;
570 memif_ring_type_t type = mq->type;
572 struct rte_mbuf *mbuf;
573 struct rte_mbuf *mbuf_head;
576 struct rte_eth_link link;
578 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
580 if (unlikely(ring == NULL)) {
583 /* Secondary process will attempt to request regions. */
584 ret = rte_eth_link_get(mq->in_port, &link);
586 MIF_LOG(ERR, "Failed to get port %u link info: %s",
587 mq->in_port, rte_strerror(-ret));
591 ring_size = 1 << mq->log2_ring_size;
592 mask = ring_size - 1;
594 if (type == MEMIF_RING_C2S) {
595 /* For C2S queues ring->head is updated by the sender and
596 * this function is called in the context of sending thread.
597 * The loads in the sender do not need to synchronize with
598 * its own stores. Hence, the following load can be a
601 slot = __atomic_load_n(&ring->head, __ATOMIC_RELAXED);
602 n_free = ring_size - slot +
603 __atomic_load_n(&ring->tail, __ATOMIC_ACQUIRE);
605 /* For S2C queues ring->tail is updated by the sender and
606 * this function is called in the context of sending thread.
607 * The loads in the sender do not need to synchronize with
608 * its own stores. Hence, the following load can be a
611 slot = __atomic_load_n(&ring->tail, __ATOMIC_RELAXED);
612 n_free = __atomic_load_n(&ring->head, __ATOMIC_ACQUIRE) - slot;
615 while (n_tx_pkts < nb_pkts && n_free) {
620 d0 = &ring->desc[slot & mask];
622 dst_len = (type == MEMIF_RING_C2S) ?
623 pmd->run.pkt_buffer_size : d0->length;
627 src_len = rte_pktmbuf_data_len(mbuf);
634 d0->flags |= MEMIF_DESC_FLAG_NEXT;
635 d0 = &ring->desc[slot & mask];
637 dst_len = (type == MEMIF_RING_C2S) ?
638 pmd->run.pkt_buffer_size : d0->length;
645 cp_len = RTE_MIN(dst_len, src_len);
647 memcpy((uint8_t *)memif_get_buffer(proc_private, d0) + dst_off,
648 rte_pktmbuf_mtod_offset(mbuf, void *, src_off),
651 mq->n_bytes += cp_len;
657 d0->length = dst_off;
660 if (rte_pktmbuf_is_contiguous(mbuf) == 0) {
668 rte_pktmbuf_free(mbuf_head);
672 if (type == MEMIF_RING_C2S)
673 __atomic_store_n(&ring->head, slot, __ATOMIC_RELEASE);
675 __atomic_store_n(&ring->tail, slot, __ATOMIC_RELEASE);
677 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
679 size = write(mq->intr_handle.fd, &a, sizeof(a));
680 if (unlikely(size < 0)) {
682 "Failed to send interrupt. %s", strerror(errno));
686 mq->n_pkts += n_tx_pkts;
692 memif_tx_one_zc(struct pmd_process_private *proc_private, struct memif_queue *mq,
693 memif_ring_t *ring, struct rte_mbuf *mbuf, const uint16_t mask,
694 uint16_t slot, uint16_t n_free)
700 /* store pointer to mbuf to free it later */
701 mq->buffers[slot & mask] = mbuf;
702 /* Increment refcnt to make sure the buffer is not freed before server
703 * receives it. (current segment)
705 rte_mbuf_refcnt_update(mbuf, 1);
706 /* populate descriptor */
707 d0 = &ring->desc[slot & mask];
708 d0->length = rte_pktmbuf_data_len(mbuf);
709 /* FIXME: get region index */
711 d0->offset = rte_pktmbuf_mtod(mbuf, uint8_t *) -
712 (uint8_t *)proc_private->regions[d0->region]->addr;
715 /* check if buffer is chained */
716 if (rte_pktmbuf_is_contiguous(mbuf) == 0) {
719 /* mark buffer as chained */
720 d0->flags |= MEMIF_DESC_FLAG_NEXT;
723 /* update counters */
733 eth_memif_tx_zc(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
735 struct memif_queue *mq = queue;
736 struct pmd_internals *pmd = rte_eth_devices[mq->in_port].data->dev_private;
737 struct pmd_process_private *proc_private =
738 rte_eth_devices[mq->in_port].process_private;
739 memif_ring_t *ring = memif_get_ring_from_queue(proc_private, mq);
740 uint16_t slot, n_free, ring_size, mask, n_tx_pkts = 0;
741 struct rte_eth_link link;
743 if (unlikely((pmd->flags & ETH_MEMIF_FLAG_CONNECTED) == 0))
745 if (unlikely(ring == NULL)) {
746 /* Secondary process will attempt to request regions. */
747 rte_eth_link_get(mq->in_port, &link);
751 ring_size = 1 << mq->log2_ring_size;
752 mask = ring_size - 1;
754 /* free mbufs received by server */
755 memif_free_stored_mbufs(proc_private, mq);
757 /* ring type always MEMIF_RING_C2S */
758 /* For C2S queues ring->head is updated by the sender and
759 * this function is called in the context of sending thread.
760 * The loads in the sender do not need to synchronize with
761 * its own stores. Hence, the following load can be a
764 slot = __atomic_load_n(&ring->head, __ATOMIC_RELAXED);
765 n_free = ring_size - slot + mq->last_tail;
769 while (n_free && (n_tx_pkts < nb_pkts)) {
770 while ((n_free > 4) && ((nb_pkts - n_tx_pkts) > 4)) {
771 if ((nb_pkts - n_tx_pkts) > 8) {
772 rte_prefetch0(*bufs + 4);
773 rte_prefetch0(*bufs + 5);
774 rte_prefetch0(*bufs + 6);
775 rte_prefetch0(*bufs + 7);
777 used_slots = memif_tx_one_zc(proc_private, mq, ring, *bufs++,
779 if (unlikely(used_slots < 1))
783 n_free -= used_slots;
785 used_slots = memif_tx_one_zc(proc_private, mq, ring, *bufs++,
787 if (unlikely(used_slots < 1))
791 n_free -= used_slots;
793 used_slots = memif_tx_one_zc(proc_private, mq, ring, *bufs++,
795 if (unlikely(used_slots < 1))
799 n_free -= used_slots;
801 used_slots = memif_tx_one_zc(proc_private, mq, ring, *bufs++,
803 if (unlikely(used_slots < 1))
807 n_free -= used_slots;
809 used_slots = memif_tx_one_zc(proc_private, mq, ring, *bufs++,
811 if (unlikely(used_slots < 1))
815 n_free -= used_slots;
819 /* ring type always MEMIF_RING_C2S */
820 /* The ring->head acts as a guard variable between Tx and Rx
821 * threads, so using store-release pairs with load-acquire
822 * in function eth_memif_rx for C2S rings.
824 __atomic_store_n(&ring->head, slot, __ATOMIC_RELEASE);
826 /* Send interrupt, if enabled. */
827 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0) {
829 ssize_t size = write(mq->intr_handle.fd, &a, sizeof(a));
830 if (unlikely(size < 0)) {
832 "Failed to send interrupt. %s", strerror(errno));
836 /* increment queue counters */
837 mq->n_pkts += n_tx_pkts;
843 memif_free_regions(struct rte_eth_dev *dev)
845 struct pmd_process_private *proc_private = dev->process_private;
846 struct pmd_internals *pmd = dev->data->dev_private;
848 struct memif_region *r;
850 /* regions are allocated contiguously, so it's
851 * enough to loop until 'proc_private->regions_num'
853 for (i = 0; i < proc_private->regions_num; i++) {
854 r = proc_private->regions[i];
856 /* This is memzone */
857 if (i > 0 && (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY)) {
862 if (r->addr != NULL) {
863 munmap(r->addr, r->region_size);
870 proc_private->regions[i] = NULL;
873 proc_private->regions_num = 0;
877 memif_region_init_zc(const struct rte_memseg_list *msl, const struct rte_memseg *ms,
880 struct pmd_process_private *proc_private = (struct pmd_process_private *)arg;
881 struct memif_region *r;
883 if (proc_private->regions_num < 1) {
884 MIF_LOG(ERR, "Missing descriptor region");
888 r = proc_private->regions[proc_private->regions_num - 1];
890 if (r->addr != msl->base_va)
891 r = proc_private->regions[++proc_private->regions_num - 1];
894 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
896 MIF_LOG(ERR, "Failed to alloc memif region.");
900 r->addr = msl->base_va;
901 r->region_size = ms->len;
902 r->fd = rte_memseg_get_fd(ms);
905 r->pkt_buffer_offset = 0;
907 proc_private->regions[proc_private->regions_num - 1] = r;
909 r->region_size += ms->len;
916 memif_region_init_shm(struct rte_eth_dev *dev, uint8_t has_buffers)
918 struct pmd_internals *pmd = dev->data->dev_private;
919 struct pmd_process_private *proc_private = dev->process_private;
920 char shm_name[ETH_MEMIF_SHM_NAME_SIZE];
922 struct memif_region *r;
924 if (proc_private->regions_num >= ETH_MEMIF_MAX_REGION_NUM) {
925 MIF_LOG(ERR, "Too many regions.");
929 r = rte_zmalloc("region", sizeof(struct memif_region), 0);
931 MIF_LOG(ERR, "Failed to alloc memif region.");
935 /* calculate buffer offset */
936 r->pkt_buffer_offset = (pmd->run.num_c2s_rings + pmd->run.num_s2c_rings) *
937 (sizeof(memif_ring_t) + sizeof(memif_desc_t) *
938 (1 << pmd->run.log2_ring_size));
940 r->region_size = r->pkt_buffer_offset;
941 /* if region has buffers, add buffers size to region_size */
942 if (has_buffers == 1)
943 r->region_size += (uint32_t)(pmd->run.pkt_buffer_size *
944 (1 << pmd->run.log2_ring_size) *
945 (pmd->run.num_c2s_rings +
946 pmd->run.num_s2c_rings));
948 memset(shm_name, 0, sizeof(char) * ETH_MEMIF_SHM_NAME_SIZE);
949 snprintf(shm_name, ETH_MEMIF_SHM_NAME_SIZE, "memif_region_%d",
950 proc_private->regions_num);
952 r->fd = memfd_create(shm_name, MFD_ALLOW_SEALING);
954 MIF_LOG(ERR, "Failed to create shm file: %s.", strerror(errno));
959 ret = fcntl(r->fd, F_ADD_SEALS, F_SEAL_SHRINK);
961 MIF_LOG(ERR, "Failed to add seals to shm file: %s.", strerror(errno));
965 ret = ftruncate(r->fd, r->region_size);
967 MIF_LOG(ERR, "Failed to truncate shm file: %s.", strerror(errno));
971 r->addr = mmap(NULL, r->region_size, PROT_READ |
972 PROT_WRITE, MAP_SHARED, r->fd, 0);
973 if (r->addr == MAP_FAILED) {
974 MIF_LOG(ERR, "Failed to mmap shm region: %s.", strerror(ret));
979 proc_private->regions[proc_private->regions_num] = r;
980 proc_private->regions_num++;
993 memif_regions_init(struct rte_eth_dev *dev)
995 struct pmd_internals *pmd = dev->data->dev_private;
999 * Zero-copy exposes dpdk memory.
1000 * Each memseg list will be represented by memif region.
1001 * Zero-copy regions indexing: memseg list idx + 1,
1002 * as we already have region 0 reserved for descriptors.
1004 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1005 /* create region idx 0 containing descriptors */
1006 ret = memif_region_init_shm(dev, 0);
1009 ret = rte_memseg_walk(memif_region_init_zc, (void *)dev->process_private);
1013 /* create one memory region contaning rings and buffers */
1014 ret = memif_region_init_shm(dev, /* has buffers */ 1);
1023 memif_init_rings(struct rte_eth_dev *dev)
1025 struct pmd_internals *pmd = dev->data->dev_private;
1026 struct pmd_process_private *proc_private = dev->process_private;
1031 for (i = 0; i < pmd->run.num_c2s_rings; i++) {
1032 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_C2S, i);
1033 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
1034 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
1035 ring->cookie = MEMIF_COOKIE;
1038 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY)
1041 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
1042 slot = i * (1 << pmd->run.log2_ring_size) + j;
1043 ring->desc[j].region = 0;
1044 ring->desc[j].offset =
1045 proc_private->regions[0]->pkt_buffer_offset +
1046 (uint32_t)(slot * pmd->run.pkt_buffer_size);
1047 ring->desc[j].length = pmd->run.pkt_buffer_size;
1051 for (i = 0; i < pmd->run.num_s2c_rings; i++) {
1052 ring = memif_get_ring(pmd, proc_private, MEMIF_RING_S2C, i);
1053 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
1054 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
1055 ring->cookie = MEMIF_COOKIE;
1058 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY)
1061 for (j = 0; j < (1 << pmd->run.log2_ring_size); j++) {
1062 slot = (i + pmd->run.num_c2s_rings) *
1063 (1 << pmd->run.log2_ring_size) + j;
1064 ring->desc[j].region = 0;
1065 ring->desc[j].offset =
1066 proc_private->regions[0]->pkt_buffer_offset +
1067 (uint32_t)(slot * pmd->run.pkt_buffer_size);
1068 ring->desc[j].length = pmd->run.pkt_buffer_size;
1073 /* called only by client */
1075 memif_init_queues(struct rte_eth_dev *dev)
1077 struct pmd_internals *pmd = dev->data->dev_private;
1078 struct memif_queue *mq;
1081 for (i = 0; i < pmd->run.num_c2s_rings; i++) {
1082 mq = dev->data->tx_queues[i];
1083 mq->log2_ring_size = pmd->run.log2_ring_size;
1084 /* queues located only in region 0 */
1086 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_C2S, i);
1089 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
1090 if (mq->intr_handle.fd < 0) {
1092 "Failed to create eventfd for tx queue %d: %s.", i,
1096 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1097 mq->buffers = rte_zmalloc("bufs", sizeof(struct rte_mbuf *) *
1098 (1 << mq->log2_ring_size), 0);
1099 if (mq->buffers == NULL)
1104 for (i = 0; i < pmd->run.num_s2c_rings; i++) {
1105 mq = dev->data->rx_queues[i];
1106 mq->log2_ring_size = pmd->run.log2_ring_size;
1107 /* queues located only in region 0 */
1109 mq->ring_offset = memif_get_ring_offset(dev, mq, MEMIF_RING_S2C, i);
1112 mq->intr_handle.fd = eventfd(0, EFD_NONBLOCK);
1113 if (mq->intr_handle.fd < 0) {
1115 "Failed to create eventfd for rx queue %d: %s.", i,
1119 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1120 mq->buffers = rte_zmalloc("bufs", sizeof(struct rte_mbuf *) *
1121 (1 << mq->log2_ring_size), 0);
1122 if (mq->buffers == NULL)
1130 memif_init_regions_and_queues(struct rte_eth_dev *dev)
1134 ret = memif_regions_init(dev);
1138 memif_init_rings(dev);
1140 ret = memif_init_queues(dev);
1148 memif_connect(struct rte_eth_dev *dev)
1150 struct pmd_internals *pmd = dev->data->dev_private;
1151 struct pmd_process_private *proc_private = dev->process_private;
1152 struct memif_region *mr;
1153 struct memif_queue *mq;
1157 for (i = 0; i < proc_private->regions_num; i++) {
1158 mr = proc_private->regions[i];
1160 if (mr->addr == NULL) {
1163 mr->addr = mmap(NULL, mr->region_size,
1164 PROT_READ | PROT_WRITE,
1165 MAP_SHARED, mr->fd, 0);
1166 if (mr->addr == MAP_FAILED) {
1167 MIF_LOG(ERR, "mmap failed: %s\n",
1172 if (i > 0 && (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY)) {
1173 /* close memseg file */
1180 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
1181 for (i = 0; i < pmd->run.num_c2s_rings; i++) {
1182 mq = (pmd->role == MEMIF_ROLE_CLIENT) ?
1183 dev->data->tx_queues[i] : dev->data->rx_queues[i];
1184 ring = memif_get_ring_from_queue(proc_private, mq);
1185 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
1186 MIF_LOG(ERR, "Wrong ring");
1189 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
1190 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
1193 /* enable polling mode */
1194 if (pmd->role == MEMIF_ROLE_SERVER)
1195 ring->flags = MEMIF_RING_FLAG_MASK_INT;
1197 for (i = 0; i < pmd->run.num_s2c_rings; i++) {
1198 mq = (pmd->role == MEMIF_ROLE_CLIENT) ?
1199 dev->data->rx_queues[i] : dev->data->tx_queues[i];
1200 ring = memif_get_ring_from_queue(proc_private, mq);
1201 if (ring == NULL || ring->cookie != MEMIF_COOKIE) {
1202 MIF_LOG(ERR, "Wrong ring");
1205 __atomic_store_n(&ring->head, 0, __ATOMIC_RELAXED);
1206 __atomic_store_n(&ring->tail, 0, __ATOMIC_RELAXED);
1209 /* enable polling mode */
1210 if (pmd->role == MEMIF_ROLE_CLIENT)
1211 ring->flags = MEMIF_RING_FLAG_MASK_INT;
1214 pmd->flags &= ~ETH_MEMIF_FLAG_CONNECTING;
1215 pmd->flags |= ETH_MEMIF_FLAG_CONNECTED;
1216 dev->data->dev_link.link_status = ETH_LINK_UP;
1218 MIF_LOG(INFO, "Connected.");
1223 memif_dev_start(struct rte_eth_dev *dev)
1225 struct pmd_internals *pmd = dev->data->dev_private;
1228 switch (pmd->role) {
1229 case MEMIF_ROLE_CLIENT:
1230 ret = memif_connect_client(dev);
1232 case MEMIF_ROLE_SERVER:
1233 ret = memif_connect_server(dev);
1236 MIF_LOG(ERR, "Unknown role: %d.", pmd->role);
1245 memif_dev_close(struct rte_eth_dev *dev)
1247 struct pmd_internals *pmd = dev->data->dev_private;
1250 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
1251 memif_msg_enq_disconnect(pmd->cc, "Device closed", 0);
1252 memif_disconnect(dev);
1254 for (i = 0; i < dev->data->nb_rx_queues; i++)
1255 (*dev->dev_ops->rx_queue_release)(dev->data->rx_queues[i]);
1256 for (i = 0; i < dev->data->nb_tx_queues; i++)
1257 (*dev->dev_ops->tx_queue_release)(dev->data->tx_queues[i]);
1259 memif_socket_remove_device(dev);
1261 memif_disconnect(dev);
1264 rte_free(dev->process_private);
1270 memif_dev_configure(struct rte_eth_dev *dev)
1272 struct pmd_internals *pmd = dev->data->dev_private;
1278 pmd->cfg.num_c2s_rings = (pmd->role == MEMIF_ROLE_CLIENT) ?
1279 dev->data->nb_tx_queues : dev->data->nb_rx_queues;
1285 pmd->cfg.num_s2c_rings = (pmd->role == MEMIF_ROLE_CLIENT) ?
1286 dev->data->nb_rx_queues : dev->data->nb_tx_queues;
1292 memif_tx_queue_setup(struct rte_eth_dev *dev,
1294 uint16_t nb_tx_desc __rte_unused,
1295 unsigned int socket_id __rte_unused,
1296 const struct rte_eth_txconf *tx_conf __rte_unused)
1298 struct pmd_internals *pmd = dev->data->dev_private;
1299 struct memif_queue *mq;
1301 mq = rte_zmalloc("tx-queue", sizeof(struct memif_queue), 0);
1303 MIF_LOG(ERR, "Failed to allocate tx queue id: %u", qid);
1308 (pmd->role == MEMIF_ROLE_CLIENT) ? MEMIF_RING_C2S : MEMIF_RING_S2C;
1311 mq->intr_handle.fd = -1;
1312 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
1313 mq->in_port = dev->data->port_id;
1314 dev->data->tx_queues[qid] = mq;
1320 memif_rx_queue_setup(struct rte_eth_dev *dev,
1322 uint16_t nb_rx_desc __rte_unused,
1323 unsigned int socket_id __rte_unused,
1324 const struct rte_eth_rxconf *rx_conf __rte_unused,
1325 struct rte_mempool *mb_pool)
1327 struct pmd_internals *pmd = dev->data->dev_private;
1328 struct memif_queue *mq;
1330 mq = rte_zmalloc("rx-queue", sizeof(struct memif_queue), 0);
1332 MIF_LOG(ERR, "Failed to allocate rx queue id: %u", qid);
1336 mq->type = (pmd->role == MEMIF_ROLE_CLIENT) ? MEMIF_RING_S2C : MEMIF_RING_C2S;
1339 mq->intr_handle.fd = -1;
1340 mq->intr_handle.type = RTE_INTR_HANDLE_EXT;
1341 mq->mempool = mb_pool;
1342 mq->in_port = dev->data->port_id;
1343 dev->data->rx_queues[qid] = mq;
1349 memif_queue_release(void *queue)
1351 struct memif_queue *mq = (struct memif_queue *)queue;
1360 memif_link_update(struct rte_eth_dev *dev,
1361 int wait_to_complete __rte_unused)
1363 struct pmd_process_private *proc_private;
1365 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1366 proc_private = dev->process_private;
1367 if (dev->data->dev_link.link_status == ETH_LINK_UP &&
1368 proc_private->regions_num == 0) {
1369 memif_mp_request_regions(dev);
1370 } else if (dev->data->dev_link.link_status == ETH_LINK_DOWN &&
1371 proc_private->regions_num > 0) {
1372 memif_free_regions(dev);
1379 memif_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
1381 struct pmd_internals *pmd = dev->data->dev_private;
1382 struct memif_queue *mq;
1386 stats->ipackets = 0;
1388 stats->opackets = 0;
1391 tmp = (pmd->role == MEMIF_ROLE_CLIENT) ? pmd->run.num_c2s_rings :
1392 pmd->run.num_s2c_rings;
1393 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
1394 RTE_ETHDEV_QUEUE_STAT_CNTRS;
1397 for (i = 0; i < nq; i++) {
1398 mq = dev->data->rx_queues[i];
1399 stats->q_ipackets[i] = mq->n_pkts;
1400 stats->q_ibytes[i] = mq->n_bytes;
1401 stats->ipackets += mq->n_pkts;
1402 stats->ibytes += mq->n_bytes;
1405 tmp = (pmd->role == MEMIF_ROLE_CLIENT) ? pmd->run.num_s2c_rings :
1406 pmd->run.num_c2s_rings;
1407 nq = (tmp < RTE_ETHDEV_QUEUE_STAT_CNTRS) ? tmp :
1408 RTE_ETHDEV_QUEUE_STAT_CNTRS;
1411 for (i = 0; i < nq; i++) {
1412 mq = dev->data->tx_queues[i];
1413 stats->q_opackets[i] = mq->n_pkts;
1414 stats->q_obytes[i] = mq->n_bytes;
1415 stats->opackets += mq->n_pkts;
1416 stats->obytes += mq->n_bytes;
1422 memif_stats_reset(struct rte_eth_dev *dev)
1424 struct pmd_internals *pmd = dev->data->dev_private;
1426 struct memif_queue *mq;
1428 for (i = 0; i < pmd->run.num_c2s_rings; i++) {
1429 mq = (pmd->role == MEMIF_ROLE_CLIENT) ? dev->data->tx_queues[i] :
1430 dev->data->rx_queues[i];
1434 for (i = 0; i < pmd->run.num_s2c_rings; i++) {
1435 mq = (pmd->role == MEMIF_ROLE_CLIENT) ? dev->data->rx_queues[i] :
1436 dev->data->tx_queues[i];
1445 memif_rx_queue_intr_enable(struct rte_eth_dev *dev __rte_unused,
1446 uint16_t qid __rte_unused)
1448 MIF_LOG(WARNING, "Interrupt mode not supported.");
1454 memif_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t qid __rte_unused)
1456 struct pmd_internals *pmd __rte_unused = dev->data->dev_private;
1461 static const struct eth_dev_ops ops = {
1462 .dev_start = memif_dev_start,
1463 .dev_close = memif_dev_close,
1464 .dev_infos_get = memif_dev_info,
1465 .dev_configure = memif_dev_configure,
1466 .tx_queue_setup = memif_tx_queue_setup,
1467 .rx_queue_setup = memif_rx_queue_setup,
1468 .rx_queue_release = memif_queue_release,
1469 .tx_queue_release = memif_queue_release,
1470 .rx_queue_intr_enable = memif_rx_queue_intr_enable,
1471 .rx_queue_intr_disable = memif_rx_queue_intr_disable,
1472 .link_update = memif_link_update,
1473 .stats_get = memif_stats_get,
1474 .stats_reset = memif_stats_reset,
1478 memif_create(struct rte_vdev_device *vdev, enum memif_role_t role,
1479 memif_interface_id_t id, uint32_t flags,
1480 const char *socket_filename,
1481 memif_log2_ring_size_t log2_ring_size,
1482 uint16_t pkt_buffer_size, const char *secret,
1483 struct rte_ether_addr *ether_addr)
1486 struct rte_eth_dev *eth_dev;
1487 struct rte_eth_dev_data *data;
1488 struct pmd_internals *pmd;
1489 struct pmd_process_private *process_private;
1490 const unsigned int numa_node = vdev->device.numa_node;
1491 const char *name = rte_vdev_device_name(vdev);
1493 eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*pmd));
1494 if (eth_dev == NULL) {
1495 MIF_LOG(ERR, "%s: Unable to allocate device struct.", name);
1499 process_private = (struct pmd_process_private *)
1500 rte_zmalloc(name, sizeof(struct pmd_process_private),
1501 RTE_CACHE_LINE_SIZE);
1503 if (process_private == NULL) {
1504 MIF_LOG(ERR, "Failed to alloc memory for process private");
1507 eth_dev->process_private = process_private;
1509 pmd = eth_dev->data->dev_private;
1510 memset(pmd, 0, sizeof(*pmd));
1514 pmd->flags |= ETH_MEMIF_FLAG_DISABLED;
1516 /* Zero-copy flag irelevant to server. */
1517 if (pmd->role == MEMIF_ROLE_SERVER)
1518 pmd->flags &= ~ETH_MEMIF_FLAG_ZERO_COPY;
1520 ret = memif_socket_init(eth_dev, socket_filename);
1524 memset(pmd->secret, 0, sizeof(char) * ETH_MEMIF_SECRET_SIZE);
1526 strlcpy(pmd->secret, secret, sizeof(pmd->secret));
1528 pmd->cfg.log2_ring_size = log2_ring_size;
1529 /* set in .dev_configure() */
1530 pmd->cfg.num_c2s_rings = 0;
1531 pmd->cfg.num_s2c_rings = 0;
1533 pmd->cfg.pkt_buffer_size = pkt_buffer_size;
1534 rte_spinlock_init(&pmd->cc_lock);
1536 data = eth_dev->data;
1537 data->dev_private = pmd;
1538 data->numa_node = numa_node;
1539 data->dev_link = pmd_link;
1540 data->mac_addrs = ether_addr;
1541 data->promiscuous = 1;
1542 data->dev_flags |= RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS;
1544 eth_dev->dev_ops = &ops;
1545 eth_dev->device = &vdev->device;
1546 if (pmd->flags & ETH_MEMIF_FLAG_ZERO_COPY) {
1547 eth_dev->rx_pkt_burst = eth_memif_rx_zc;
1548 eth_dev->tx_pkt_burst = eth_memif_tx_zc;
1550 eth_dev->rx_pkt_burst = eth_memif_rx;
1551 eth_dev->tx_pkt_burst = eth_memif_tx;
1554 rte_eth_dev_probing_finish(eth_dev);
1560 memif_set_role(const char *key __rte_unused, const char *value,
1563 enum memif_role_t *role = (enum memif_role_t *)extra_args;
1565 if (strstr(value, "server") != NULL) {
1566 *role = MEMIF_ROLE_SERVER;
1567 } else if (strstr(value, "client") != NULL) {
1568 *role = MEMIF_ROLE_CLIENT;
1569 } else if (strstr(value, "master") != NULL) {
1570 MIF_LOG(NOTICE, "Role argument \"master\" is deprecated, use \"server\"");
1571 *role = MEMIF_ROLE_SERVER;
1572 } else if (strstr(value, "slave") != NULL) {
1573 MIF_LOG(NOTICE, "Role argument \"slave\" is deprecated, use \"client\"");
1574 *role = MEMIF_ROLE_CLIENT;
1576 MIF_LOG(ERR, "Unknown role: %s.", value);
1583 memif_set_zc(const char *key __rte_unused, const char *value, void *extra_args)
1585 uint32_t *flags = (uint32_t *)extra_args;
1587 if (strstr(value, "yes") != NULL) {
1588 if (!rte_mcfg_get_single_file_segments()) {
1589 MIF_LOG(ERR, "Zero-copy doesn't support multi-file segments.");
1592 *flags |= ETH_MEMIF_FLAG_ZERO_COPY;
1593 } else if (strstr(value, "no") != NULL) {
1594 *flags &= ~ETH_MEMIF_FLAG_ZERO_COPY;
1596 MIF_LOG(ERR, "Failed to parse zero-copy param: %s.", value);
1603 memif_set_id(const char *key __rte_unused, const char *value, void *extra_args)
1605 memif_interface_id_t *id = (memif_interface_id_t *)extra_args;
1607 /* even if parsing fails, 0 is a valid id */
1608 *id = strtoul(value, NULL, 10);
1613 memif_set_bs(const char *key __rte_unused, const char *value, void *extra_args)
1616 uint16_t *pkt_buffer_size = (uint16_t *)extra_args;
1618 tmp = strtoul(value, NULL, 10);
1619 if (tmp == 0 || tmp > 0xFFFF) {
1620 MIF_LOG(ERR, "Invalid buffer size: %s.", value);
1623 *pkt_buffer_size = tmp;
1628 memif_set_rs(const char *key __rte_unused, const char *value, void *extra_args)
1631 memif_log2_ring_size_t *log2_ring_size =
1632 (memif_log2_ring_size_t *)extra_args;
1634 tmp = strtoul(value, NULL, 10);
1635 if (tmp == 0 || tmp > ETH_MEMIF_MAX_LOG2_RING_SIZE) {
1636 MIF_LOG(ERR, "Invalid ring size: %s (max %u).",
1637 value, ETH_MEMIF_MAX_LOG2_RING_SIZE);
1640 *log2_ring_size = tmp;
1644 /* check if directory exists and if we have permission to read/write */
1646 memif_check_socket_filename(const char *filename)
1648 char *dir = NULL, *tmp;
1652 if (strlen(filename) >= MEMIF_SOCKET_UN_SIZE) {
1653 MIF_LOG(ERR, "Unix socket address too long (max 108).");
1657 tmp = strrchr(filename, '/');
1659 idx = tmp - filename;
1660 dir = rte_zmalloc("memif_tmp", sizeof(char) * (idx + 1), 0);
1662 MIF_LOG(ERR, "Failed to allocate memory.");
1665 strlcpy(dir, filename, sizeof(char) * (idx + 1));
1668 if (dir == NULL || (faccessat(-1, dir, F_OK | R_OK |
1669 W_OK, AT_EACCESS) < 0)) {
1670 MIF_LOG(ERR, "Invalid socket directory.");
1681 memif_set_socket_filename(const char *key __rte_unused, const char *value,
1684 const char **socket_filename = (const char **)extra_args;
1686 *socket_filename = value;
1691 memif_set_is_socket_abstract(const char *key __rte_unused, const char *value, void *extra_args)
1693 uint32_t *flags = (uint32_t *)extra_args;
1695 if (strstr(value, "yes") != NULL) {
1696 *flags |= ETH_MEMIF_FLAG_SOCKET_ABSTRACT;
1697 } else if (strstr(value, "no") != NULL) {
1698 *flags &= ~ETH_MEMIF_FLAG_SOCKET_ABSTRACT;
1700 MIF_LOG(ERR, "Failed to parse socket-abstract param: %s.", value);
1707 memif_set_mac(const char *key __rte_unused, const char *value, void *extra_args)
1709 struct rte_ether_addr *ether_addr = (struct rte_ether_addr *)extra_args;
1711 if (rte_ether_unformat_addr(value, ether_addr) < 0)
1712 MIF_LOG(WARNING, "Failed to parse mac '%s'.", value);
1717 memif_set_secret(const char *key __rte_unused, const char *value, void *extra_args)
1719 const char **secret = (const char **)extra_args;
1726 rte_pmd_memif_probe(struct rte_vdev_device *vdev)
1728 RTE_BUILD_BUG_ON(sizeof(memif_msg_t) != 128);
1729 RTE_BUILD_BUG_ON(sizeof(memif_desc_t) != 16);
1731 struct rte_kvargs *kvlist;
1732 const char *name = rte_vdev_device_name(vdev);
1733 enum memif_role_t role = MEMIF_ROLE_CLIENT;
1734 memif_interface_id_t id = 0;
1735 uint16_t pkt_buffer_size = ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE;
1736 memif_log2_ring_size_t log2_ring_size = ETH_MEMIF_DEFAULT_RING_SIZE;
1737 const char *socket_filename = ETH_MEMIF_DEFAULT_SOCKET_FILENAME;
1739 const char *secret = NULL;
1740 struct rte_ether_addr *ether_addr = rte_zmalloc("",
1741 sizeof(struct rte_ether_addr), 0);
1742 struct rte_eth_dev *eth_dev;
1744 rte_eth_random_addr(ether_addr->addr_bytes);
1746 MIF_LOG(INFO, "Initialize MEMIF: %s.", name);
1748 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
1749 eth_dev = rte_eth_dev_attach_secondary(name);
1751 MIF_LOG(ERR, "Failed to probe %s", name);
1755 eth_dev->dev_ops = &ops;
1756 eth_dev->device = &vdev->device;
1757 eth_dev->rx_pkt_burst = eth_memif_rx;
1758 eth_dev->tx_pkt_burst = eth_memif_tx;
1760 if (!rte_eal_primary_proc_alive(NULL)) {
1761 MIF_LOG(ERR, "Primary process is missing");
1765 eth_dev->process_private = (struct pmd_process_private *)
1767 sizeof(struct pmd_process_private),
1768 RTE_CACHE_LINE_SIZE);
1769 if (eth_dev->process_private == NULL) {
1771 "Failed to alloc memory for process private");
1775 rte_eth_dev_probing_finish(eth_dev);
1780 ret = rte_mp_action_register(MEMIF_MP_SEND_REGION, memif_mp_send_region);
1782 * Primary process can continue probing, but secondary process won't
1783 * be able to get memory regions information
1785 if (ret < 0 && rte_errno != EEXIST)
1786 MIF_LOG(WARNING, "Failed to register mp action callback: %s",
1787 strerror(rte_errno));
1789 /* use abstract address by default */
1790 flags |= ETH_MEMIF_FLAG_SOCKET_ABSTRACT;
1792 kvlist = rte_kvargs_parse(rte_vdev_device_args(vdev), valid_arguments);
1794 /* parse parameters */
1795 if (kvlist != NULL) {
1796 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ROLE_ARG,
1797 &memif_set_role, &role);
1800 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ID_ARG,
1801 &memif_set_id, &id);
1804 ret = rte_kvargs_process(kvlist, ETH_MEMIF_PKT_BUFFER_SIZE_ARG,
1805 &memif_set_bs, &pkt_buffer_size);
1808 ret = rte_kvargs_process(kvlist, ETH_MEMIF_RING_SIZE_ARG,
1809 &memif_set_rs, &log2_ring_size);
1812 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SOCKET_ARG,
1813 &memif_set_socket_filename,
1814 (void *)(&socket_filename));
1817 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SOCKET_ABSTRACT_ARG,
1818 &memif_set_is_socket_abstract, &flags);
1821 ret = rte_kvargs_process(kvlist, ETH_MEMIF_MAC_ARG,
1822 &memif_set_mac, ether_addr);
1825 ret = rte_kvargs_process(kvlist, ETH_MEMIF_ZC_ARG,
1826 &memif_set_zc, &flags);
1829 ret = rte_kvargs_process(kvlist, ETH_MEMIF_SECRET_ARG,
1830 &memif_set_secret, (void *)(&secret));
1835 if (!(flags & ETH_MEMIF_FLAG_SOCKET_ABSTRACT)) {
1836 ret = memif_check_socket_filename(socket_filename);
1841 /* create interface */
1842 ret = memif_create(vdev, role, id, flags, socket_filename,
1843 log2_ring_size, pkt_buffer_size, secret, ether_addr);
1847 rte_kvargs_free(kvlist);
1852 rte_pmd_memif_remove(struct rte_vdev_device *vdev)
1854 struct rte_eth_dev *eth_dev;
1856 eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
1857 if (eth_dev == NULL)
1860 return rte_eth_dev_close(eth_dev->data->port_id);
1863 static struct rte_vdev_driver pmd_memif_drv = {
1864 .probe = rte_pmd_memif_probe,
1865 .remove = rte_pmd_memif_remove,
1868 RTE_PMD_REGISTER_VDEV(net_memif, pmd_memif_drv);
1870 RTE_PMD_REGISTER_PARAM_STRING(net_memif,
1871 ETH_MEMIF_ID_ARG "=<int>"
1872 ETH_MEMIF_ROLE_ARG "=server|client"
1873 ETH_MEMIF_PKT_BUFFER_SIZE_ARG "=<int>"
1874 ETH_MEMIF_RING_SIZE_ARG "=<int>"
1875 ETH_MEMIF_SOCKET_ARG "=<string>"
1876 ETH_MEMIF_SOCKET_ABSTRACT_ARG "=yes|no"
1877 ETH_MEMIF_MAC_ARG "=xx:xx:xx:xx:xx:xx"
1878 ETH_MEMIF_ZC_ARG "=yes|no"
1879 ETH_MEMIF_SECRET_ARG "=<string>");
1881 RTE_LOG_REGISTER(memif_logtype, pmd.net.memif, NOTICE);