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 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
233 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
235 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
236 VNET_HW_INTERFACE_FLAG_LINK_UP);
240 static_always_inline memif_ring_t *
241 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
243 if (vec_len (mif->regions) == 0)
245 void *p = mif->regions[0].shm;
247 sizeof (memif_ring_t) +
248 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
249 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
251 return (memif_ring_t *) p;
255 memif_init_regions_and_queues (memif_if_t * mif)
257 memif_ring_t *ring = NULL;
262 vec_validate_aligned (mif->regions, 0, CLIB_CACHE_LINE_BYTES);
263 r = vec_elt_at_index (mif->regions, 0);
265 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
266 (sizeof (memif_ring_t) +
267 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
269 r->region_size = buffer_offset +
270 mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
271 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
273 if ((r->fd = memfd_create ("memif region 0", MFD_ALLOW_SEALING)) == -1)
274 return clib_error_return_unix (0, "memfd_create");
276 if ((fcntl (r->fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
277 return clib_error_return_unix (0, "fcntl (F_ADD_SEALS, F_SEAL_SHRINK)");
279 if ((ftruncate (r->fd, r->region_size)) == -1)
280 return clib_error_return_unix (0, "ftruncate");
282 if ((r->shm = mmap (NULL, r->region_size, PROT_READ | PROT_WRITE,
283 MAP_SHARED, r->fd, 0)) == MAP_FAILED)
284 return clib_error_return_unix (0, "mmap");
286 for (i = 0; i < mif->run.num_s2m_rings; i++)
288 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
289 ring->head = ring->tail = 0;
290 ring->cookie = MEMIF_COOKIE;
291 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
293 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
294 ring->desc[j].region = 0;
295 ring->desc[j].offset =
296 buffer_offset + (u32) (slot * mif->run.buffer_size);
297 ring->desc[j].buffer_length = mif->run.buffer_size;
300 for (i = 0; i < mif->run.num_m2s_rings; i++)
302 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
303 ring->head = ring->tail = 0;
304 ring->cookie = MEMIF_COOKIE;
305 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
308 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
309 ring->desc[j].region = 0;
310 ring->desc[j].offset =
311 buffer_offset + (u32) (slot * mif->run.buffer_size);
312 ring->desc[j].buffer_length = mif->run.buffer_size;
316 ASSERT (mif->tx_queues == 0);
317 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
318 CLIB_CACHE_LINE_BYTES);
319 vec_foreach_index (i, mif->tx_queues)
321 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
322 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
323 return clib_error_return_unix (0, "eventfd[tx queue %u]", i);
324 mq->int_unix_file_index = ~0;
325 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
326 mq->log2_ring_size = mif->cfg.log2_ring_size;
328 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
332 ASSERT (mif->rx_queues == 0);
333 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
334 CLIB_CACHE_LINE_BYTES);
335 vec_foreach_index (i, mif->rx_queues)
337 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
338 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
339 return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
340 mq->int_unix_file_index = ~0;
341 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
342 mq->log2_ring_size = mif->cfg.log2_ring_size;
344 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
352 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
354 memif_main_t *mm = &memif_main;
356 struct sockaddr_un sun;
358 uword *event_data = 0, event_type;
360 f64 start_time, last_run_duration = 0, now;
362 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
365 DBG_UNIX_LOG ("socket AF_UNIX");
368 sun.sun_family = AF_UNIX;
373 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
376 vlib_process_wait_for_event (vm);
378 event_type = vlib_process_get_events (vm, &event_data);
379 vec_reset_length (event_data);
385 case MEMIF_PROCESS_EVENT_START:
388 case MEMIF_PROCESS_EVENT_STOP:
395 last_run_duration = start_time = vlib_time_now (vm);
397 pool_foreach (mif, mm->interfaces,
399 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
400 /* Allow no more than 10us without a pause */
401 now = vlib_time_now (vm);
402 if (now > start_time + 10e-6)
404 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
405 start_time = vlib_time_now (vm);
408 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
411 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
414 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
417 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
419 strncpy (sun.sun_path, (char *) msf->filename,
420 sizeof (sun.sun_path) - 1);
423 (sockfd, (struct sockaddr *) &sun,
424 sizeof (struct sockaddr_un)) == 0)
426 unix_file_t t = { 0 };
428 mif->conn_fd = sockfd;
429 t.read_function = memif_slave_conn_fd_read_ready;
430 t.write_function = memif_slave_conn_fd_write_ready;
431 t.error_function = memif_slave_conn_fd_error;
432 t.file_descriptor = mif->conn_fd;
433 t.private_data = mif->dev_instance;
434 memif_file_add (&mif->conn_unix_file_index, &t);
435 hash_set (msf->dev_instance_by_fd, mif->conn_fd, mif->dev_instance);
437 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
439 /* grab another fd */
440 sockfd = socket (AF_UNIX, SOCK_SEQPACKET, 0);
443 DBG_UNIX_LOG ("socket AF_UNIX");
450 last_run_duration = vlib_time_now (vm) - last_run_duration;
456 VLIB_REGISTER_NODE (memif_process_node,static) = {
457 .function = memif_process,
458 .type = VLIB_NODE_TYPE_PROCESS,
459 .name = "memif-process",
464 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
466 vnet_main_t *vnm = vnet_get_main ();
467 memif_main_t *mm = &memif_main;
468 memif_socket_file_t *msf =
469 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
472 mif->flags |= MEMIF_IF_FLAG_DELETING;
473 vec_free (mif->local_disc_string);
474 vec_free (mif->remote_disc_string);
476 /* bring down the interface */
477 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
478 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
480 err = clib_error_return (0, "interface deleted");
481 memif_disconnect (mif, err);
482 clib_error_free (err);
484 /* remove the interface */
485 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
486 vnet_delete_hw_interface (vnm, mif->hw_if_index);
488 ethernet_delete_interface (vnm, mif->hw_if_index);
489 mif->hw_if_index = ~0;
491 /* free interface data structures */
492 clib_spinlock_free (&mif->lockp);
493 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
495 /* remove socket file */
496 if (--(msf->ref_cnt) == 0)
498 if (msf->is_listener)
501 memif_file_del_by_index (msf->unix_file_index);
502 vec_foreach (x, msf->pending_file_indices)
504 memif_file_del_by_index (*x);
506 vec_free (msf->pending_file_indices);
508 mhash_free (&msf->dev_instance_by_id);
509 hash_free (msf->dev_instance_by_fd);
510 mhash_unset (&mm->socket_file_index_by_filename, msf->filename, 0);
511 vec_free (msf->filename);
512 pool_put (mm->socket_files, msf);
515 memset (mif, 0, sizeof (*mif));
516 pool_put (mm->interfaces, mif);
518 if (pool_elts (mm->interfaces) == 0)
519 vlib_process_signal_event (vm, memif_process_node.index,
520 MEMIF_PROCESS_EVENT_STOP, 0);
526 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
529 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
534 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
536 memif_main_t *mm = &memif_main;
537 vlib_thread_main_t *tm = vlib_get_thread_main ();
538 vnet_main_t *vnm = vnet_get_main ();
540 vnet_sw_interface_t *sw;
541 clib_error_t *error = 0;
544 vnet_hw_interface_t *hw;
545 memif_socket_file_t *msf = 0;
549 if (args->socket_filename == 0 || args->socket_filename[0] != '/')
551 rv = mkdir (MEMIF_DEFAULT_SOCKET_DIR, 0755);
552 if (rv && errno != EEXIST)
553 return VNET_API_ERROR_SYSCALL_ERROR_1;
555 if (args->socket_filename == 0)
556 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
557 MEMIF_DEFAULT_SOCKET_FILENAME, 0);
559 socket_filename = format (0, "%s/%s%c", MEMIF_DEFAULT_SOCKET_DIR,
560 args->socket_filename, 0);
564 socket_filename = vec_dup (args->socket_filename);
566 p = mhash_get (&mm->socket_file_index_by_filename, socket_filename);
570 msf = vec_elt_at_index (mm->socket_files, p[0]);
572 /* existing socket file can be either master or slave but cannot be both */
573 if (!msf->is_listener != !args->is_master)
575 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
579 p = mhash_get (&msf->dev_instance_by_id, &args->id);
582 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
587 /* Create new socket file */
590 struct stat file_stat;
591 /* If we are creating listener make sure file doesn't exist or if it
592 * exists thn delete it if it is old socket file */
593 if (args->is_master &&
594 (stat ((char *) socket_filename, &file_stat) == 0))
596 if (S_ISSOCK (file_stat.st_mode))
598 unlink ((char *) socket_filename);
602 ret = VNET_API_ERROR_SYSCALL_ERROR_3;
606 pool_get (mm->socket_files, msf);
607 memset (msf, 0, sizeof (memif_socket_file_t));
608 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
609 sizeof (memif_interface_id_t));
610 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
611 msf->filename = socket_filename;
613 msf->is_listener = (args->is_master != 0);
615 mhash_set (&mm->socket_file_index_by_filename, msf->filename,
616 msf - mm->socket_files, 0);
617 DBG ("creating socket file %s", msf->filename);
620 pool_get (mm->interfaces, mif);
621 memset (mif, 0, sizeof (*mif));
622 mif->dev_instance = mif - mm->interfaces;
623 mif->socket_file_index = msf - mm->socket_files;
625 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
626 mif->conn_unix_file_index = ~0;
628 mif->mode = args->mode;
630 mif->secret = vec_dup (args->secret);
632 if (tm->n_vlib_mains > 1)
633 clib_spinlock_init (&mif->lockp);
636 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
639 if (!args->hw_addr_set)
641 f64 now = vlib_time_now (vm);
643 rnd = (u32) (now * 1e6);
644 rnd = random_u32 (&rnd);
646 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
647 args->hw_addr[0] = 2;
648 args->hw_addr[1] = 0xfe;
650 error = ethernet_register_interface (vnm, memif_device_class.index,
651 mif->dev_instance, args->hw_addr,
653 memif_eth_flag_change);
655 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
658 vnet_register_interface (vnm, memif_device_class.index,
660 memif_ip_hw_if_class.index,
664 error = clib_error_return (0, "unsupported interface mode");
668 clib_error_report (error);
669 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
673 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
674 mif->sw_if_index = sw->sw_if_index;
676 mif->cfg.log2_ring_size = args->log2_ring_size;
677 mif->cfg.buffer_size = args->buffer_size;
678 mif->cfg.num_s2m_rings =
679 args->is_master ? args->rx_queues : args->tx_queues;
680 mif->cfg.num_m2s_rings =
681 args->is_master ? args->tx_queues : args->rx_queues;
683 args->sw_if_index = mif->sw_if_index;
685 /* If this is new one, start listening */
686 if (msf->is_listener && msf->ref_cnt == 0)
688 struct sockaddr_un un = { 0 };
689 struct stat file_stat;
692 if ((msf->fd = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
694 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
698 un.sun_family = AF_UNIX;
699 strncpy ((char *) un.sun_path, (char *) msf->filename,
700 sizeof (un.sun_path) - 1);
702 if (setsockopt (msf->fd, SOL_SOCKET, SO_PASSCRED, &on, sizeof (on)) < 0)
704 ret = VNET_API_ERROR_SYSCALL_ERROR_5;
707 if (bind (msf->fd, (struct sockaddr *) &un, sizeof (un)) == -1)
709 ret = VNET_API_ERROR_SYSCALL_ERROR_6;
712 if (listen (msf->fd, 1) == -1)
714 ret = VNET_API_ERROR_SYSCALL_ERROR_7;
718 if (stat ((char *) msf->filename, &file_stat) == -1)
720 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
724 msf->unix_file_index = ~0;
725 unix_file_t template = { 0 };
726 template.read_function = memif_conn_fd_accept_ready;
727 template.file_descriptor = msf->fd;
728 template.private_data = mif->socket_file_index;
729 memif_file_add (&msf->unix_file_index, &template);
734 if (args->is_master == 0)
735 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
737 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
738 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
739 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
740 memif_input_node.index);
742 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
744 if (pool_elts (mm->interfaces) == 1)
746 vlib_process_signal_event (vm, memif_process_node.index,
747 MEMIF_PROCESS_EVENT_START, 0);
752 if (mif->hw_if_index != ~0)
754 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
755 vnet_delete_hw_interface (vnm, mif->hw_if_index);
757 ethernet_delete_interface (vnm, mif->hw_if_index);
758 mif->hw_if_index = ~0;
760 memif_delete_if (vm, mif);
764 vec_free (socket_filename);
769 static clib_error_t *
770 memif_init (vlib_main_t * vm)
772 memif_main_t *mm = &memif_main;
773 vlib_thread_main_t *tm = vlib_get_thread_main ();
775 memset (mm, 0, sizeof (memif_main_t));
777 /* initialize binary API */
778 memif_plugin_api_hookup (vm);
780 mhash_init_c_string (&mm->socket_file_index_by_filename, sizeof (uword));
782 vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
783 CLIB_CACHE_LINE_BYTES);
788 VLIB_INIT_FUNCTION (memif_init);
791 VLIB_PLUGIN_REGISTER () = {
792 .version = VPP_BUILD_VER,
793 .description = "Packet Memory Interface (experimetal)",
798 * fd.io coding-style-patch-verification: ON
801 * eval: (c-set-style "gnu")