2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
22 #include <sys/types.h>
24 #include <sys/ioctl.h>
25 #include <sys/socket.h>
29 #include <sys/prctl.h>
30 #include <sys/eventfd.h>
34 #include <vlib/vlib.h>
35 #include <vlib/unix/unix.h>
36 #include <vppinfra/linux/syscall.h>
37 #include <vnet/plugin/plugin.h>
38 #include <vnet/ethernet/ethernet.h>
39 #include <vpp/app/version.h>
40 #include <memif/memif.h>
41 #include <memif/private.h>
43 memif_main_t memif_main;
46 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
53 memif_queue_intfd_close (memif_queue_t * mq)
55 if (mq->int_clib_file_index != ~0)
57 memif_file_del_by_index (mq->int_clib_file_index);
58 mq->int_clib_file_index = ~0;
61 else if (mq->int_fd > -1)
69 memif_disconnect (memif_if_t * mif, clib_error_t * err)
71 memif_main_t *mm = &memif_main;
72 vnet_main_t *vnm = vnet_get_main ();
80 DBG ("disconnect %u (%v)", mif->dev_instance, err ? err->what : 0);
85 mif->local_disc_string = vec_dup (err->what);
86 if (mif->sock && clib_socket_is_connected (mif->sock))
87 e = memif_msg_send_disconnect (mif, err);
91 /* set interface down */
92 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
93 if (mif->hw_if_index != ~0)
94 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
96 /* close connection socket */
97 if (mif->sock && mif->sock->fd)
99 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
100 mif->socket_file_index);
101 hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
102 memif_socket_close (&mif->sock);
107 err = clib_socket_close (mif->sock);
109 clib_error_report (err);
110 clib_mem_free (mif->sock);
113 vec_foreach_index (i, mif->rx_queues)
115 mq = vec_elt_at_index (mif->rx_queues, i);
119 rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
121 DBG ("Warning: unable to unassign interface %d, "
122 "queue %d: rc=%d", mif->hw_if_index, i, rv);
127 /* free tx and rx queues */
128 vec_foreach (mq, mif->rx_queues) memif_queue_intfd_close (mq);
129 vec_free (mif->rx_queues);
131 vec_foreach (mq, mif->tx_queues) memif_queue_intfd_close (mq);
132 vec_free (mif->tx_queues);
134 /* free memory regions */
135 vec_foreach (mr, mif->regions)
138 if ((rv = munmap (mr->shm, mr->region_size)))
139 clib_warning ("munmap failed, rv = %d", rv);
143 vec_free (mif->regions);
144 vec_free (mif->remote_name);
145 vec_free (mif->remote_if_name);
146 clib_fifo_free (mif->msg_queue);
149 static clib_error_t *
150 memif_int_fd_read_ready (clib_file_t * uf)
152 memif_main_t *mm = &memif_main;
153 vnet_main_t *vnm = vnet_get_main ();
154 u16 qid = uf->private_data & 0xFFFF;
155 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
156 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
160 size = read (uf->file_descriptor, &b, sizeof (b));
163 DBG_UNIX_LOG ("Failed to read from socket");
167 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
175 memif_connect (memif_if_t * mif)
177 vnet_main_t *vnm = vnet_get_main ();
178 clib_file_t template = { 0 };
182 DBG ("connect %u", mif->dev_instance);
184 vec_free (mif->local_disc_string);
185 vec_free (mif->remote_disc_string);
187 vec_foreach (mr, mif->regions)
193 clib_error_return (0, "no memory region fd");
195 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
196 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
197 return clib_error_return_unix (0, "mmap");
200 template.read_function = memif_int_fd_read_ready;
202 vec_foreach_index (i, mif->tx_queues)
204 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
206 mq->ring = mif->regions[mq->region].shm + mq->offset;
207 if (mq->ring->cookie != MEMIF_COOKIE)
208 return clib_error_return (0, "wrong cookie on tx ring %u", i);
211 vec_foreach_index (i, mif->rx_queues)
213 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
216 mq->ring = mif->regions[mq->region].shm + mq->offset;
217 if (mq->ring->cookie != MEMIF_COOKIE)
218 return clib_error_return (0, "wrong cookie on tx ring %u", i);
222 template.file_descriptor = mq->int_fd;
223 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
224 memif_file_add (&mq->int_clib_file_index, &template);
226 vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
227 rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
228 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
231 ("Warning: unable to set rx mode for interface %d queue %d: "
232 "rc=%d", mif->hw_if_index, i, rv);
235 vnet_hw_interface_rx_mode rxmode;
236 vnet_hw_interface_get_rx_mode (vnm, mif->hw_if_index, i, &rxmode);
238 if (rxmode == VNET_HW_INTERFACE_RX_MODE_POLLING)
239 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
243 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
244 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
246 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
247 VNET_HW_INTERFACE_FLAG_LINK_UP);
251 static_always_inline memif_ring_t *
252 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
254 if (vec_len (mif->regions) == 0)
256 void *p = mif->regions[0].shm;
258 sizeof (memif_ring_t) +
259 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
260 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
262 return (memif_ring_t *) p;
266 memif_init_regions_and_queues (memif_if_t * mif)
268 memif_ring_t *ring = NULL;
272 clib_mem_vm_alloc_t alloc = { 0 };
275 vec_validate_aligned (mif->regions, 0, CLIB_CACHE_LINE_BYTES);
276 r = vec_elt_at_index (mif->regions, 0);
278 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
279 (sizeof (memif_ring_t) +
280 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
282 r->region_size = buffer_offset +
283 mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
284 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
286 alloc.name = "memif region";
287 alloc.size = r->region_size;
288 alloc.flags = CLIB_MEM_VM_F_SHARED;
290 err = clib_mem_vm_ext_alloc (&alloc);
297 for (i = 0; i < mif->run.num_s2m_rings; i++)
299 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
300 ring->head = ring->tail = 0;
301 ring->cookie = MEMIF_COOKIE;
302 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
304 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
305 ring->desc[j].region = 0;
306 ring->desc[j].offset =
307 buffer_offset + (u32) (slot * mif->run.buffer_size);
308 ring->desc[j].buffer_length = mif->run.buffer_size;
311 for (i = 0; i < mif->run.num_m2s_rings; i++)
313 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
314 ring->head = ring->tail = 0;
315 ring->cookie = MEMIF_COOKIE;
316 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
319 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
320 ring->desc[j].region = 0;
321 ring->desc[j].offset =
322 buffer_offset + (u32) (slot * mif->run.buffer_size);
323 ring->desc[j].buffer_length = mif->run.buffer_size;
327 ASSERT (mif->tx_queues == 0);
328 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
329 CLIB_CACHE_LINE_BYTES);
330 vec_foreach_index (i, mif->tx_queues)
332 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
333 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
334 return clib_error_return_unix (0, "eventfd[tx queue %u]", i);
335 mq->int_clib_file_index = ~0;
336 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
337 mq->log2_ring_size = mif->cfg.log2_ring_size;
339 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
343 ASSERT (mif->rx_queues == 0);
344 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
345 CLIB_CACHE_LINE_BYTES);
346 vec_foreach_index (i, mif->rx_queues)
348 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
349 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
350 return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
351 mq->int_clib_file_index = ~0;
352 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
353 mq->log2_ring_size = mif->cfg.log2_ring_size;
355 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
363 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
365 memif_main_t *mm = &memif_main;
368 uword *event_data = 0, event_type;
370 f64 start_time, last_run_duration = 0, now;
373 sock = clib_mem_alloc (sizeof (clib_socket_t));
374 memset (sock, 0, sizeof (clib_socket_t));
379 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
382 vlib_process_wait_for_event (vm);
384 event_type = vlib_process_get_events (vm, &event_data);
385 vec_reset_length (event_data);
391 case MEMIF_PROCESS_EVENT_START:
394 case MEMIF_PROCESS_EVENT_STOP:
401 last_run_duration = start_time = vlib_time_now (vm);
403 pool_foreach (mif, mm->interfaces,
405 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
406 /* Allow no more than 10us without a pause */
407 now = vlib_time_now (vm);
408 if (now > start_time + 10e-6)
410 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
411 start_time = vlib_time_now (vm);
414 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
417 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
420 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
423 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
425 memset (sock, 0, sizeof(clib_socket_t));
426 sock->config = (char *) msf->filename;
427 sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
429 if ((err = clib_socket_init (sock)))
431 clib_error_free (err);
435 clib_file_t t = { 0 };
437 t.read_function = memif_slave_conn_fd_read_ready;
438 t.write_function = memif_slave_conn_fd_write_ready;
439 t.error_function = memif_slave_conn_fd_error;
440 t.file_descriptor = sock->fd;
441 t.private_data = mif->dev_instance;
442 memif_file_add (&sock->private_data, &t);
443 hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
445 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
447 sock = clib_mem_alloc (sizeof(clib_socket_t));
452 last_run_duration = vlib_time_now (vm) - last_run_duration;
458 VLIB_REGISTER_NODE (memif_process_node,static) = {
459 .function = memif_process,
460 .type = VLIB_NODE_TYPE_PROCESS,
461 .name = "memif-process",
466 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
468 vnet_main_t *vnm = vnet_get_main ();
469 memif_main_t *mm = &memif_main;
470 memif_socket_file_t *msf =
471 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
474 mif->flags |= MEMIF_IF_FLAG_DELETING;
475 vec_free (mif->local_disc_string);
476 vec_free (mif->remote_disc_string);
478 /* bring down the interface */
479 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
480 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
482 err = clib_error_return (0, "interface deleted");
483 memif_disconnect (mif, err);
484 clib_error_free (err);
486 /* remove the interface */
487 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
488 vnet_delete_hw_interface (vnm, mif->hw_if_index);
490 ethernet_delete_interface (vnm, mif->hw_if_index);
491 mif->hw_if_index = ~0;
493 /* free interface data structures */
494 clib_spinlock_free (&mif->lockp);
495 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
497 /* remove socket file */
498 if (--(msf->ref_cnt) == 0)
500 if (msf->is_listener)
503 vec_foreach_index (i, msf->pending_clients)
505 memif_socket_close (msf->pending_clients + i);
507 memif_socket_close (&msf->sock);
508 vec_free (msf->pending_clients);
510 mhash_free (&msf->dev_instance_by_id);
511 hash_free (msf->dev_instance_by_fd);
512 mhash_unset (&mm->socket_file_index_by_filename, msf->filename, 0);
513 vec_free (msf->filename);
516 err = clib_socket_close (msf->sock);
518 clib_error_report (err);
519 clib_mem_free (msf->sock);
521 pool_put (mm->socket_files, msf);
524 memset (mif, 0, sizeof (*mif));
525 pool_put (mm->interfaces, mif);
527 if (pool_elts (mm->interfaces) == 0)
528 vlib_process_signal_event (vm, memif_process_node.index,
529 MEMIF_PROCESS_EVENT_STOP, 0);
535 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
538 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
543 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
545 memif_main_t *mm = &memif_main;
546 vlib_thread_main_t *tm = vlib_get_thread_main ();
547 vnet_main_t *vnm = vnet_get_main ();
549 vnet_sw_interface_t *sw;
550 clib_error_t *error = 0;
553 vnet_hw_interface_t *hw;
554 memif_socket_file_t *msf = 0;
558 if (args->socket_filename == 0 || args->socket_filename[0] != '/')
561 error = vlib_unix_recursive_mkdir (vlib_unix_get_runtime_dir ());
564 clib_error_free (error);
565 return VNET_API_ERROR_SYSCALL_ERROR_1;
568 if (args->socket_filename == 0)
569 socket_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
570 MEMIF_DEFAULT_SOCKET_FILENAME, 0);
572 socket_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
573 args->socket_filename, 0);
577 socket_filename = vec_dup (args->socket_filename);
579 p = mhash_get (&mm->socket_file_index_by_filename, socket_filename);
583 msf = vec_elt_at_index (mm->socket_files, p[0]);
585 /* existing socket file can be either master or slave but cannot be both */
586 if (!msf->is_listener != !args->is_master)
588 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
592 p = mhash_get (&msf->dev_instance_by_id, &args->id);
595 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
600 /* Create new socket file */
603 struct stat file_stat;
604 /* If we are creating listener make sure file doesn't exist or if it
605 * exists thn delete it if it is old socket file */
606 if (args->is_master &&
607 (stat ((char *) socket_filename, &file_stat) == 0))
609 if (S_ISSOCK (file_stat.st_mode))
611 unlink ((char *) socket_filename);
615 error = clib_error_return (0, "File exists for %s",
617 clib_error_report (error);
618 rv = VNET_API_ERROR_VALUE_EXIST;
622 pool_get (mm->socket_files, msf);
623 memset (msf, 0, sizeof (memif_socket_file_t));
624 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
625 sizeof (memif_interface_id_t));
626 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
627 msf->filename = socket_filename;
628 msf->is_listener = (args->is_master != 0);
630 mhash_set (&mm->socket_file_index_by_filename, msf->filename,
631 msf - mm->socket_files, 0);
632 DBG ("creating socket file %s", msf->filename);
635 pool_get (mm->interfaces, mif);
636 memset (mif, 0, sizeof (*mif));
637 mif->dev_instance = mif - mm->interfaces;
638 mif->socket_file_index = msf - mm->socket_files;
640 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
641 mif->mode = args->mode;
643 mif->secret = vec_dup (args->secret);
645 if (tm->n_vlib_mains > 1)
646 clib_spinlock_init (&mif->lockp);
649 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
652 if (!args->hw_addr_set)
654 f64 now = vlib_time_now (vm);
656 rnd = (u32) (now * 1e6);
657 rnd = random_u32 (&rnd);
659 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
660 args->hw_addr[0] = 2;
661 args->hw_addr[1] = 0xfe;
663 error = ethernet_register_interface (vnm, memif_device_class.index,
664 mif->dev_instance, args->hw_addr,
666 memif_eth_flag_change);
668 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
671 vnet_register_interface (vnm, memif_device_class.index,
673 memif_ip_hw_if_class.index,
677 error = clib_error_return (0, "unsupported interface mode");
681 clib_error_report (error);
682 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
686 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
687 mif->sw_if_index = sw->sw_if_index;
689 mif->cfg.log2_ring_size = args->log2_ring_size;
690 mif->cfg.buffer_size = args->buffer_size;
691 mif->cfg.num_s2m_rings =
692 args->is_master ? args->rx_queues : args->tx_queues;
693 mif->cfg.num_m2s_rings =
694 args->is_master ? args->tx_queues : args->rx_queues;
696 args->sw_if_index = mif->sw_if_index;
698 /* If this is new one, start listening */
699 if (msf->is_listener && msf->ref_cnt == 0)
701 struct stat file_stat;
702 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
704 ASSERT (msf->sock == 0);
707 memset (s, 0, sizeof (clib_socket_t));
708 s->config = (char *) msf->filename;
709 s->flags = CLIB_SOCKET_F_IS_SERVER |
710 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
711 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
713 if ((error = clib_socket_init (s)))
715 clib_error_report (error);
716 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
720 if (stat ((char *) msf->filename, &file_stat) == -1)
722 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
726 clib_file_t template = { 0 };
727 template.read_function = memif_conn_fd_accept_ready;
728 template.file_descriptor = msf->sock->fd;
729 template.private_data = mif->socket_file_index;
730 memif_file_add (&msf->sock->private_data, &template);
735 if (args->is_master == 0)
736 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
738 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
739 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
740 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
741 memif_input_node.index);
743 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
745 if (pool_elts (mm->interfaces) == 1)
747 vlib_process_signal_event (vm, memif_process_node.index,
748 MEMIF_PROCESS_EVENT_START, 0);
753 if (mif->hw_if_index != ~0)
755 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
756 vnet_delete_hw_interface (vnm, mif->hw_if_index);
758 ethernet_delete_interface (vnm, mif->hw_if_index);
759 mif->hw_if_index = ~0;
761 memif_delete_if (vm, mif);
765 vec_free (socket_filename);
770 static clib_error_t *
771 memif_init (vlib_main_t * vm)
773 memif_main_t *mm = &memif_main;
774 vlib_thread_main_t *tm = vlib_get_thread_main ();
776 memset (mm, 0, sizeof (memif_main_t));
778 /* initialize binary API */
779 memif_plugin_api_hookup (vm);
781 mhash_init_c_string (&mm->socket_file_index_by_filename, sizeof (uword));
783 vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
784 CLIB_CACHE_LINE_BYTES);
789 VLIB_INIT_FUNCTION (memif_init);
792 VLIB_PLUGIN_REGISTER () = {
793 .version = VPP_BUILD_VER,
794 .description = "Packet Memory Interface (experimetal)",
799 * fd.io coding-style-patch-verification: ON
802 * eval: (c-set-style "gnu")