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 <vnet/plugin/plugin.h>
37 #include <vnet/ethernet/ethernet.h>
38 #include <vpp/app/version.h>
39 #include <memif/memif.h>
40 #include <memif/private.h>
42 memif_main_t memif_main;
45 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
52 memif_queue_intfd_close (memif_queue_t * mq)
54 if (mq->int_unix_file_index != ~0)
56 memif_file_del_by_index (mq->int_unix_file_index);
57 mq->int_unix_file_index = ~0;
60 else if (mq->int_fd > -1)
68 memif_disconnect (memif_if_t * mif, clib_error_t * err)
70 memif_main_t *mm = &memif_main;
71 vnet_main_t *vnm = vnet_get_main ();
79 DBG ("disconnect %u (%v)", mif->dev_instance, err ? err->what : 0);
84 mif->local_disc_string = vec_dup (err->what);
85 if (mif->conn_fd > -1)
86 e = memif_msg_send_disconnect (mif, err);
90 /* set interface down */
91 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
92 if (mif->hw_if_index != ~0)
93 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
95 /* close connection socket */
96 if (mif->conn_unix_file_index != ~0)
98 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
99 mif->socket_file_index);
100 hash_unset (msf->dev_instance_by_fd, mif->conn_fd);
101 memif_file_del_by_index (mif->conn_unix_file_index);
102 mif->conn_unix_file_index = ~0;
104 else if (mif->conn_fd > -1)
105 close (mif->conn_fd);
108 vec_foreach_index (i, mif->rx_queues)
110 mq = vec_elt_at_index (mif->rx_queues, i);
114 rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
116 DBG ("Warning: unable to unassign interface %d, "
117 "queue %d: rc=%d", mif->hw_if_index, i, rv);
122 /* free tx and rx queues */
123 vec_foreach (mq, mif->rx_queues) memif_queue_intfd_close (mq);
124 vec_free (mif->rx_queues);
126 vec_foreach (mq, mif->tx_queues) memif_queue_intfd_close (mq);
127 vec_free (mif->tx_queues);
129 /* free memory regions */
130 vec_foreach (mr, mif->regions)
133 if ((rv = munmap (mr->shm, mr->region_size)))
134 clib_warning ("munmap failed, rv = %d", rv);
138 vec_free (mif->regions);
141 vec_free (mif->remote_name);
142 vec_free (mif->remote_if_name);
143 clib_fifo_free (mif->msg_queue);
146 static clib_error_t *
147 memif_int_fd_read_ready (unix_file_t * uf)
149 memif_main_t *mm = &memif_main;
150 vnet_main_t *vnm = vnet_get_main ();
151 u16 qid = uf->private_data & 0xFFFF;
152 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
153 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
157 size = read (uf->file_descriptor, &b, sizeof (b));
160 DBG_UNIX_LOG ("Failed to read from socket");
164 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
172 memif_connect (memif_if_t * mif)
174 vnet_main_t *vnm = vnet_get_main ();
175 unix_file_t template = { 0 };
179 DBG ("connect %u", mif->dev_instance);
181 vec_free (mif->local_disc_string);
182 vec_free (mif->remote_disc_string);
184 vec_foreach (mr, mif->regions)
190 clib_error_return (0, "no memory region fd");
192 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
193 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
194 return clib_error_return_unix (0, "mmap");
197 template.read_function = memif_int_fd_read_ready;
199 vec_foreach_index (i, mif->tx_queues)
201 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
203 mq->ring = mif->regions[mq->region].shm + mq->offset;
204 if (mq->ring->cookie != MEMIF_COOKIE)
205 return clib_error_return (0, "wrong cookie on tx ring %u", i);
208 vec_foreach_index (i, mif->rx_queues)
210 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
213 mq->ring = mif->regions[mq->region].shm + mq->offset;
214 if (mq->ring->cookie != MEMIF_COOKIE)
215 return clib_error_return (0, "wrong cookie on tx ring %u", i);
219 template.file_descriptor = mq->int_fd;
220 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
221 memif_file_add (&mq->int_unix_file_index, &template);
223 vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
224 rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
225 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
228 ("Warning: unable to set rx mode for interface %d queue %d: "
229 "rc=%d", mif->hw_if_index, i, rv);
232 vnet_hw_interface_rx_mode rxmode;
233 vnet_hw_interface_get_rx_mode (vnm, mif->hw_if_index, i, &rxmode);
235 if (rxmode == VNET_HW_INTERFACE_RX_MODE_POLLING)
236 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
240 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
241 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
243 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
244 VNET_HW_INTERFACE_FLAG_LINK_UP);
248 static_always_inline memif_ring_t *
249 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
251 if (vec_len (mif->regions) == 0)
253 void *p = mif->regions[0].shm;
255 sizeof (memif_ring_t) +
256 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
257 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
259 return (memif_ring_t *) p;
263 memif_init_regions_and_queues (memif_if_t * mif)
265 memif_ring_t *ring = NULL;
270 vec_validate_aligned (mif->regions, 0, CLIB_CACHE_LINE_BYTES);
271 r = vec_elt_at_index (mif->regions, 0);
273 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
274 (sizeof (memif_ring_t) +
275 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
277 r->region_size = buffer_offset +
278 mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
279 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
281 if ((r->fd = memfd_create ("memif region 0", MFD_ALLOW_SEALING)) == -1)
282 return clib_error_return_unix (0, "memfd_create");
284 if ((fcntl (r->fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
285 return clib_error_return_unix (0, "fcntl (F_ADD_SEALS, F_SEAL_SHRINK)");
287 if ((ftruncate (r->fd, r->region_size)) == -1)
288 return clib_error_return_unix (0, "ftruncate");
290 if ((r->shm = mmap (NULL, r->region_size, PROT_READ | PROT_WRITE,
291 MAP_SHARED, r->fd, 0)) == MAP_FAILED)
292 return clib_error_return_unix (0, "mmap");
294 for (i = 0; i < mif->run.num_s2m_rings; i++)
296 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
297 ring->head = ring->tail = 0;
298 ring->cookie = MEMIF_COOKIE;
299 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
301 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
302 ring->desc[j].region = 0;
303 ring->desc[j].offset =
304 buffer_offset + (u32) (slot * mif->run.buffer_size);
305 ring->desc[j].buffer_length = mif->run.buffer_size;
308 for (i = 0; i < mif->run.num_m2s_rings; i++)
310 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
311 ring->head = ring->tail = 0;
312 ring->cookie = MEMIF_COOKIE;
313 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
316 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
317 ring->desc[j].region = 0;
318 ring->desc[j].offset =
319 buffer_offset + (u32) (slot * mif->run.buffer_size);
320 ring->desc[j].buffer_length = mif->run.buffer_size;
324 ASSERT (mif->tx_queues == 0);
325 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
326 CLIB_CACHE_LINE_BYTES);
327 vec_foreach_index (i, mif->tx_queues)
329 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
330 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
331 return clib_error_return_unix (0, "eventfd[tx queue %u]", i);
332 mq->int_unix_file_index = ~0;
333 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
334 mq->log2_ring_size = mif->cfg.log2_ring_size;
336 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
340 ASSERT (mif->rx_queues == 0);
341 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
342 CLIB_CACHE_LINE_BYTES);
343 vec_foreach_index (i, mif->rx_queues)
345 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
346 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
347 return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
348 mq->int_unix_file_index = ~0;
349 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
350 mq->log2_ring_size = mif->cfg.log2_ring_size;
352 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
360 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
362 memif_main_t *mm = &memif_main;
364 struct sockaddr_un sun;
366 uword *event_data = 0, event_type;
368 f64 start_time, last_run_duration = 0, now;
370 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
373 DBG_UNIX_LOG ("socket AF_UNIX");
376 sun.sun_family = AF_UNIX;
381 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
384 vlib_process_wait_for_event (vm);
386 event_type = vlib_process_get_events (vm, &event_data);
387 vec_reset_length (event_data);
393 case MEMIF_PROCESS_EVENT_START:
396 case MEMIF_PROCESS_EVENT_STOP:
403 last_run_duration = start_time = vlib_time_now (vm);
405 pool_foreach (mif, mm->interfaces,
407 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
408 /* Allow no more than 10us without a pause */
409 now = vlib_time_now (vm);
410 if (now > start_time + 10e-6)
412 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
413 start_time = vlib_time_now (vm);
416 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
419 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
422 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
425 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
427 strncpy (sun.sun_path, (char *) msf->filename,
428 sizeof (sun.sun_path) - 1);
431 (sockfd, (struct sockaddr *) &sun,
432 sizeof (struct sockaddr_un)) == 0)
434 unix_file_t t = { 0 };
436 mif->conn_fd = sockfd;
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 = mif->conn_fd;
441 t.private_data = mif->dev_instance;
442 memif_file_add (&mif->conn_unix_file_index, &t);
443 hash_set (msf->dev_instance_by_fd, mif->conn_fd, mif->dev_instance);
445 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
447 /* grab another fd */
448 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
451 DBG_UNIX_LOG ("socket AF_UNIX");
458 last_run_duration = vlib_time_now (vm) - last_run_duration;
464 VLIB_REGISTER_NODE (memif_process_node,static) = {
465 .function = memif_process,
466 .type = VLIB_NODE_TYPE_PROCESS,
467 .name = "memif-process",
472 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
474 vnet_main_t *vnm = vnet_get_main ();
475 memif_main_t *mm = &memif_main;
476 memif_socket_file_t *msf =
477 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
480 mif->flags |= MEMIF_IF_FLAG_DELETING;
481 vec_free (mif->local_disc_string);
482 vec_free (mif->remote_disc_string);
484 /* bring down the interface */
485 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
486 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
488 err = clib_error_return (0, "interface deleted");
489 memif_disconnect (mif, err);
490 clib_error_free (err);
492 /* remove the interface */
493 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
494 vnet_delete_hw_interface (vnm, mif->hw_if_index);
496 ethernet_delete_interface (vnm, mif->hw_if_index);
497 mif->hw_if_index = ~0;
499 /* free interface data structures */
500 clib_spinlock_free (&mif->lockp);
501 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
503 /* remove socket file */
504 if (--(msf->ref_cnt) == 0)
506 if (msf->is_listener)
509 memif_file_del_by_index (msf->unix_file_index);
510 vec_foreach (x, msf->pending_file_indices)
512 memif_file_del_by_index (*x);
514 vec_free (msf->pending_file_indices);
516 mhash_free (&msf->dev_instance_by_id);
517 hash_free (msf->dev_instance_by_fd);
518 mhash_unset (&mm->socket_file_index_by_filename, msf->filename, 0);
519 vec_free (msf->filename);
520 pool_put (mm->socket_files, msf);
523 memset (mif, 0, sizeof (*mif));
524 pool_put (mm->interfaces, mif);
526 if (pool_elts (mm->interfaces) == 0)
527 vlib_process_signal_event (vm, memif_process_node.index,
528 MEMIF_PROCESS_EVENT_STOP, 0);
534 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
537 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
542 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
544 memif_main_t *mm = &memif_main;
545 vlib_thread_main_t *tm = vlib_get_thread_main ();
546 vnet_main_t *vnm = vnet_get_main ();
548 vnet_sw_interface_t *sw;
549 clib_error_t *error = 0;
552 vnet_hw_interface_t *hw;
553 memif_socket_file_t *msf = 0;
557 if (args->socket_filename == 0 || args->socket_filename[0] != '/')
559 rv = mkdir (MEMIF_DEFAULT_SOCKET_DIR, 0755);
560 if (rv && errno != EEXIST)
561 return VNET_API_ERROR_SYSCALL_ERROR_1;
563 if (args->socket_filename == 0)
564 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
565 MEMIF_DEFAULT_SOCKET_FILENAME, 0);
567 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
568 args->socket_filename, 0);
572 socket_filename = vec_dup (args->socket_filename);
574 p = mhash_get (&mm->socket_file_index_by_filename, socket_filename);
578 msf = vec_elt_at_index (mm->socket_files, p[0]);
580 /* existing socket file can be either master or slave but cannot be both */
581 if (!msf->is_listener != !args->is_master)
583 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
587 p = mhash_get (&msf->dev_instance_by_id, &args->id);
590 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
595 /* Create new socket file */
598 struct stat file_stat;
599 /* If we are creating listener make sure file doesn't exist or if it
600 * exists thn delete it if it is old socket file */
601 if (args->is_master &&
602 (stat ((char *) socket_filename, &file_stat) == 0))
604 if (S_ISSOCK (file_stat.st_mode))
606 unlink ((char *) socket_filename);
610 ret = VNET_API_ERROR_SYSCALL_ERROR_3;
614 pool_get (mm->socket_files, msf);
615 memset (msf, 0, sizeof (memif_socket_file_t));
616 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
617 sizeof (memif_interface_id_t));
618 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
619 msf->filename = socket_filename;
621 msf->is_listener = (args->is_master != 0);
623 mhash_set (&mm->socket_file_index_by_filename, msf->filename,
624 msf - mm->socket_files, 0);
625 DBG ("creating socket file %s", msf->filename);
628 pool_get (mm->interfaces, mif);
629 memset (mif, 0, sizeof (*mif));
630 mif->dev_instance = mif - mm->interfaces;
631 mif->socket_file_index = msf - mm->socket_files;
633 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
634 mif->conn_unix_file_index = ~0;
636 mif->mode = args->mode;
638 mif->secret = vec_dup (args->secret);
640 if (tm->n_vlib_mains > 1)
641 clib_spinlock_init (&mif->lockp);
644 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
647 if (!args->hw_addr_set)
649 f64 now = vlib_time_now (vm);
651 rnd = (u32) (now * 1e6);
652 rnd = random_u32 (&rnd);
654 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
655 args->hw_addr[0] = 2;
656 args->hw_addr[1] = 0xfe;
658 error = ethernet_register_interface (vnm, memif_device_class.index,
659 mif->dev_instance, args->hw_addr,
661 memif_eth_flag_change);
663 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
666 vnet_register_interface (vnm, memif_device_class.index,
668 memif_ip_hw_if_class.index,
672 error = clib_error_return (0, "unsupported interface mode");
676 clib_error_report (error);
677 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
681 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
682 mif->sw_if_index = sw->sw_if_index;
684 mif->cfg.log2_ring_size = args->log2_ring_size;
685 mif->cfg.buffer_size = args->buffer_size;
686 mif->cfg.num_s2m_rings =
687 args->is_master ? args->rx_queues : args->tx_queues;
688 mif->cfg.num_m2s_rings =
689 args->is_master ? args->tx_queues : args->rx_queues;
691 args->sw_if_index = mif->sw_if_index;
693 /* If this is new one, start listening */
694 if (msf->is_listener && msf->ref_cnt == 0)
696 struct sockaddr_un un = { 0 };
697 struct stat file_stat;
700 if ((msf->fd = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
702 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
706 un.sun_family = AF_UNIX;
707 strncpy ((char *) un.sun_path, (char *) msf->filename,
708 sizeof (un.sun_path) - 1);
710 if (setsockopt (msf->fd, SOL_SOCKET, SO_PASSCRED, &on, sizeof (on)) < 0)
712 ret = VNET_API_ERROR_SYSCALL_ERROR_5;
715 if (bind (msf->fd, (struct sockaddr *) &un, sizeof (un)) == -1)
717 ret = VNET_API_ERROR_SYSCALL_ERROR_6;
720 if (listen (msf->fd, 1) == -1)
722 ret = VNET_API_ERROR_SYSCALL_ERROR_7;
726 if (stat ((char *) msf->filename, &file_stat) == -1)
728 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
732 msf->unix_file_index = ~0;
733 unix_file_t template = { 0 };
734 template.read_function = memif_conn_fd_accept_ready;
735 template.file_descriptor = msf->fd;
736 template.private_data = mif->socket_file_index;
737 memif_file_add (&msf->unix_file_index, &template);
742 if (args->is_master == 0)
743 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
745 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
746 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
747 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
748 memif_input_node.index);
750 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
752 if (pool_elts (mm->interfaces) == 1)
754 vlib_process_signal_event (vm, memif_process_node.index,
755 MEMIF_PROCESS_EVENT_START, 0);
760 if (mif->hw_if_index != ~0)
762 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
763 vnet_delete_hw_interface (vnm, mif->hw_if_index);
765 ethernet_delete_interface (vnm, mif->hw_if_index);
766 mif->hw_if_index = ~0;
768 memif_delete_if (vm, mif);
772 vec_free (socket_filename);
777 static clib_error_t *
778 memif_init (vlib_main_t * vm)
780 memif_main_t *mm = &memif_main;
781 vlib_thread_main_t *tm = vlib_get_thread_main ();
783 memset (mm, 0, sizeof (memif_main_t));
785 /* initialize binary API */
786 memif_plugin_api_hookup (vm);
788 mhash_init_c_string (&mm->socket_file_index_by_filename, sizeof (uword));
790 vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
791 CLIB_CACHE_LINE_BYTES);
796 VLIB_INIT_FUNCTION (memif_init);
799 VLIB_PLUGIN_REGISTER () = {
800 .version = VPP_BUILD_VER,
801 .description = "Packet Memory Interface (experimetal)",
806 * fd.io coding-style-patch-verification: ON
809 * eval: (c-set-style "gnu")