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 vnet_main_t *vnm = vnet_get_main ();
78 DBG ("disconnect %u (%v)", mif->dev_instance, err ? err->what : 0);
83 mif->local_disc_string = vec_dup (err->what);
84 if (mif->conn_fd > -1)
85 e = memif_msg_send_disconnect (mif, err);
89 /* set interface down */
90 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
91 if (mif->hw_if_index != ~0)
92 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
94 /* close connection socket */
95 if (mif->conn_unix_file_index != ~0)
97 memif_file_del_by_index (mif->conn_unix_file_index);
98 mif->conn_unix_file_index = ~0;
100 else if (mif->conn_fd > -1)
101 close (mif->conn_fd);
104 vec_foreach_index (i, mif->rx_queues)
106 mq = vec_elt_at_index (mif->rx_queues, i);
110 rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
112 DBG ("Warning: unable to unassign interface %d, "
113 "queue %d: rc=%d", mif->hw_if_index, i, rv);
118 /* free tx and rx queues */
119 vec_foreach (mq, mif->rx_queues) memif_queue_intfd_close (mq);
120 vec_free (mif->rx_queues);
122 vec_foreach (mq, mif->tx_queues) memif_queue_intfd_close (mq);
123 vec_free (mif->tx_queues);
125 /* free memory regions */
126 vec_foreach (mr, mif->regions)
129 if ((rv = munmap (mr->shm, mr->region_size)))
130 clib_warning ("munmap failed, rv = %d", rv);
134 vec_free (mif->regions);
137 vec_free (mif->remote_name);
138 vec_free (mif->remote_if_name);
139 clib_fifo_free (mif->msg_queue);
142 static clib_error_t *
143 memif_int_fd_read_ready (unix_file_t * uf)
145 memif_main_t *mm = &memif_main;
146 vnet_main_t *vnm = vnet_get_main ();
147 u16 qid = uf->private_data & 0xFFFF;
148 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
149 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
153 size = read (uf->file_descriptor, &b, sizeof (b));
156 DBG_UNIX_LOG ("Failed to read from socket");
160 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
168 memif_connect (memif_if_t * mif)
170 vnet_main_t *vnm = vnet_get_main ();
171 unix_file_t template = { 0 };
175 DBG ("connect %u", mif->dev_instance);
177 vec_free (mif->local_disc_string);
178 vec_free (mif->remote_disc_string);
180 vec_foreach (mr, mif->regions)
186 clib_error_return (0, "no memory region fd");
188 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
189 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
190 return clib_error_return_unix (0, "mmap");
193 template.read_function = memif_int_fd_read_ready;
195 vec_foreach_index (i, mif->tx_queues)
197 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
199 mq->ring = mif->regions[mq->region].shm + mq->offset;
200 if (mq->ring->cookie != MEMIF_COOKIE)
201 return clib_error_return (0, "wrong cookie on tx ring %u", i);
204 vec_foreach_index (i, mif->rx_queues)
206 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
209 mq->ring = mif->regions[mq->region].shm + mq->offset;
210 if (mq->ring->cookie != MEMIF_COOKIE)
211 return clib_error_return (0, "wrong cookie on tx ring %u", i);
215 template.file_descriptor = mq->int_fd;
216 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
217 memif_file_add (&mq->int_unix_file_index, &template);
219 vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
220 rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
221 VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
224 ("Warning: unable to set rx mode for interface %d queue %d: "
225 "rc=%d", mif->hw_if_index, i, rv);
228 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
229 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
231 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
232 VNET_HW_INTERFACE_FLAG_LINK_UP);
236 static_always_inline memif_ring_t *
237 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
239 if (vec_len (mif->regions) == 0)
241 void *p = mif->regions[0].shm;
243 sizeof (memif_ring_t) +
244 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
245 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
247 return (memif_ring_t *) p;
251 memif_init_regions_and_queues (memif_if_t * mif)
253 memif_ring_t *ring = NULL;
258 vec_validate_aligned (mif->regions, 0, CLIB_CACHE_LINE_BYTES);
259 r = vec_elt_at_index (mif->regions, 0);
261 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
262 (sizeof (memif_ring_t) +
263 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
265 r->region_size = buffer_offset +
266 mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
267 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
269 if ((r->fd = memfd_create ("memif region 0", MFD_ALLOW_SEALING)) == -1)
270 return clib_error_return_unix (0, "memfd_create");
272 if ((fcntl (r->fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
273 return clib_error_return_unix (0, "fcntl (F_ADD_SEALS, F_SEAL_SHRINK)");
275 if ((ftruncate (r->fd, r->region_size)) == -1)
276 return clib_error_return_unix (0, "ftruncate");
278 if ((r->shm = mmap (NULL, r->region_size, PROT_READ | PROT_WRITE,
279 MAP_SHARED, r->fd, 0)) == MAP_FAILED)
280 return clib_error_return_unix (0, "mmap");
282 for (i = 0; i < mif->run.num_s2m_rings; i++)
284 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
285 ring->head = ring->tail = 0;
286 ring->cookie = MEMIF_COOKIE;
287 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
289 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
290 ring->desc[j].region = 0;
291 ring->desc[j].offset =
292 buffer_offset + (u32) (slot * mif->run.buffer_size);
293 ring->desc[j].buffer_length = mif->run.buffer_size;
296 for (i = 0; i < mif->run.num_m2s_rings; i++)
298 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
299 ring->head = ring->tail = 0;
300 ring->cookie = MEMIF_COOKIE;
301 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
304 (i + mif->run.num_s2m_rings) * (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;
312 ASSERT (mif->tx_queues == 0);
313 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
314 CLIB_CACHE_LINE_BYTES);
315 vec_foreach_index (i, mif->tx_queues)
317 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
318 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
319 return clib_error_return_unix (0, "eventfd[tx queue %u]", i);
320 mq->int_unix_file_index = ~0;
321 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
322 mq->log2_ring_size = mif->cfg.log2_ring_size;
324 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
328 ASSERT (mif->rx_queues == 0);
329 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
330 CLIB_CACHE_LINE_BYTES);
331 vec_foreach_index (i, mif->rx_queues)
333 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
334 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
335 return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
336 mq->int_unix_file_index = ~0;
337 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
338 mq->log2_ring_size = mif->cfg.log2_ring_size;
340 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
348 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
350 memif_main_t *mm = &memif_main;
352 struct sockaddr_un sun;
354 uword *event_data = 0, event_type;
356 f64 start_time, last_run_duration = 0, now;
358 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
361 DBG_UNIX_LOG ("socket AF_UNIX");
364 sun.sun_family = AF_UNIX;
369 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
372 vlib_process_wait_for_event (vm);
374 event_type = vlib_process_get_events (vm, &event_data);
375 vec_reset_length (event_data);
381 case MEMIF_PROCESS_EVENT_START:
384 case MEMIF_PROCESS_EVENT_STOP:
391 last_run_duration = start_time = vlib_time_now (vm);
393 pool_foreach (mif, mm->interfaces,
395 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
396 /* Allow no more than 10us without a pause */
397 now = vlib_time_now (vm);
398 if (now > start_time + 10e-6)
400 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
401 start_time = vlib_time_now (vm);
404 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
407 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
410 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
413 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
415 strncpy (sun.sun_path, (char *) msf->filename,
416 sizeof (sun.sun_path) - 1);
419 (sockfd, (struct sockaddr *) &sun,
420 sizeof (struct sockaddr_un)) == 0)
422 unix_file_t t = { 0 };
424 mif->conn_fd = sockfd;
425 t.read_function = memif_slave_conn_fd_read_ready;
426 t.write_function = memif_slave_conn_fd_write_ready;
427 t.error_function = memif_slave_conn_fd_error;
428 t.file_descriptor = mif->conn_fd;
429 t.private_data = mif->dev_instance;
430 memif_file_add (&mif->conn_unix_file_index, &t);
431 hash_set (msf->dev_instance_by_fd, mif->conn_fd, mif->dev_instance);
433 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
435 /* grab another fd */
436 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
439 DBG_UNIX_LOG ("socket AF_UNIX");
446 last_run_duration = vlib_time_now (vm) - last_run_duration;
452 VLIB_REGISTER_NODE (memif_process_node,static) = {
453 .function = memif_process,
454 .type = VLIB_NODE_TYPE_PROCESS,
455 .name = "memif-process",
460 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
462 vnet_main_t *vnm = vnet_get_main ();
463 memif_main_t *mm = &memif_main;
464 memif_socket_file_t *msf =
465 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
468 mif->flags |= MEMIF_IF_FLAG_DELETING;
469 vec_free (mif->local_disc_string);
470 vec_free (mif->remote_disc_string);
472 /* bring down the interface */
473 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
474 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
476 err = clib_error_return (0, "interface deleted");
477 memif_disconnect (mif, err);
478 clib_error_free (err);
480 /* remove the interface */
481 ethernet_delete_interface (vnm, mif->hw_if_index);
482 mif->hw_if_index = ~0;
484 /* free interface data structures */
485 clib_spinlock_free (&mif->lockp);
486 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
488 /* remove socket file */
489 if (--(msf->ref_cnt) == 0)
491 if (msf->is_listener)
494 memif_file_del_by_index (msf->unix_file_index);
495 vec_foreach (x, msf->pending_file_indices)
497 memif_file_del_by_index (*x);
499 vec_free (msf->pending_file_indices);
501 mhash_free (&msf->dev_instance_by_id);
502 hash_free (msf->dev_instance_by_fd);
503 mhash_unset (&mm->socket_file_index_by_filename, msf->filename, 0);
504 vec_free (msf->filename);
505 pool_put (mm->socket_files, msf);
508 memset (mif, 0, sizeof (*mif));
509 pool_put (mm->interfaces, mif);
511 if (pool_elts (mm->interfaces) == 0)
512 vlib_process_signal_event (vm, memif_process_node.index,
513 MEMIF_PROCESS_EVENT_STOP, 0);
519 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
521 memif_main_t *mm = &memif_main;
522 vlib_thread_main_t *tm = vlib_get_thread_main ();
523 vnet_main_t *vnm = vnet_get_main ();
525 vnet_sw_interface_t *sw;
526 clib_error_t *error = 0;
529 vnet_hw_interface_t *hw;
530 memif_socket_file_t *msf = 0;
534 if (args->socket_filename == 0 || args->socket_filename[0] != '/')
536 rv = mkdir (MEMIF_DEFAULT_SOCKET_DIR, 0755);
537 if (rv && errno != EEXIST)
538 return VNET_API_ERROR_SYSCALL_ERROR_1;
540 if (args->socket_filename == 0)
541 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
542 MEMIF_DEFAULT_SOCKET_FILENAME, 0);
544 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
545 args->socket_filename, 0);
549 socket_filename = vec_dup (args->socket_filename);
551 p = mhash_get (&mm->socket_file_index_by_filename, socket_filename);
555 msf = vec_elt_at_index (mm->socket_files, p[0]);
557 /* existing socket file can be either master or slave but cannot be both */
558 if (!msf->is_listener != !args->is_master)
560 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
564 p = mhash_get (&msf->dev_instance_by_id, &args->id);
567 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
572 /* Create new socket file */
575 struct stat file_stat;
576 /* If we are creating listener make sure file doesn't exist or if it
577 * exists thn delete it if it is old socket file */
578 if (args->is_master &&
579 (stat ((char *) socket_filename, &file_stat) == 0))
581 if (S_ISSOCK (file_stat.st_mode))
583 unlink ((char *) socket_filename);
587 ret = VNET_API_ERROR_SYSCALL_ERROR_3;
591 pool_get (mm->socket_files, msf);
592 memset (msf, 0, sizeof (memif_socket_file_t));
593 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
594 sizeof (memif_interface_id_t));
595 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
596 msf->filename = socket_filename;
598 msf->is_listener = (args->is_master != 0);
600 mhash_set (&mm->socket_file_index_by_filename, msf->filename,
601 msf - mm->socket_files, 0);
602 DBG ("creating socket file %s", msf->filename);
605 pool_get (mm->interfaces, mif);
606 memset (mif, 0, sizeof (*mif));
607 mif->dev_instance = mif - mm->interfaces;
608 mif->socket_file_index = msf - mm->socket_files;
610 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
611 mif->conn_unix_file_index = ~0;
614 mif->secret = vec_dup (args->secret);
616 if (tm->n_vlib_mains > 1)
617 clib_spinlock_init (&mif->lockp);
619 if (!args->hw_addr_set)
621 f64 now = vlib_time_now (vm);
623 rnd = (u32) (now * 1e6);
624 rnd = random_u32 (&rnd);
626 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
627 args->hw_addr[0] = 2;
628 args->hw_addr[1] = 0xfe;
631 error = ethernet_register_interface (vnm, memif_device_class.index,
632 mif->dev_instance, args->hw_addr,
634 memif_eth_flag_change);
638 clib_error_report (error);
639 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
643 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
644 mif->sw_if_index = sw->sw_if_index;
646 mif->cfg.log2_ring_size = args->log2_ring_size;
647 mif->cfg.buffer_size = args->buffer_size;
648 mif->cfg.num_s2m_rings =
649 args->is_master ? args->rx_queues : args->tx_queues;
650 mif->cfg.num_m2s_rings =
651 args->is_master ? args->tx_queues : args->rx_queues;
653 args->sw_if_index = mif->sw_if_index;
655 /* If this is new one, start listening */
656 if (msf->is_listener && msf->ref_cnt == 0)
658 struct sockaddr_un un = { 0 };
659 struct stat file_stat;
662 if ((msf->fd = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
664 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
668 un.sun_family = AF_UNIX;
669 strncpy ((char *) un.sun_path, (char *) msf->filename,
670 sizeof (un.sun_path) - 1);
672 if (setsockopt (msf->fd, SOL_SOCKET, SO_PASSCRED, &on, sizeof (on)) < 0)
674 ret = VNET_API_ERROR_SYSCALL_ERROR_5;
677 if (bind (msf->fd, (struct sockaddr *) &un, sizeof (un)) == -1)
679 ret = VNET_API_ERROR_SYSCALL_ERROR_6;
682 if (listen (msf->fd, 1) == -1)
684 ret = VNET_API_ERROR_SYSCALL_ERROR_7;
688 if (stat ((char *) msf->filename, &file_stat) == -1)
690 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
694 msf->unix_file_index = ~0;
695 unix_file_t template = { 0 };
696 template.read_function = memif_conn_fd_accept_ready;
697 template.file_descriptor = msf->fd;
698 template.private_data = mif->socket_file_index;
699 memif_file_add (&msf->unix_file_index, &template);
704 if (args->is_master == 0)
705 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
707 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
708 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
709 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
710 memif_input_node.index);
712 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
714 if (pool_elts (mm->interfaces) == 1)
716 vlib_process_signal_event (vm, memif_process_node.index,
717 MEMIF_PROCESS_EVENT_START, 0);
722 if (mif->hw_if_index != ~0)
724 ethernet_delete_interface (vnm, mif->hw_if_index);
725 mif->hw_if_index = ~0;
727 memif_delete_if (vm, mif);
731 vec_free (socket_filename);
736 static clib_error_t *
737 memif_init (vlib_main_t * vm)
739 memif_main_t *mm = &memif_main;
740 vlib_thread_main_t *tm = vlib_get_thread_main ();
742 memset (mm, 0, sizeof (memif_main_t));
744 /* initialize binary API */
745 memif_plugin_api_hookup (vm);
747 mhash_init_c_string (&mm->socket_file_index_by_filename, sizeof (uword));
749 vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
750 CLIB_CACHE_LINE_BYTES);
755 VLIB_INIT_FUNCTION (memif_init);
758 VLIB_PLUGIN_REGISTER () = {
759 .version = VPP_BUILD_VER,
760 .description = "Packet Memory Interface (experimetal)",
765 * fd.io coding-style-patch-verification: ON
768 * eval: (c-set-style "gnu")