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_free_zc_queue_buffer (memif_queue_t * mq, u8 is_rx)
71 vlib_main_t *vm = vlib_get_main ();
72 u16 ring_size, n_slots, mask, start;
74 ring_size = 1 << mq->log2_ring_size;
76 n_slots = mq->ring->head - mq->last_tail;
77 start = mq->last_tail & mask;
79 vlib_buffer_free_from_ring (vm, mq->buffers, start, ring_size, n_slots);
81 vlib_buffer_free_from_ring_no_next (vm, mq->buffers, start, ring_size,
83 vec_free (mq->buffers);
87 memif_disconnect (memif_if_t * mif, clib_error_t * err)
89 memif_main_t *mm = &memif_main;
90 vnet_main_t *vnm = vnet_get_main ();
98 memif_log_debug (mif, "disconnect %u (%v)", mif->dev_instance,
104 mif->local_disc_string = vec_dup (err->what);
105 if (mif->sock && clib_socket_is_connected (mif->sock))
106 e = memif_msg_send_disconnect (mif, err);
110 /* set interface down */
111 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
112 if (mif->hw_if_index != ~0)
113 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
115 /* close connection socket */
116 if (mif->sock && mif->sock->fd)
118 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
119 mif->socket_file_index);
120 hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
121 memif_socket_close (&mif->sock);
126 err = clib_socket_close (mif->sock);
129 memif_log_err (mif, "%U", format_clib_error, err);
130 clib_error_free (err);
132 clib_mem_free (mif->sock);
136 vec_foreach_index (i, mif->rx_queues)
138 mq = vec_elt_at_index (mif->rx_queues, i);
142 rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
145 "Unable to unassign interface %d, queue %d: rc=%d",
146 mif->hw_if_index, i, rv);
147 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
149 memif_disconnect_free_zc_queue_buffer(mq, 1);
156 vec_foreach_index (i, mif->tx_queues)
158 mq = vec_elt_at_index (mif->tx_queues, i);
161 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
163 memif_disconnect_free_zc_queue_buffer(mq, 0);
169 /* free tx and rx queues */
170 vec_foreach (mq, mif->rx_queues)
171 memif_queue_intfd_close (mq);
172 vec_free (mif->rx_queues);
174 vec_foreach (mq, mif->tx_queues)
175 memif_queue_intfd_close (mq);
176 vec_free (mif->tx_queues);
178 /* free memory regions */
179 vec_foreach (mr, mif->regions)
184 if ((rv = munmap (mr->shm, mr->region_size)))
185 memif_log_err (mif, "munmap failed, rv = %d", rv);
190 vec_free (mif->regions);
191 vec_free (mif->remote_name);
192 vec_free (mif->remote_if_name);
193 clib_fifo_free (mif->msg_queue);
196 static clib_error_t *
197 memif_int_fd_read_ready (clib_file_t * uf)
199 memif_main_t *mm = &memif_main;
200 vnet_main_t *vnm = vnet_get_main ();
201 u16 qid = uf->private_data & 0xFFFF;
202 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
203 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
207 size = read (uf->file_descriptor, &b, sizeof (b));
210 memif_log_debug (mif, "Failed to read form socket");
214 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
222 memif_connect (memif_if_t * mif)
224 vlib_main_t *vm = vlib_get_main ();
225 vnet_main_t *vnm = vnet_get_main ();
226 clib_file_t template = { 0 };
229 clib_error_t *err = NULL;
231 memif_log_debug (mif, "connect %u", mif->dev_instance);
233 vec_free (mif->local_disc_string);
234 vec_free (mif->remote_disc_string);
237 vec_foreach (mr, mif->regions)
244 err = clib_error_return (0, "no memory region fd");
248 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
249 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
251 err = clib_error_return_unix (0, "mmap");
257 template.read_function = memif_int_fd_read_ready;
260 vec_foreach_index (i, mif->tx_queues)
262 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
264 mq->ring = mif->regions[mq->region].shm + mq->offset;
265 if (mq->ring->cookie != MEMIF_COOKIE)
267 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
272 vec_foreach_index (i, mif->rx_queues)
274 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
278 mq->ring = mif->regions[mq->region].shm + mq->offset;
279 if (mq->ring->cookie != MEMIF_COOKIE)
281 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
287 template.file_descriptor = mq->int_fd;
288 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
289 template.description = format (0, "%U rx %u int",
290 format_memif_device_name,
291 mif->dev_instance, i);
292 memif_file_add (&mq->int_clib_file_index, &template);
294 vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
295 ti = vnet_get_device_input_thread_index (vnm, mif->hw_if_index, i);
296 mq->buffer_pool_index =
297 vlib_buffer_pool_get_default_for_numa (vm, vlib_mains[ti]->numa_node);
298 rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
299 VNET_HW_IF_RX_MODE_DEFAULT);
302 (mif, "Warning: unable to set rx mode for interface %d queue %d: "
303 "rc=%d", mif->hw_if_index, i, rv);
306 vnet_hw_if_rx_mode rxmode;
307 vnet_hw_interface_get_rx_mode (vnm, mif->hw_if_index, i, &rxmode);
309 if (rxmode == VNET_HW_IF_RX_MODE_POLLING)
310 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
312 vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, i);
317 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
318 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
320 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
321 VNET_HW_INTERFACE_FLAG_LINK_UP);
325 memif_log_err (mif, "%U", format_clib_error, err);
329 static_always_inline memif_ring_t *
330 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
332 if (vec_len (mif->regions) == 0)
334 void *p = mif->regions[0].shm;
336 sizeof (memif_ring_t) +
337 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
338 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
340 return (memif_ring_t *) p;
344 memif_init_regions_and_queues (memif_if_t * mif)
346 vlib_main_t *vm = vlib_get_main ();
347 memif_socket_file_t *msf;
348 memif_ring_t *ring = NULL;
354 ASSERT (vec_len (mif->regions) == 0);
355 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
357 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
358 (sizeof (memif_ring_t) +
359 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
361 r->region_size = buffer_offset;
363 if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
364 r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
365 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
367 if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "%U region 0",
368 format_memif_device_name,
369 mif->dev_instance)) == -1)
371 err = clib_mem_get_last_error ();
375 if ((ftruncate (fd, r->region_size)) == -1)
377 err = clib_error_return_unix (0, "ftruncate");
381 msf = pool_elt_at_index (memif_main.socket_files, mif->socket_file_index);
382 r->shm = clib_mem_vm_map_shared (0, r->region_size, fd, 0, "memif%lu/%lu:0",
383 msf->socket_id, mif->id);
385 if (r->shm == CLIB_MEM_VM_MAP_FAILED)
387 err = clib_error_return_unix (0, "memif shared region map failed");
393 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
395 vlib_buffer_pool_t *bp;
397 vec_foreach (bp, vm->buffer_main->buffer_pools)
399 vlib_physmem_map_t *pm;
400 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
401 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
403 r->region_size = pm->n_pages << pm->log2_page_size;
410 for (i = 0; i < mif->run.num_s2m_rings; i++)
412 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
413 ring->head = ring->tail = 0;
414 ring->cookie = MEMIF_COOKIE;
416 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
419 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
421 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
422 ring->desc[j].region = 0;
423 ring->desc[j].offset =
424 buffer_offset + (u32) (slot * mif->run.buffer_size);
425 ring->desc[j].length = mif->run.buffer_size;
428 for (i = 0; i < mif->run.num_m2s_rings; i++)
430 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
431 ring->head = ring->tail = 0;
432 ring->cookie = MEMIF_COOKIE;
434 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
437 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
440 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
441 ring->desc[j].region = 0;
442 ring->desc[j].offset =
443 buffer_offset + (u32) (slot * mif->run.buffer_size);
444 ring->desc[j].length = mif->run.buffer_size;
448 ASSERT (mif->tx_queues == 0);
449 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
450 CLIB_CACHE_LINE_BYTES);
453 vec_foreach_index (i, mif->tx_queues)
455 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
456 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
458 err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
461 mq->int_clib_file_index = ~0;
462 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
463 mq->log2_ring_size = mif->cfg.log2_ring_size;
465 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
467 mq->type = MEMIF_RING_S2M;
468 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
469 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
470 CLIB_CACHE_LINE_BYTES);
474 ASSERT (mif->rx_queues == 0);
475 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
476 CLIB_CACHE_LINE_BYTES);
479 vec_foreach_index (i, mif->rx_queues)
481 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
482 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
484 err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
487 mq->int_clib_file_index = ~0;
488 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
489 mq->log2_ring_size = mif->cfg.log2_ring_size;
491 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
493 mq->type = MEMIF_RING_M2S;
494 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
495 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
496 CLIB_CACHE_LINE_BYTES);
503 memif_log_err (mif, "%U", format_clib_error, err);
508 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
510 memif_main_t *mm = &memif_main;
513 uword *event_data = 0, event_type;
515 f64 start_time, last_run_duration = 0, now;
518 sock = clib_mem_alloc (sizeof (clib_socket_t));
519 clib_memset (sock, 0, sizeof (clib_socket_t));
524 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
527 vlib_process_wait_for_event (vm);
529 event_type = vlib_process_get_events (vm, &event_data);
530 vec_reset_length (event_data);
536 case MEMIF_PROCESS_EVENT_START:
539 case MEMIF_PROCESS_EVENT_STOP:
546 last_run_duration = start_time = vlib_time_now (vm);
548 pool_foreach (mif, mm->interfaces,
550 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
551 /* Allow no more than 10us without a pause */
552 now = vlib_time_now (vm);
553 if (now > start_time + 10e-6)
555 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
556 start_time = vlib_time_now (vm);
559 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
562 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
565 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
568 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
570 clib_memset (sock, 0, sizeof(clib_socket_t));
571 sock->config = (char *) msf->filename;
572 sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
574 if ((err = clib_socket_init (sock)))
576 clib_error_free (err);
580 clib_file_t t = { 0 };
582 t.read_function = memif_slave_conn_fd_read_ready;
583 t.write_function = memif_slave_conn_fd_write_ready;
584 t.error_function = memif_slave_conn_fd_error;
585 t.file_descriptor = sock->fd;
586 t.private_data = mif->dev_instance;
587 memif_file_add (&sock->private_data, &t);
588 t.description = format (0, "%U ctl",
589 format_memif_device_name,
591 hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
593 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
595 sock = clib_mem_alloc (sizeof(clib_socket_t));
600 last_run_duration = vlib_time_now (vm) - last_run_duration;
606 VLIB_REGISTER_NODE (memif_process_node,static) = {
607 .function = memif_process,
608 .type = VLIB_NODE_TYPE_PROCESS,
609 .name = "memif-process",
614 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
616 memif_main_t *mm = &memif_main;
618 memif_socket_file_t *msf;
620 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
623 msf = pool_elt_at_index (mm->socket_files, *p);
624 if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
626 /* Silently accept identical "add". */
630 /* But don't allow a direct add of a different filename. */
631 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
634 pool_get (mm->socket_files, msf);
635 clib_memset (msf, 0, sizeof (memif_socket_file_t));
637 msf->filename = socket_filename;
638 msf->socket_id = sock_id;
640 hash_set (mm->socket_file_index_by_sock_id, sock_id,
641 msf - mm->socket_files);
647 memif_delete_socket_file (u32 sock_id)
649 memif_main_t *mm = &memif_main;
651 memif_socket_file_t *msf;
653 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
656 /* Don't delete non-existent entries. */
657 return VNET_API_ERROR_INVALID_ARGUMENT;
660 msf = pool_elt_at_index (mm->socket_files, *p);
661 if (msf->ref_cnt > 0)
663 return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
666 vec_free (msf->filename);
667 pool_put (mm->socket_files, msf);
669 hash_unset (mm->socket_file_index_by_sock_id, sock_id);
675 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
680 /* allow adding socket id 0 */
681 if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
683 return VNET_API_ERROR_INVALID_ARGUMENT;
688 return memif_delete_socket_file (sock_id);
691 if (sock_filename == 0 || sock_filename[0] == 0)
693 return VNET_API_ERROR_INVALID_ARGUMENT;
696 if (sock_filename[0] != '/')
700 /* copy runtime dir path */
701 vec_add (dir, vlib_unix_get_runtime_dir (),
702 strlen (vlib_unix_get_runtime_dir ()));
705 /* if sock_filename contains dirs, add them to path */
706 tmp = strrchr ((char *) sock_filename, '/');
709 idx = tmp - (char *) sock_filename;
710 vec_add (dir, sock_filename, idx);
713 vec_add1 (dir, '\0');
714 /* create socket dir */
715 error = vlib_unix_recursive_mkdir (dir);
718 clib_error_free (error);
719 return VNET_API_ERROR_SYSCALL_ERROR_1;
722 sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
727 sock_filename = vec_dup (sock_filename);
729 /* check if directory exists */
730 tmp = strrchr ((char *) sock_filename, '/');
733 idx = tmp - (char *) sock_filename;
734 vec_add (dir, sock_filename, idx);
735 vec_add1 (dir, '\0');
738 /* check dir existance and access rights for effective user/group IDs */
741 (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
745 return VNET_API_ERROR_INVALID_ARGUMENT;
750 return memif_add_socket_file (sock_id, sock_filename);
754 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
756 vnet_main_t *vnm = vnet_get_main ();
757 memif_main_t *mm = &memif_main;
758 memif_socket_file_t *msf =
759 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
762 mif->flags |= MEMIF_IF_FLAG_DELETING;
763 vec_free (mif->local_disc_string);
764 vec_free (mif->remote_disc_string);
766 /* bring down the interface */
767 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
768 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
770 err = clib_error_return (0, "interface deleted");
771 memif_disconnect (mif, err);
772 clib_error_free (err);
774 if (mif->hw_if_index != ~0)
776 /* remove the interface */
777 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
778 vnet_delete_hw_interface (vnm, mif->hw_if_index);
780 ethernet_delete_interface (vnm, mif->hw_if_index);
781 mif->hw_if_index = ~0;
784 /* free interface data structures */
785 clib_spinlock_free (&mif->lockp);
786 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
788 /* remove socket file */
789 if (--(msf->ref_cnt) == 0)
791 if (msf->is_listener)
795 vec_foreach_index (i, msf->pending_clients)
796 memif_socket_close (msf->pending_clients + i);
798 memif_socket_close (&msf->sock);
799 vec_free (msf->pending_clients);
801 mhash_free (&msf->dev_instance_by_id);
802 hash_free (msf->dev_instance_by_fd);
805 err = clib_socket_close (msf->sock);
808 memif_log_err (mif, "%U", format_clib_error, err);
809 clib_error_free (err);
811 clib_mem_free (msf->sock);
815 clib_memset (mif, 0, sizeof (*mif));
816 pool_put (mm->interfaces, mif);
818 if (pool_elts (mm->interfaces) == 0)
819 vlib_process_signal_event (vm, memif_process_node.index,
820 MEMIF_PROCESS_EVENT_STOP, 0);
826 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
829 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
834 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
836 memif_main_t *mm = &memif_main;
837 vlib_thread_main_t *tm = vlib_get_thread_main ();
838 vnet_main_t *vnm = vnet_get_main ();
840 vnet_sw_interface_t *sw;
841 clib_error_t *error = 0;
844 vnet_hw_interface_t *hw;
845 memif_socket_file_t *msf = 0;
848 p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
851 rv = VNET_API_ERROR_INVALID_ARGUMENT;
855 msf = vec_elt_at_index (mm->socket_files, p[0]);
857 /* existing socket file can be either master or slave but cannot be both */
858 if (msf->ref_cnt > 0)
860 if ((!msf->is_listener != !args->is_master))
862 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
866 p = mhash_get (&msf->dev_instance_by_id, &args->id);
869 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
874 /* Create new socket file */
875 if (msf->ref_cnt == 0)
877 struct stat file_stat;
879 /* If we are creating listener make sure file doesn't exist or if it
880 * exists thn delete it if it is old socket file */
881 if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
883 if (S_ISSOCK (file_stat.st_mode))
885 unlink ((char *) msf->filename);
889 error = clib_error_return (0, "File exists for %s",
891 rv = VNET_API_ERROR_VALUE_EXIST;
896 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
897 sizeof (memif_interface_id_t));
898 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
899 msf->is_listener = (args->is_master != 0);
901 memif_log_debug (0, "initializing socket file %s", msf->filename);
904 if (mm->per_thread_data == 0)
908 vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
909 CLIB_CACHE_LINE_BYTES);
911 for (i = 0; i < tm->n_vlib_mains; i++)
913 memif_per_thread_data_t *ptd =
914 vec_elt_at_index (mm->per_thread_data, i);
915 vlib_buffer_t *bt = &ptd->buffer_template;
916 clib_memset (bt, 0, sizeof (vlib_buffer_t));
917 bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
918 bt->total_length_not_including_first_buffer = 0;
919 vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
921 /* initially prealloc copy_ops so we can use
922 _vec_len instead of vec_elen */
923 vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
924 vec_reset_length (ptd->copy_ops);
925 vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
926 vec_reset_length (ptd->buffers);
930 pool_get (mm->interfaces, mif);
931 clib_memset (mif, 0, sizeof (*mif));
932 mif->dev_instance = mif - mm->interfaces;
933 mif->socket_file_index = msf - mm->socket_files;
935 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
936 mif->mode = args->mode;
938 mif->secret = vec_dup (args->secret);
940 if (tm->n_vlib_mains > 1)
941 clib_spinlock_init (&mif->lockp);
943 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
946 if (!args->hw_addr_set)
948 f64 now = vlib_time_now (vm);
950 rnd = (u32) (now * 1e6);
951 rnd = random_u32 (&rnd);
953 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
954 args->hw_addr[0] = 2;
955 args->hw_addr[1] = 0xfe;
957 error = ethernet_register_interface (vnm, memif_device_class.index,
958 mif->dev_instance, args->hw_addr,
960 memif_eth_flag_change);
962 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
965 vnet_register_interface (vnm, memif_device_class.index,
967 memif_ip_hw_if_class.index,
971 error = clib_error_return (0, "unsupported interface mode");
975 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
979 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
980 mif->sw_if_index = sw->sw_if_index;
982 mif->cfg.log2_ring_size = args->log2_ring_size;
983 mif->cfg.buffer_size = args->buffer_size;
984 mif->cfg.num_s2m_rings =
985 args->is_master ? args->rx_queues : args->tx_queues;
986 mif->cfg.num_m2s_rings =
987 args->is_master ? args->tx_queues : args->rx_queues;
989 args->sw_if_index = mif->sw_if_index;
991 /* If this is new one, start listening */
992 if (msf->is_listener && msf->ref_cnt == 0)
994 struct stat file_stat;
995 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
997 ASSERT (msf->sock == 0);
1000 clib_memset (s, 0, sizeof (clib_socket_t));
1001 s->config = (char *) msf->filename;
1002 s->flags = CLIB_SOCKET_F_IS_SERVER |
1003 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1004 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1006 if ((error = clib_socket_init (s)))
1008 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
1012 if (stat ((char *) msf->filename, &file_stat) == -1)
1014 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
1018 clib_file_t template = { 0 };
1019 template.read_function = memif_conn_fd_accept_ready;
1020 template.file_descriptor = msf->sock->fd;
1021 template.private_data = mif->socket_file_index;
1022 template.description = format (0, "memif listener %s", msf->filename);
1023 memif_file_add (&msf->sock->private_data, &template);
1028 if (args->is_master == 0)
1030 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
1031 if (args->is_zero_copy)
1032 mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
1035 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
1036 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1037 vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
1038 memif_input_node.index);
1040 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
1042 if (pool_elts (mm->interfaces) == 1)
1044 vlib_process_signal_event (vm, memif_process_node.index,
1045 MEMIF_PROCESS_EVENT_START, 0);
1050 if (mif->hw_if_index != ~0)
1052 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1053 vnet_delete_hw_interface (vnm, mif->hw_if_index);
1055 ethernet_delete_interface (vnm, mif->hw_if_index);
1056 mif->hw_if_index = ~0;
1058 memif_delete_if (vm, mif);
1061 memif_log_err (mif, "%U", format_clib_error, error);
1062 clib_error_free (error);
1070 static clib_error_t *
1071 memif_init (vlib_main_t * vm)
1073 memif_main_t *mm = &memif_main;
1075 clib_memset (mm, 0, sizeof (memif_main_t));
1077 mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1078 memif_log_debug (0, "initialized");
1080 /* initialize binary API */
1081 memif_plugin_api_hookup (vm);
1084 * Pre-stuff socket filename pool with a non-modifieable mapping
1085 * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1086 * default run-time directory.
1088 memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1093 VLIB_INIT_FUNCTION (memif_init);
1096 VLIB_PLUGIN_REGISTER () = {
1097 .version = VPP_BUILD_VER,
1098 .description = "Packet Memory Interface (memif) -- Experimental",
1103 * fd.io coding-style-patch-verification: ON
1106 * eval: (c-set-style "gnu")