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 <vnet/interface/rx_queue_funcs.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);
141 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
143 memif_disconnect_free_zc_queue_buffer(mq, 1);
148 vnet_hw_if_unregister_all_rx_queues (vnm, mif->hw_if_index);
149 vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
152 vec_foreach_index (i, mif->tx_queues)
154 mq = vec_elt_at_index (mif->tx_queues, i);
157 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
159 memif_disconnect_free_zc_queue_buffer(mq, 0);
165 /* free tx and rx queues */
166 vec_foreach (mq, mif->rx_queues)
167 memif_queue_intfd_close (mq);
168 vec_free (mif->rx_queues);
170 vec_foreach (mq, mif->tx_queues)
171 memif_queue_intfd_close (mq);
172 vec_free (mif->tx_queues);
174 /* free memory regions */
175 vec_foreach (mr, mif->regions)
180 if ((rv = munmap (mr->shm, mr->region_size)))
181 memif_log_err (mif, "munmap failed, rv = %d", rv);
186 vec_free (mif->regions);
187 vec_free (mif->remote_name);
188 vec_free (mif->remote_if_name);
189 clib_fifo_free (mif->msg_queue);
192 static clib_error_t *
193 memif_int_fd_write_ready (clib_file_t * uf)
195 memif_main_t *mm = &memif_main;
196 u16 qid = uf->private_data & 0xFFFF;
197 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
199 memif_log_warn (mif, "unexpected EPOLLOUT on RX for queue %u", qid);
203 static clib_error_t *
204 memif_int_fd_read_ready (clib_file_t * uf)
206 memif_main_t *mm = &memif_main;
207 vnet_main_t *vnm = vnet_get_main ();
208 u16 qid = uf->private_data & 0xFFFF;
209 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
210 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
214 size = read (uf->file_descriptor, &b, sizeof (b));
217 memif_log_debug (mif, "Failed to read from socket");
221 vnet_hw_if_rx_queue_set_int_pending (vnm, mq->queue_index);
229 memif_connect (memif_if_t * mif)
231 vlib_main_t *vm = vlib_get_main ();
232 vnet_main_t *vnm = vnet_get_main ();
233 clib_file_t template = { 0 };
236 clib_error_t *err = NULL;
238 memif_log_debug (mif, "connect %u", mif->dev_instance);
240 vec_free (mif->local_disc_string);
241 vec_free (mif->remote_disc_string);
244 vec_foreach (mr, mif->regions)
251 err = clib_error_return (0, "no memory region fd");
255 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
256 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
258 err = clib_error_return_unix (0, "mmap");
264 template.read_function = memif_int_fd_read_ready;
265 template.write_function = memif_int_fd_write_ready;
268 vec_foreach_index (i, mif->tx_queues)
270 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
272 mq->ring = mif->regions[mq->region].shm + mq->offset;
273 if (mq->ring->cookie != MEMIF_COOKIE)
275 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
280 vec_foreach_index (i, mif->rx_queues)
282 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
287 mq->ring = mif->regions[mq->region].shm + mq->offset;
288 if (mq->ring->cookie != MEMIF_COOKIE)
290 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
293 qi = vnet_hw_if_register_rx_queue (vnm, mif->hw_if_index, i,
294 VNET_HW_IF_RXQ_THREAD_ANY);
295 mq->queue_index = qi;
298 template.file_descriptor = mq->int_fd;
299 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
300 template.description = format (0, "%U rx %u int",
301 format_memif_device_name,
302 mif->dev_instance, i);
303 memif_file_add (&mq->int_clib_file_index, &template);
304 vnet_hw_if_set_rx_queue_file_index (vnm, qi,
305 mq->int_clib_file_index);
307 ti = vnet_hw_if_get_rx_queue_thread_index (vnm, qi);
308 mq->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
309 vm, vlib_get_main_by_index (ti)->numa_node);
310 rv = vnet_hw_if_set_rx_queue_mode (vnm, qi, VNET_HW_IF_RX_MODE_DEFAULT);
311 vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
315 (mif, "Warning: unable to set rx mode for interface %d queue %d: "
316 "rc=%d", mif->hw_if_index, i, rv);
319 vnet_hw_if_rx_mode rxmode = vnet_hw_if_get_rx_queue_mode (vnm, qi);
321 if (rxmode == VNET_HW_IF_RX_MODE_POLLING)
322 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
324 vnet_hw_if_rx_queue_set_int_pending (vnm, qi);
329 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
330 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
332 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
333 VNET_HW_INTERFACE_FLAG_LINK_UP);
337 memif_log_err (mif, "%U", format_clib_error, err);
341 static_always_inline memif_ring_t *
342 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
344 if (vec_len (mif->regions) == 0)
346 void *p = mif->regions[0].shm;
348 sizeof (memif_ring_t) +
349 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
350 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
352 return (memif_ring_t *) p;
356 memif_init_regions_and_queues (memif_if_t * mif)
358 vlib_main_t *vm = vlib_get_main ();
359 memif_socket_file_t *msf;
360 memif_ring_t *ring = NULL;
366 ASSERT (vec_len (mif->regions) == 0);
367 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
369 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
370 (sizeof (memif_ring_t) +
371 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
373 r->region_size = buffer_offset;
375 if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
376 r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
377 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
379 if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "%U region 0",
380 format_memif_device_name,
381 mif->dev_instance)) == -1)
383 err = clib_mem_get_last_error ();
387 if ((ftruncate (fd, r->region_size)) == -1)
389 err = clib_error_return_unix (0, "ftruncate");
393 msf = pool_elt_at_index (memif_main.socket_files, mif->socket_file_index);
394 r->shm = clib_mem_vm_map_shared (0, r->region_size, fd, 0, "memif%lu/%lu:0",
395 msf->socket_id, mif->id);
397 if (r->shm == CLIB_MEM_VM_MAP_FAILED)
399 err = clib_error_return_unix (0, "memif shared region map failed");
405 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
407 vlib_buffer_pool_t *bp;
409 vec_foreach (bp, vm->buffer_main->buffer_pools)
411 vlib_physmem_map_t *pm;
412 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
413 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
415 r->region_size = pm->n_pages << pm->log2_page_size;
422 for (i = 0; i < mif->run.num_s2m_rings; i++)
424 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
425 ring->head = ring->tail = 0;
426 ring->cookie = MEMIF_COOKIE;
428 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
431 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
433 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
434 ring->desc[j].region = 0;
435 ring->desc[j].offset =
436 buffer_offset + (u32) (slot * mif->run.buffer_size);
437 ring->desc[j].length = mif->run.buffer_size;
440 for (i = 0; i < mif->run.num_m2s_rings; i++)
442 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
443 ring->head = ring->tail = 0;
444 ring->cookie = MEMIF_COOKIE;
446 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
449 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
452 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
453 ring->desc[j].region = 0;
454 ring->desc[j].offset =
455 buffer_offset + (u32) (slot * mif->run.buffer_size);
456 ring->desc[j].length = mif->run.buffer_size;
460 ASSERT (mif->tx_queues == 0);
461 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
462 CLIB_CACHE_LINE_BYTES);
465 vec_foreach_index (i, mif->tx_queues)
467 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
468 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
470 err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
473 mq->int_clib_file_index = ~0;
474 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
475 mq->log2_ring_size = mif->cfg.log2_ring_size;
477 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
479 mq->type = MEMIF_RING_S2M;
480 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
481 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
482 CLIB_CACHE_LINE_BYTES);
486 ASSERT (mif->rx_queues == 0);
487 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
488 CLIB_CACHE_LINE_BYTES);
491 vec_foreach_index (i, mif->rx_queues)
493 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
494 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
496 err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
499 mq->int_clib_file_index = ~0;
500 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
501 mq->log2_ring_size = mif->cfg.log2_ring_size;
503 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
505 mq->type = MEMIF_RING_M2S;
506 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
507 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
508 CLIB_CACHE_LINE_BYTES);
515 memif_log_err (mif, "%U", format_clib_error, err);
520 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
522 memif_main_t *mm = &memif_main;
525 uword *event_data = 0, event_type;
527 f64 start_time, last_run_duration = 0, now;
530 sock = clib_mem_alloc (sizeof (clib_socket_t));
531 clib_memset (sock, 0, sizeof (clib_socket_t));
536 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
539 vlib_process_wait_for_event (vm);
541 event_type = vlib_process_get_events (vm, &event_data);
542 vec_reset_length (event_data);
548 case MEMIF_PROCESS_EVENT_START:
551 case MEMIF_PROCESS_EVENT_STOP:
554 case MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN:
560 last_run_duration = start_time = vlib_time_now (vm);
562 pool_foreach (mif, mm->interfaces)
564 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
565 /* Allow no more than 10us without a pause */
566 now = vlib_time_now (vm);
567 if (now > start_time + 10e-6)
569 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
570 start_time = vlib_time_now (vm);
573 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
576 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
579 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
582 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
584 clib_memset (sock, 0, sizeof(clib_socket_t));
585 sock->config = (char *) msf->filename;
586 sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
588 if ((err = clib_socket_init (sock)))
590 clib_error_free (err);
594 clib_file_t t = { 0 };
596 t.read_function = memif_slave_conn_fd_read_ready;
597 t.write_function = memif_slave_conn_fd_write_ready;
598 t.error_function = memif_slave_conn_fd_error;
599 t.file_descriptor = sock->fd;
600 t.private_data = mif->dev_instance;
601 memif_file_add (&sock->private_data, &t);
602 t.description = format (0, "%U ctl",
603 format_memif_device_name,
605 hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
607 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
609 sock = clib_mem_alloc (sizeof(clib_socket_t));
614 last_run_duration = vlib_time_now (vm) - last_run_duration;
620 VLIB_REGISTER_NODE (memif_process_node,static) = {
621 .function = memif_process,
622 .type = VLIB_NODE_TYPE_PROCESS,
623 .name = "memif-process",
628 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
630 memif_main_t *mm = &memif_main;
632 memif_socket_file_t *msf;
634 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
637 msf = pool_elt_at_index (mm->socket_files, *p);
638 if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
640 /* Silently accept identical "add". */
644 /* But don't allow a direct add of a different filename. */
645 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
648 pool_get (mm->socket_files, msf);
649 clib_memset (msf, 0, sizeof (memif_socket_file_t));
651 msf->filename = socket_filename;
652 msf->socket_id = sock_id;
654 hash_set (mm->socket_file_index_by_sock_id, sock_id,
655 msf - mm->socket_files);
661 memif_delete_socket_file (u32 sock_id)
663 memif_main_t *mm = &memif_main;
665 memif_socket_file_t *msf;
667 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
670 /* Don't delete non-existent entries. */
671 return VNET_API_ERROR_INVALID_ARGUMENT;
674 msf = pool_elt_at_index (mm->socket_files, *p);
675 if (msf->ref_cnt > 0)
677 return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
680 vec_free (msf->filename);
681 pool_put (mm->socket_files, msf);
683 hash_unset (mm->socket_file_index_by_sock_id, sock_id);
689 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
694 /* allow adding socket id 0 */
695 if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
697 return VNET_API_ERROR_INVALID_ARGUMENT;
702 return memif_delete_socket_file (sock_id);
705 if (sock_filename == 0 || sock_filename[0] == 0)
707 return VNET_API_ERROR_INVALID_ARGUMENT;
710 if (sock_filename[0] != '/')
714 /* copy runtime dir path */
715 vec_add (dir, vlib_unix_get_runtime_dir (),
716 strlen (vlib_unix_get_runtime_dir ()));
719 /* if sock_filename contains dirs, add them to path */
720 tmp = strrchr ((char *) sock_filename, '/');
723 idx = tmp - (char *) sock_filename;
724 vec_add (dir, sock_filename, idx);
727 vec_add1 (dir, '\0');
728 /* create socket dir */
729 error = vlib_unix_recursive_mkdir (dir);
732 clib_error_free (error);
733 return VNET_API_ERROR_SYSCALL_ERROR_1;
736 sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
741 sock_filename = vec_dup (sock_filename);
743 /* check if directory exists */
744 tmp = strrchr ((char *) sock_filename, '/');
747 idx = tmp - (char *) sock_filename;
748 vec_add (dir, sock_filename, idx);
749 vec_add1 (dir, '\0');
752 /* check dir existance and access rights for effective user/group IDs */
755 (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
759 return VNET_API_ERROR_INVALID_ARGUMENT;
764 return memif_add_socket_file (sock_id, sock_filename);
768 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
770 vnet_main_t *vnm = vnet_get_main ();
771 memif_main_t *mm = &memif_main;
772 memif_socket_file_t *msf =
773 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
776 mif->flags |= MEMIF_IF_FLAG_DELETING;
777 vec_free (mif->local_disc_string);
778 vec_free (mif->remote_disc_string);
780 /* bring down the interface */
781 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
782 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
784 err = clib_error_return (0, "interface deleted");
785 memif_disconnect (mif, err);
786 clib_error_free (err);
788 if (mif->hw_if_index != ~0)
790 /* remove the interface */
791 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
792 vnet_delete_hw_interface (vnm, mif->hw_if_index);
794 ethernet_delete_interface (vnm, mif->hw_if_index);
795 mif->hw_if_index = ~0;
798 /* free interface data structures */
799 clib_spinlock_free (&mif->lockp);
800 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
802 /* remove socket file */
803 if (--(msf->ref_cnt) == 0)
805 if (msf->is_listener)
809 vec_foreach_index (i, msf->pending_clients)
810 memif_socket_close (msf->pending_clients + i);
812 memif_socket_close (&msf->sock);
813 vec_free (msf->pending_clients);
815 mhash_free (&msf->dev_instance_by_id);
816 hash_free (msf->dev_instance_by_fd);
819 err = clib_socket_close (msf->sock);
822 memif_log_err (mif, "%U", format_clib_error, err);
823 clib_error_free (err);
825 clib_mem_free (msf->sock);
829 clib_memset (mif, 0, sizeof (*mif));
830 pool_put (mm->interfaces, mif);
832 if (pool_elts (mm->interfaces) == 0)
833 vlib_process_signal_event (vm, memif_process_node.index,
834 MEMIF_PROCESS_EVENT_STOP, 0);
840 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
843 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
848 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
850 memif_main_t *mm = &memif_main;
851 vlib_thread_main_t *tm = vlib_get_thread_main ();
852 vnet_main_t *vnm = vnet_get_main ();
854 vnet_sw_interface_t *sw;
855 clib_error_t *error = 0;
858 vnet_hw_interface_t *hw;
859 memif_socket_file_t *msf = 0;
862 p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
865 rv = VNET_API_ERROR_INVALID_ARGUMENT;
869 msf = vec_elt_at_index (mm->socket_files, p[0]);
871 /* existing socket file can be either master or slave but cannot be both */
872 if (msf->ref_cnt > 0)
874 if ((!msf->is_listener != !args->is_master))
876 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
880 p = mhash_get (&msf->dev_instance_by_id, &args->id);
883 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
888 /* Create new socket file */
889 if (msf->ref_cnt == 0)
891 struct stat file_stat;
893 /* If we are creating listener make sure file doesn't exist or if it
894 * exists thn delete it if it is old socket file */
895 if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
897 if (S_ISSOCK (file_stat.st_mode))
899 unlink ((char *) msf->filename);
903 error = clib_error_return (0, "File exists for %s",
905 rv = VNET_API_ERROR_VALUE_EXIST;
910 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
911 sizeof (memif_interface_id_t));
912 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
913 msf->is_listener = (args->is_master != 0);
915 memif_log_debug (0, "initializing socket file %s", msf->filename);
918 if (mm->per_thread_data == 0)
922 vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
923 CLIB_CACHE_LINE_BYTES);
925 for (i = 0; i < tm->n_vlib_mains; i++)
927 memif_per_thread_data_t *ptd =
928 vec_elt_at_index (mm->per_thread_data, i);
929 vlib_buffer_t *bt = &ptd->buffer_template;
930 clib_memset (bt, 0, sizeof (vlib_buffer_t));
931 bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
932 bt->total_length_not_including_first_buffer = 0;
933 vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
935 /* initially prealloc copy_ops so we can use
936 _vec_len instead of vec_elen */
937 vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
938 vec_reset_length (ptd->copy_ops);
939 vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
940 vec_reset_length (ptd->buffers);
944 pool_get (mm->interfaces, mif);
945 clib_memset (mif, 0, sizeof (*mif));
946 mif->dev_instance = mif - mm->interfaces;
947 mif->socket_file_index = msf - mm->socket_files;
949 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
950 mif->mode = args->mode;
952 mif->secret = vec_dup (args->secret);
954 if (tm->n_vlib_mains > 1)
955 clib_spinlock_init (&mif->lockp);
957 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
960 if (!args->hw_addr_set)
962 f64 now = vlib_time_now (vm);
964 rnd = (u32) (now * 1e6);
965 rnd = random_u32 (&rnd);
967 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
968 args->hw_addr[0] = 2;
969 args->hw_addr[1] = 0xfe;
971 error = ethernet_register_interface (vnm, memif_device_class.index,
972 mif->dev_instance, args->hw_addr,
974 memif_eth_flag_change);
976 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
979 vnet_register_interface (vnm, memif_device_class.index,
981 memif_ip_hw_if_class.index,
985 error = clib_error_return (0, "unsupported interface mode");
989 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
993 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
994 mif->sw_if_index = sw->sw_if_index;
996 mif->cfg.log2_ring_size = args->log2_ring_size;
997 mif->cfg.buffer_size = args->buffer_size;
998 mif->cfg.num_s2m_rings =
999 args->is_master ? args->rx_queues : args->tx_queues;
1000 mif->cfg.num_m2s_rings =
1001 args->is_master ? args->tx_queues : args->rx_queues;
1003 args->sw_if_index = mif->sw_if_index;
1005 /* If this is new one, start listening */
1006 if (msf->is_listener && msf->ref_cnt == 0)
1008 struct stat file_stat;
1009 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
1011 ASSERT (msf->sock == 0);
1014 clib_memset (s, 0, sizeof (clib_socket_t));
1015 s->config = (char *) msf->filename;
1016 s->flags = CLIB_SOCKET_F_IS_SERVER |
1017 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1018 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1020 if ((error = clib_socket_init (s)))
1022 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
1026 if (stat ((char *) msf->filename, &file_stat) == -1)
1028 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
1032 clib_file_t template = { 0 };
1033 template.read_function = memif_conn_fd_accept_ready;
1034 template.file_descriptor = msf->sock->fd;
1035 template.private_data = mif->socket_file_index;
1036 template.description = format (0, "memif listener %s", msf->filename);
1037 memif_file_add (&msf->sock->private_data, &template);
1042 if (args->is_master == 0)
1044 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
1045 if (args->is_zero_copy)
1046 mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
1049 hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
1050 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE;
1051 vnet_hw_if_set_input_node (vnm, mif->hw_if_index, memif_input_node.index);
1052 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
1054 if (pool_elts (mm->interfaces) == 1)
1056 vlib_process_signal_event (vm, memif_process_node.index,
1057 MEMIF_PROCESS_EVENT_START, 0);
1062 if (mif->hw_if_index != ~0)
1064 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1065 vnet_delete_hw_interface (vnm, mif->hw_if_index);
1067 ethernet_delete_interface (vnm, mif->hw_if_index);
1068 mif->hw_if_index = ~0;
1070 memif_delete_if (vm, mif);
1073 memif_log_err (mif, "%U", format_clib_error, error);
1074 clib_error_free (error);
1083 memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
1085 memif_main_t *mm = &memif_main;
1086 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1087 memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1088 static clib_error_t *error = 0;
1090 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1091 mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
1093 mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
1095 vlib_process_signal_event (vnm->vlib_main, memif_process_node.index,
1096 MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN, 0);
1100 static clib_error_t *
1101 memif_init (vlib_main_t * vm)
1103 memif_main_t *mm = &memif_main;
1105 clib_memset (mm, 0, sizeof (memif_main_t));
1107 mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1108 memif_log_debug (0, "initialized");
1110 /* initialize binary API */
1111 memif_plugin_api_hookup (vm);
1114 * Pre-stuff socket filename pool with a non-modifieable mapping
1115 * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1116 * default run-time directory.
1118 memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1123 VLIB_INIT_FUNCTION (memif_init);
1126 VLIB_PLUGIN_REGISTER () = {
1127 .version = VPP_BUILD_VER,
1128 .description = "Packet Memory Interface (memif) -- Experimental",
1133 * fd.io coding-style-patch-verification: ON
1136 * eval: (c-set-style "gnu")