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 memif_log_debug (mif, "disconnect %u (%v)", mif->dev_instance,
86 mif->local_disc_string = vec_dup (err->what);
87 if (mif->sock && clib_socket_is_connected (mif->sock))
88 e = memif_msg_send_disconnect (mif, err);
92 /* set interface down */
93 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
94 if (mif->hw_if_index != ~0)
95 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
97 /* close connection socket */
98 if (mif->sock && mif->sock->fd)
100 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
101 mif->socket_file_index);
102 hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
103 memif_socket_close (&mif->sock);
108 err = clib_socket_close (mif->sock);
111 memif_log_err (mif, "%U", format_clib_error, err);
112 clib_error_free (err);
114 clib_mem_free (mif->sock);
118 vec_foreach_index (i, mif->rx_queues)
120 mq = vec_elt_at_index (mif->rx_queues, i);
124 rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
127 "Unable to unassign interface %d, queue %d: rc=%d",
128 mif->hw_if_index, i, rv);
133 /* free tx and rx queues */
134 vec_foreach (mq, mif->rx_queues)
135 memif_queue_intfd_close (mq);
136 vec_free (mif->rx_queues);
138 vec_foreach (mq, mif->tx_queues)
139 memif_queue_intfd_close (mq);
140 vec_free (mif->tx_queues);
142 /* free memory regions */
143 vec_foreach (mr, mif->regions)
148 if ((rv = munmap (mr->shm, mr->region_size)))
149 memif_log_err (mif, "munmap failed, rv = %d", rv);
154 vec_free (mif->regions);
155 vec_free (mif->remote_name);
156 vec_free (mif->remote_if_name);
157 clib_fifo_free (mif->msg_queue);
160 static clib_error_t *
161 memif_int_fd_read_ready (clib_file_t * uf)
163 memif_main_t *mm = &memif_main;
164 vnet_main_t *vnm = vnet_get_main ();
165 u16 qid = uf->private_data & 0xFFFF;
166 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
167 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
171 size = read (uf->file_descriptor, &b, sizeof (b));
174 memif_log_debug (mif, "Failed to read form socket");
178 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
186 memif_connect (memif_if_t * mif)
188 vlib_main_t *vm = vlib_get_main ();
189 vnet_main_t *vnm = vnet_get_main ();
190 clib_file_t template = { 0 };
193 clib_error_t *err = NULL;
195 memif_log_debug (mif, "connect %u", mif->dev_instance);
197 vec_free (mif->local_disc_string);
198 vec_free (mif->remote_disc_string);
201 vec_foreach (mr, mif->regions)
208 err = clib_error_return (0, "no memory region fd");
212 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
213 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
215 err = clib_error_return_unix (0, "mmap");
221 template.read_function = memif_int_fd_read_ready;
224 vec_foreach_index (i, mif->tx_queues)
226 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
228 mq->ring = mif->regions[mq->region].shm + mq->offset;
229 if (mq->ring->cookie != MEMIF_COOKIE)
231 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
236 vec_foreach_index (i, mif->rx_queues)
238 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
242 mq->ring = mif->regions[mq->region].shm + mq->offset;
243 if (mq->ring->cookie != MEMIF_COOKIE)
245 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
251 template.file_descriptor = mq->int_fd;
252 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
253 template.description = format (0, "%U rx %u int",
254 format_memif_device_name,
255 mif->dev_instance, i);
256 memif_file_add (&mq->int_clib_file_index, &template);
258 vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
259 ti = vnet_get_device_input_thread_index (vnm, mif->hw_if_index, i);
260 mq->buffer_pool_index =
261 vlib_buffer_pool_get_default_for_numa (vm, vlib_mains[ti]->numa_node);
262 rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
263 VNET_HW_INTERFACE_RX_MODE_DEFAULT);
266 (mif, "Warning: unable to set rx mode for interface %d queue %d: "
267 "rc=%d", mif->hw_if_index, i, rv);
270 vnet_hw_interface_rx_mode rxmode;
271 vnet_hw_interface_get_rx_mode (vnm, mif->hw_if_index, i, &rxmode);
273 if (rxmode == VNET_HW_INTERFACE_RX_MODE_POLLING)
274 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
276 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, i);
281 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
282 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
284 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
285 VNET_HW_INTERFACE_FLAG_LINK_UP);
289 memif_log_err (mif, "%U", format_clib_error, err);
293 static_always_inline memif_ring_t *
294 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
296 if (vec_len (mif->regions) == 0)
298 void *p = mif->regions[0].shm;
300 sizeof (memif_ring_t) +
301 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
302 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
304 return (memif_ring_t *) p;
308 memif_init_regions_and_queues (memif_if_t * mif)
310 vlib_main_t *vm = vlib_get_main ();
311 memif_ring_t *ring = NULL;
315 clib_mem_vm_alloc_t alloc = { 0 };
318 ASSERT (vec_len (mif->regions) == 0);
319 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
321 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
322 (sizeof (memif_ring_t) +
323 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
325 r->region_size = buffer_offset;
327 if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
328 r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
329 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
331 alloc.name = "memif region";
332 alloc.size = r->region_size;
333 alloc.flags = CLIB_MEM_VM_F_SHARED;
335 err = clib_mem_vm_ext_alloc (&alloc);
342 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
344 vlib_buffer_pool_t *bp;
346 vec_foreach (bp, vm->buffer_main->buffer_pools)
348 vlib_physmem_map_t *pm;
349 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
350 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
352 r->region_size = pm->n_pages << pm->log2_page_size;
359 for (i = 0; i < mif->run.num_s2m_rings; i++)
361 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
362 ring->head = ring->tail = 0;
363 ring->cookie = MEMIF_COOKIE;
365 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
368 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
370 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
371 ring->desc[j].region = 0;
372 ring->desc[j].offset =
373 buffer_offset + (u32) (slot * mif->run.buffer_size);
374 ring->desc[j].length = mif->run.buffer_size;
377 for (i = 0; i < mif->run.num_m2s_rings; i++)
379 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
380 ring->head = ring->tail = 0;
381 ring->cookie = MEMIF_COOKIE;
383 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
386 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
389 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
390 ring->desc[j].region = 0;
391 ring->desc[j].offset =
392 buffer_offset + (u32) (slot * mif->run.buffer_size);
393 ring->desc[j].length = mif->run.buffer_size;
397 ASSERT (mif->tx_queues == 0);
398 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
399 CLIB_CACHE_LINE_BYTES);
402 vec_foreach_index (i, mif->tx_queues)
404 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
405 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
407 err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
410 mq->int_clib_file_index = ~0;
411 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
412 mq->log2_ring_size = mif->cfg.log2_ring_size;
414 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
416 mq->type = MEMIF_RING_S2M;
417 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
418 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
419 CLIB_CACHE_LINE_BYTES);
423 ASSERT (mif->rx_queues == 0);
424 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
425 CLIB_CACHE_LINE_BYTES);
428 vec_foreach_index (i, mif->rx_queues)
430 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
431 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
433 err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
436 mq->int_clib_file_index = ~0;
437 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
438 mq->log2_ring_size = mif->cfg.log2_ring_size;
440 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
442 mq->type = MEMIF_RING_M2S;
443 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
444 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
445 CLIB_CACHE_LINE_BYTES);
452 memif_log_err (mif, "%U", format_clib_error, err);
457 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
459 memif_main_t *mm = &memif_main;
462 uword *event_data = 0, event_type;
464 f64 start_time, last_run_duration = 0, now;
467 sock = clib_mem_alloc (sizeof (clib_socket_t));
468 clib_memset (sock, 0, sizeof (clib_socket_t));
473 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
476 vlib_process_wait_for_event (vm);
478 event_type = vlib_process_get_events (vm, &event_data);
479 vec_reset_length (event_data);
485 case MEMIF_PROCESS_EVENT_START:
488 case MEMIF_PROCESS_EVENT_STOP:
495 last_run_duration = start_time = vlib_time_now (vm);
497 pool_foreach (mif, mm->interfaces,
499 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
500 /* Allow no more than 10us without a pause */
501 now = vlib_time_now (vm);
502 if (now > start_time + 10e-6)
504 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
505 start_time = vlib_time_now (vm);
508 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
511 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
514 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
517 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
519 clib_memset (sock, 0, sizeof(clib_socket_t));
520 sock->config = (char *) msf->filename;
521 sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
523 if ((err = clib_socket_init (sock)))
525 clib_error_free (err);
529 clib_file_t t = { 0 };
531 t.read_function = memif_slave_conn_fd_read_ready;
532 t.write_function = memif_slave_conn_fd_write_ready;
533 t.error_function = memif_slave_conn_fd_error;
534 t.file_descriptor = sock->fd;
535 t.private_data = mif->dev_instance;
536 memif_file_add (&sock->private_data, &t);
537 t.description = format (0, "%U ctl",
538 format_memif_device_name,
540 hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
542 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
544 sock = clib_mem_alloc (sizeof(clib_socket_t));
549 last_run_duration = vlib_time_now (vm) - last_run_duration;
555 VLIB_REGISTER_NODE (memif_process_node,static) = {
556 .function = memif_process,
557 .type = VLIB_NODE_TYPE_PROCESS,
558 .name = "memif-process",
563 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
565 memif_main_t *mm = &memif_main;
567 memif_socket_file_t *msf;
569 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
572 msf = pool_elt_at_index (mm->socket_files, *p);
573 if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
575 /* Silently accept identical "add". */
579 /* But don't allow a direct add of a different filename. */
580 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
583 pool_get (mm->socket_files, msf);
584 clib_memset (msf, 0, sizeof (memif_socket_file_t));
586 msf->filename = socket_filename;
587 msf->socket_id = sock_id;
589 hash_set (mm->socket_file_index_by_sock_id, sock_id,
590 msf - mm->socket_files);
596 memif_delete_socket_file (u32 sock_id)
598 memif_main_t *mm = &memif_main;
600 memif_socket_file_t *msf;
602 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
605 /* Don't delete non-existent entries. */
606 return VNET_API_ERROR_INVALID_ARGUMENT;
609 msf = pool_elt_at_index (mm->socket_files, *p);
610 if (msf->ref_cnt > 0)
612 return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
615 vec_free (msf->filename);
616 pool_put (mm->socket_files, msf);
618 hash_unset (mm->socket_file_index_by_sock_id, sock_id);
624 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
629 /* allow adding socket id 0 */
630 if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
632 return VNET_API_ERROR_INVALID_ARGUMENT;
637 return memif_delete_socket_file (sock_id);
640 if (sock_filename == 0 || sock_filename[0] == 0)
642 return VNET_API_ERROR_INVALID_ARGUMENT;
645 if (sock_filename[0] != '/')
649 /* copy runtime dir path */
650 vec_add (dir, vlib_unix_get_runtime_dir (),
651 strlen (vlib_unix_get_runtime_dir ()));
654 /* if sock_filename contains dirs, add them to path */
655 tmp = strrchr ((char *) sock_filename, '/');
658 idx = tmp - (char *) sock_filename;
659 vec_add (dir, sock_filename, idx);
662 vec_add1 (dir, '\0');
663 /* create socket dir */
664 error = vlib_unix_recursive_mkdir (dir);
667 clib_error_free (error);
668 return VNET_API_ERROR_SYSCALL_ERROR_1;
671 sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
676 sock_filename = vec_dup (sock_filename);
678 /* check if directory exists */
679 tmp = strrchr ((char *) sock_filename, '/');
682 idx = tmp - (char *) sock_filename;
683 vec_add (dir, sock_filename, idx);
684 vec_add1 (dir, '\0');
687 /* check dir existance and access rights for effective user/group IDs */
690 (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
694 return VNET_API_ERROR_INVALID_ARGUMENT;
699 return memif_add_socket_file (sock_id, sock_filename);
703 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
705 vnet_main_t *vnm = vnet_get_main ();
706 memif_main_t *mm = &memif_main;
707 memif_socket_file_t *msf =
708 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
711 mif->flags |= MEMIF_IF_FLAG_DELETING;
712 vec_free (mif->local_disc_string);
713 vec_free (mif->remote_disc_string);
715 /* bring down the interface */
716 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
717 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
719 err = clib_error_return (0, "interface deleted");
720 memif_disconnect (mif, err);
721 clib_error_free (err);
723 if (mif->hw_if_index != ~0)
725 /* remove the interface */
726 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
727 vnet_delete_hw_interface (vnm, mif->hw_if_index);
729 ethernet_delete_interface (vnm, mif->hw_if_index);
730 mif->hw_if_index = ~0;
733 /* free interface data structures */
734 clib_spinlock_free (&mif->lockp);
735 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
737 /* remove socket file */
738 if (--(msf->ref_cnt) == 0)
740 if (msf->is_listener)
744 vec_foreach_index (i, msf->pending_clients)
745 memif_socket_close (msf->pending_clients + i);
747 memif_socket_close (&msf->sock);
748 vec_free (msf->pending_clients);
750 mhash_free (&msf->dev_instance_by_id);
751 hash_free (msf->dev_instance_by_fd);
754 err = clib_socket_close (msf->sock);
757 memif_log_err (mif, "%U", format_clib_error, err);
758 clib_error_free (err);
760 clib_mem_free (msf->sock);
764 clib_memset (mif, 0, sizeof (*mif));
765 pool_put (mm->interfaces, mif);
767 if (pool_elts (mm->interfaces) == 0)
768 vlib_process_signal_event (vm, memif_process_node.index,
769 MEMIF_PROCESS_EVENT_STOP, 0);
775 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
778 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
783 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
785 memif_main_t *mm = &memif_main;
786 vlib_thread_main_t *tm = vlib_get_thread_main ();
787 vnet_main_t *vnm = vnet_get_main ();
789 vnet_sw_interface_t *sw;
790 clib_error_t *error = 0;
793 vnet_hw_interface_t *hw;
794 memif_socket_file_t *msf = 0;
797 p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
800 rv = VNET_API_ERROR_INVALID_ARGUMENT;
804 msf = vec_elt_at_index (mm->socket_files, p[0]);
806 /* existing socket file can be either master or slave but cannot be both */
807 if (msf->ref_cnt > 0)
809 if ((!msf->is_listener != !args->is_master))
811 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
815 p = mhash_get (&msf->dev_instance_by_id, &args->id);
818 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
823 /* Create new socket file */
824 if (msf->ref_cnt == 0)
826 struct stat file_stat;
828 /* If we are creating listener make sure file doesn't exist or if it
829 * exists thn delete it if it is old socket file */
830 if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
832 if (S_ISSOCK (file_stat.st_mode))
834 unlink ((char *) msf->filename);
838 error = clib_error_return (0, "File exists for %s",
840 rv = VNET_API_ERROR_VALUE_EXIST;
845 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
846 sizeof (memif_interface_id_t));
847 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
848 msf->is_listener = (args->is_master != 0);
850 memif_log_debug (0, "initializing socket file %s", msf->filename);
853 if (mm->per_thread_data == 0)
857 vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
858 CLIB_CACHE_LINE_BYTES);
860 for (i = 0; i < tm->n_vlib_mains; i++)
862 memif_per_thread_data_t *ptd =
863 vec_elt_at_index (mm->per_thread_data, i);
864 vlib_buffer_t *bt = &ptd->buffer_template;
865 clib_memset (bt, 0, sizeof (vlib_buffer_t));
866 bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
867 bt->total_length_not_including_first_buffer = 0;
868 vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
870 /* initially prealloc copy_ops so we can use
871 _vec_len instead of vec_elen */
872 vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
873 vec_reset_length (ptd->copy_ops);
874 vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
875 vec_reset_length (ptd->buffers);
879 pool_get (mm->interfaces, mif);
880 clib_memset (mif, 0, sizeof (*mif));
881 mif->dev_instance = mif - mm->interfaces;
882 mif->socket_file_index = msf - mm->socket_files;
884 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
885 mif->mode = args->mode;
887 mif->secret = vec_dup (args->secret);
889 if (tm->n_vlib_mains > 1)
890 clib_spinlock_init (&mif->lockp);
892 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
895 if (!args->hw_addr_set)
897 f64 now = vlib_time_now (vm);
899 rnd = (u32) (now * 1e6);
900 rnd = random_u32 (&rnd);
902 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
903 args->hw_addr[0] = 2;
904 args->hw_addr[1] = 0xfe;
906 error = ethernet_register_interface (vnm, memif_device_class.index,
907 mif->dev_instance, args->hw_addr,
909 memif_eth_flag_change);
911 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
914 vnet_register_interface (vnm, memif_device_class.index,
916 memif_ip_hw_if_class.index,
920 error = clib_error_return (0, "unsupported interface mode");
924 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
928 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
929 mif->sw_if_index = sw->sw_if_index;
931 mif->cfg.log2_ring_size = args->log2_ring_size;
932 mif->cfg.buffer_size = args->buffer_size;
933 mif->cfg.num_s2m_rings =
934 args->is_master ? args->rx_queues : args->tx_queues;
935 mif->cfg.num_m2s_rings =
936 args->is_master ? args->tx_queues : args->rx_queues;
938 args->sw_if_index = mif->sw_if_index;
940 /* If this is new one, start listening */
941 if (msf->is_listener && msf->ref_cnt == 0)
943 struct stat file_stat;
944 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
946 ASSERT (msf->sock == 0);
949 clib_memset (s, 0, sizeof (clib_socket_t));
950 s->config = (char *) msf->filename;
951 s->flags = CLIB_SOCKET_F_IS_SERVER |
952 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
953 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
955 if ((error = clib_socket_init (s)))
957 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
961 if (stat ((char *) msf->filename, &file_stat) == -1)
963 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
967 clib_file_t template = { 0 };
968 template.read_function = memif_conn_fd_accept_ready;
969 template.file_descriptor = msf->sock->fd;
970 template.private_data = mif->socket_file_index;
971 template.description = format (0, "memif listener %s", msf->filename);
972 memif_file_add (&msf->sock->private_data, &template);
977 if (args->is_master == 0)
979 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
980 if (args->is_zero_copy)
981 mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
984 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
985 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
986 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
987 memif_input_node.index);
989 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
991 if (pool_elts (mm->interfaces) == 1)
993 vlib_process_signal_event (vm, memif_process_node.index,
994 MEMIF_PROCESS_EVENT_START, 0);
999 if (mif->hw_if_index != ~0)
1001 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1002 vnet_delete_hw_interface (vnm, mif->hw_if_index);
1004 ethernet_delete_interface (vnm, mif->hw_if_index);
1005 mif->hw_if_index = ~0;
1007 memif_delete_if (vm, mif);
1010 memif_log_err (mif, "%U", format_clib_error, error);
1011 clib_error_free (error);
1019 static clib_error_t *
1020 memif_init (vlib_main_t * vm)
1022 memif_main_t *mm = &memif_main;
1024 clib_memset (mm, 0, sizeof (memif_main_t));
1026 mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1027 memif_log_debug (0, "initialized");
1029 /* initialize binary API */
1030 memif_plugin_api_hookup (vm);
1033 * Pre-stuff socket filename pool with a non-modifieable mapping
1034 * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1035 * default run-time directory.
1037 memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1042 VLIB_INIT_FUNCTION (memif_init);
1045 VLIB_PLUGIN_REGISTER () = {
1046 .version = VPP_BUILD_VER,
1047 .description = "Packet Memory Interface (experimental)",
1052 * fd.io coding-style-patch-verification: ON
1055 * eval: (c-set-style "gnu")