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 <vnet/interface/tx_queue_funcs.h>
40 #include <vpp/app/version.h>
41 #include <memif/memif.h>
42 #include <memif/private.h>
44 memif_main_t memif_main;
47 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
54 memif_eth_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hi,
62 memif_queue_intfd_close (memif_queue_t * mq)
64 if (mq->int_clib_file_index != ~0)
66 memif_file_del_by_index (mq->int_clib_file_index);
67 mq->int_clib_file_index = ~0;
70 else if (mq->int_fd > -1)
78 memif_disconnect_free_zc_queue_buffer (memif_queue_t * mq, u8 is_rx)
80 vlib_main_t *vm = vlib_get_main ();
81 u16 ring_size, n_slots, mask, start;
83 ring_size = 1 << mq->log2_ring_size;
85 n_slots = mq->ring->head - mq->last_tail;
86 start = mq->last_tail & mask;
88 vlib_buffer_free_from_ring (vm, mq->buffers, start, ring_size, n_slots);
90 vlib_buffer_free_from_ring_no_next (vm, mq->buffers, start, ring_size,
92 vec_free (mq->buffers);
96 memif_disconnect (memif_if_t * mif, clib_error_t * err)
98 memif_main_t *mm = &memif_main;
99 vnet_main_t *vnm = vnet_get_main ();
107 memif_log_debug (mif, "disconnect %u (%v)", mif->dev_instance,
108 err ? err->what : 0);
113 mif->local_disc_string = vec_dup (err->what);
114 if (mif->sock && clib_socket_is_connected (mif->sock))
115 e = memif_msg_send_disconnect (mif, err);
119 /* set interface down */
120 mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
121 if (mif->hw_if_index != ~0)
122 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
124 /* close connection socket */
125 if (mif->sock && mif->sock->fd)
127 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
128 mif->socket_file_index);
129 hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
130 memif_socket_close (&mif->sock);
135 err = clib_socket_close (mif->sock);
138 memif_log_err (mif, "%U", format_clib_error, err);
139 clib_error_free (err);
141 clib_mem_free (mif->sock);
145 vec_foreach_index (i, mif->rx_queues)
147 mq = vec_elt_at_index (mif->rx_queues, i);
150 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
152 memif_disconnect_free_zc_queue_buffer(mq, 1);
157 vnet_hw_if_unregister_all_rx_queues (vnm, mif->hw_if_index);
160 vec_foreach_index (i, mif->tx_queues)
162 mq = vec_elt_at_index (mif->tx_queues, i);
165 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
167 memif_disconnect_free_zc_queue_buffer(mq, 0);
169 clib_spinlock_free (&mq->lockp);
173 vnet_hw_if_unregister_all_tx_queues (vnm, mif->hw_if_index);
174 vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
176 /* free tx and rx queues */
177 vec_foreach (mq, mif->rx_queues)
178 memif_queue_intfd_close (mq);
179 vec_free (mif->rx_queues);
181 vec_foreach (mq, mif->tx_queues)
182 memif_queue_intfd_close (mq);
183 vec_free (mif->tx_queues);
185 /* free memory regions */
186 vec_foreach (mr, mif->regions)
191 if ((rv = munmap (mr->shm, mr->region_size)))
192 memif_log_err (mif, "munmap failed, rv = %d", rv);
197 vec_free (mif->regions);
198 vec_free (mif->remote_name);
199 vec_free (mif->remote_if_name);
200 clib_fifo_free (mif->msg_queue);
203 static clib_error_t *
204 memif_int_fd_write_ready (clib_file_t * uf)
206 memif_main_t *mm = &memif_main;
207 u16 qid = uf->private_data & 0xFFFF;
208 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
210 memif_log_warn (mif, "unexpected EPOLLOUT on RX for queue %u", qid);
214 static clib_error_t *
215 memif_int_fd_read_ready (clib_file_t * uf)
217 memif_main_t *mm = &memif_main;
218 vnet_main_t *vnm = vnet_get_main ();
219 u16 qid = uf->private_data & 0xFFFF;
220 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
221 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
225 size = read (uf->file_descriptor, &b, sizeof (b));
228 memif_log_debug (mif, "Failed to read from socket");
232 vnet_hw_if_rx_queue_set_int_pending (vnm, mq->queue_index);
240 memif_connect (memif_if_t * mif)
242 memif_main_t *mm = &memif_main;
243 vlib_main_t *vm = vlib_get_main ();
244 vnet_main_t *vnm = vnet_get_main ();
245 clib_file_t template = { 0 };
248 u32 n_txqs = 0, n_threads = vlib_get_n_threads ();
249 clib_error_t *err = NULL;
250 u8 max_log2_ring_sz = 0;
252 memif_log_debug (mif, "connect %u", mif->dev_instance);
254 vec_free (mif->local_disc_string);
255 vec_free (mif->remote_disc_string);
258 vec_foreach (mr, mif->regions)
265 err = clib_error_return (0, "no memory region fd");
269 if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
270 MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
272 err = clib_error_return_unix (0, "mmap");
278 template.read_function = memif_int_fd_read_ready;
279 template.write_function = memif_int_fd_write_ready;
282 vec_foreach_index (i, mif->tx_queues)
284 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
285 max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
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);
294 vnet_hw_if_register_tx_queue (vnm, mif->hw_if_index, i);
295 clib_spinlock_init (&mq->lockp);
298 if (vec_len (mif->tx_queues) > 0)
300 n_txqs = vec_len (mif->tx_queues);
301 for (j = 0; j < n_threads; j++)
303 u32 qi = mif->tx_queues[j % n_txqs].queue_index;
304 vnet_hw_if_tx_queue_assign_thread (vnm, qi, j);
308 vec_foreach_index (i, mif->rx_queues)
310 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
315 max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
317 mq->ring = mif->regions[mq->region].shm + mq->offset;
318 if (mq->ring->cookie != MEMIF_COOKIE)
320 err = clib_error_return (0, "wrong cookie on tx ring %u", i);
323 qi = vnet_hw_if_register_rx_queue (vnm, mif->hw_if_index, i,
324 VNET_HW_IF_RXQ_THREAD_ANY);
325 mq->queue_index = qi;
328 template.file_descriptor = mq->int_fd;
329 template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
330 template.description = format (0, "%U rx %u int",
331 format_memif_device_name,
332 mif->dev_instance, i);
333 memif_file_add (&mq->int_clib_file_index, &template);
334 vnet_hw_if_set_rx_queue_file_index (vnm, qi,
335 mq->int_clib_file_index);
337 ti = vnet_hw_if_get_rx_queue_thread_index (vnm, qi);
338 mq->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
339 vm, vlib_get_main_by_index (ti)->numa_node);
340 rv = vnet_hw_if_set_rx_queue_mode (vnm, qi, VNET_HW_IF_RX_MODE_DEFAULT);
341 vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
345 (mif, "Warning: unable to set rx mode for interface %d queue %d: "
346 "rc=%d", mif->hw_if_index, i, rv);
349 vnet_hw_if_rx_mode rxmode = vnet_hw_if_get_rx_queue_mode (vnm, qi);
351 if (rxmode == VNET_HW_IF_RX_MODE_POLLING)
352 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
354 vnet_hw_if_rx_queue_set_int_pending (vnm, qi);
359 if (1 << max_log2_ring_sz > vec_len (mm->per_thread_data[0].desc_data))
361 memif_per_thread_data_t *ptd;
362 int with_barrier = 1;
364 if (vlib_worker_thread_barrier_held ())
368 vlib_worker_thread_barrier_sync (vm);
370 vec_foreach (ptd, mm->per_thread_data)
372 vec_validate_aligned (ptd->desc_data, pow2_mask (max_log2_ring_sz),
373 CLIB_CACHE_LINE_BYTES);
374 vec_validate_aligned (ptd->desc_len, pow2_mask (max_log2_ring_sz),
375 CLIB_CACHE_LINE_BYTES);
376 vec_validate_aligned (ptd->desc_status, pow2_mask (max_log2_ring_sz),
377 CLIB_CACHE_LINE_BYTES);
380 vlib_worker_thread_barrier_release (vm);
383 mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
384 mif->flags |= MEMIF_IF_FLAG_CONNECTED;
386 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
387 VNET_HW_INTERFACE_FLAG_LINK_UP);
391 memif_log_err (mif, "%U", format_clib_error, err);
395 static_always_inline memif_ring_t *
396 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
398 if (vec_len (mif->regions) == 0)
400 void *p = mif->regions[0].shm;
402 sizeof (memif_ring_t) +
403 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
404 p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
406 return (memif_ring_t *) p;
410 memif_init_regions_and_queues (memif_if_t * mif)
412 vlib_main_t *vm = vlib_get_main ();
413 memif_socket_file_t *msf;
414 memif_ring_t *ring = NULL;
420 ASSERT (vec_len (mif->regions) == 0);
421 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
423 buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
424 (sizeof (memif_ring_t) +
425 sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
427 r->region_size = buffer_offset;
429 if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
430 r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
431 (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
433 if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "%U region 0",
434 format_memif_device_name,
435 mif->dev_instance)) == -1)
437 err = clib_mem_get_last_error ();
441 if ((ftruncate (fd, r->region_size)) == -1)
443 err = clib_error_return_unix (0, "ftruncate");
447 msf = pool_elt_at_index (memif_main.socket_files, mif->socket_file_index);
448 r->shm = clib_mem_vm_map_shared (0, r->region_size, fd, 0, "memif%lu/%lu:0",
449 msf->socket_id, mif->id);
451 if (r->shm == CLIB_MEM_VM_MAP_FAILED)
453 err = clib_error_return_unix (0, "memif shared region map failed");
459 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
461 vlib_buffer_pool_t *bp;
463 vec_foreach (bp, vm->buffer_main->buffer_pools)
465 vlib_physmem_map_t *pm;
466 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
467 vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
469 r->region_size = pm->n_pages << pm->log2_page_size;
476 for (i = 0; i < mif->run.num_s2m_rings; i++)
478 ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
479 ring->head = ring->tail = 0;
480 ring->cookie = MEMIF_COOKIE;
482 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
485 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
487 u16 slot = i * (1 << mif->run.log2_ring_size) + j;
488 ring->desc[j].region = 0;
489 ring->desc[j].offset =
490 buffer_offset + (u32) (slot * mif->run.buffer_size);
491 ring->desc[j].length = mif->run.buffer_size;
494 for (i = 0; i < mif->run.num_m2s_rings; i++)
496 ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
497 ring->head = ring->tail = 0;
498 ring->cookie = MEMIF_COOKIE;
500 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
503 for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
506 (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
507 ring->desc[j].region = 0;
508 ring->desc[j].offset =
509 buffer_offset + (u32) (slot * mif->run.buffer_size);
510 ring->desc[j].length = mif->run.buffer_size;
514 ASSERT (mif->tx_queues == 0);
515 vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
516 CLIB_CACHE_LINE_BYTES);
519 vec_foreach_index (i, mif->tx_queues)
521 memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
522 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
524 err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
528 mq->int_clib_file_index = ~0;
529 mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
530 mq->log2_ring_size = mif->cfg.log2_ring_size;
532 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
534 mq->type = MEMIF_RING_S2M;
535 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
536 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
537 CLIB_CACHE_LINE_BYTES);
541 ASSERT (mif->rx_queues == 0);
542 vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
543 CLIB_CACHE_LINE_BYTES);
546 vec_foreach_index (i, mif->rx_queues)
548 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
549 if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
551 err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
554 mq->int_clib_file_index = ~0;
555 mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
556 mq->log2_ring_size = mif->cfg.log2_ring_size;
558 mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
560 mq->type = MEMIF_RING_M2S;
561 if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
562 vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
563 CLIB_CACHE_LINE_BYTES);
570 memif_log_err (mif, "%U", format_clib_error, err);
575 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
577 memif_main_t *mm = &memif_main;
580 uword *event_data = 0, event_type;
582 f64 start_time, last_run_duration = 0, now;
585 sock = clib_mem_alloc (sizeof (clib_socket_t));
586 clib_memset (sock, 0, sizeof (clib_socket_t));
591 vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
594 vlib_process_wait_for_event (vm);
596 event_type = vlib_process_get_events (vm, &event_data);
597 vec_reset_length (event_data);
603 case MEMIF_PROCESS_EVENT_START:
606 case MEMIF_PROCESS_EVENT_STOP:
609 case MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN:
615 last_run_duration = start_time = vlib_time_now (vm);
617 pool_foreach (mif, mm->interfaces)
619 memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
620 /* Allow no more than 10us without a pause */
621 now = vlib_time_now (vm);
622 if (now > start_time + 10e-6)
624 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
625 start_time = vlib_time_now (vm);
628 if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
631 if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
634 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
637 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
639 clib_memset (sock, 0, sizeof(clib_socket_t));
640 sock->config = (char *) msf->filename;
641 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET |
642 CLIB_SOCKET_F_BLOCKING;
644 if ((err = clib_socket_init (sock)))
646 clib_error_free (err);
650 clib_file_t t = { 0 };
652 t.read_function = memif_slave_conn_fd_read_ready;
653 t.write_function = memif_slave_conn_fd_write_ready;
654 t.error_function = memif_slave_conn_fd_error;
655 t.file_descriptor = sock->fd;
656 t.private_data = mif->dev_instance;
657 memif_file_add (&sock->private_data, &t);
658 t.description = format (0, "%U ctl",
659 format_memif_device_name,
661 hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
663 mif->flags |= MEMIF_IF_FLAG_CONNECTING;
665 sock = clib_mem_alloc (sizeof(clib_socket_t));
670 last_run_duration = vlib_time_now (vm) - last_run_duration;
676 VLIB_REGISTER_NODE (memif_process_node,static) = {
677 .function = memif_process,
678 .type = VLIB_NODE_TYPE_PROCESS,
679 .name = "memif-process",
684 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
686 memif_main_t *mm = &memif_main;
688 memif_socket_file_t *msf;
690 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
693 msf = pool_elt_at_index (mm->socket_files, *p);
694 if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
696 /* Silently accept identical "add". */
700 /* But don't allow a direct add of a different filename. */
701 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
704 pool_get (mm->socket_files, msf);
705 clib_memset (msf, 0, sizeof (memif_socket_file_t));
707 msf->filename = socket_filename;
708 msf->socket_id = sock_id;
710 hash_set (mm->socket_file_index_by_sock_id, sock_id,
711 msf - mm->socket_files);
717 memif_delete_socket_file (u32 sock_id)
719 memif_main_t *mm = &memif_main;
721 memif_socket_file_t *msf;
723 p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
726 /* Don't delete non-existent entries. */
727 return VNET_API_ERROR_INVALID_ARGUMENT;
730 msf = pool_elt_at_index (mm->socket_files, *p);
731 if (msf->ref_cnt > 0)
733 return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
736 vec_free (msf->filename);
737 pool_put (mm->socket_files, msf);
739 hash_unset (mm->socket_file_index_by_sock_id, sock_id);
745 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
750 /* allow adding socket id 0 */
751 if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
753 return VNET_API_ERROR_INVALID_ARGUMENT;
758 return memif_delete_socket_file (sock_id);
761 if (sock_filename == 0 || sock_filename[0] == 0)
763 return VNET_API_ERROR_INVALID_ARGUMENT;
766 if (sock_filename[0] != '/')
770 /* copy runtime dir path */
771 vec_add (dir, vlib_unix_get_runtime_dir (),
772 strlen (vlib_unix_get_runtime_dir ()));
775 /* if sock_filename contains dirs, add them to path */
776 tmp = strrchr ((char *) sock_filename, '/');
779 idx = tmp - (char *) sock_filename;
780 vec_add (dir, sock_filename, idx);
783 vec_add1 (dir, '\0');
784 /* create socket dir */
785 error = vlib_unix_recursive_mkdir (dir);
788 clib_error_free (error);
789 return VNET_API_ERROR_SYSCALL_ERROR_1;
792 sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
797 sock_filename = vec_dup (sock_filename);
799 /* check if directory exists */
800 tmp = strrchr ((char *) sock_filename, '/');
803 idx = tmp - (char *) sock_filename;
804 vec_add (dir, sock_filename, idx);
805 vec_add1 (dir, '\0');
808 /* check dir existance and access rights for effective user/group IDs */
811 (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
815 return VNET_API_ERROR_INVALID_ARGUMENT;
820 return memif_add_socket_file (sock_id, sock_filename);
824 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
826 vnet_main_t *vnm = vnet_get_main ();
827 memif_main_t *mm = &memif_main;
828 memif_socket_file_t *msf =
829 vec_elt_at_index (mm->socket_files, mif->socket_file_index);
832 mif->flags |= MEMIF_IF_FLAG_DELETING;
833 vec_free (mif->local_disc_string);
834 vec_free (mif->remote_disc_string);
836 /* bring down the interface */
837 vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
838 vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
840 err = clib_error_return (0, "interface deleted");
841 memif_disconnect (mif, err);
842 clib_error_free (err);
844 if (mif->hw_if_index != ~0)
846 /* remove the interface */
847 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
848 vnet_delete_hw_interface (vnm, mif->hw_if_index);
850 ethernet_delete_interface (vnm, mif->hw_if_index);
851 mif->hw_if_index = ~0;
854 /* free interface data structures */
855 mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
857 /* remove socket file */
858 if (--(msf->ref_cnt) == 0)
860 if (msf->is_listener)
864 vec_foreach_index (i, msf->pending_clients)
865 memif_socket_close (msf->pending_clients + i);
867 memif_socket_close (&msf->sock);
868 vec_free (msf->pending_clients);
870 mhash_free (&msf->dev_instance_by_id);
871 hash_free (msf->dev_instance_by_fd);
874 err = clib_socket_close (msf->sock);
877 memif_log_err (mif, "%U", format_clib_error, err);
878 clib_error_free (err);
880 clib_mem_free (msf->sock);
884 vec_free (mif->local_disc_string);
885 clib_memset (mif, 0, sizeof (*mif));
886 pool_put (mm->interfaces, mif);
888 if (pool_elts (mm->interfaces) == 0)
889 vlib_process_signal_event (vm, memif_process_node.index,
890 MEMIF_PROCESS_EVENT_STOP, 0);
896 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) = {
898 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
899 .tx_hash_fn_type = VNET_HASH_FN_TYPE_IP,
904 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
906 memif_main_t *mm = &memif_main;
907 vlib_thread_main_t *tm = vlib_get_thread_main ();
908 vnet_main_t *vnm = vnet_get_main ();
909 vnet_eth_interface_registration_t eir = {};
911 vnet_sw_interface_t *sw;
912 clib_error_t *error = 0;
915 memif_socket_file_t *msf = 0;
918 p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
921 rv = VNET_API_ERROR_INVALID_ARGUMENT;
925 msf = vec_elt_at_index (mm->socket_files, p[0]);
927 /* existing socket file can be either master or slave but cannot be both */
928 if (msf->ref_cnt > 0)
930 if ((!msf->is_listener != !args->is_master))
932 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
936 p = mhash_get (&msf->dev_instance_by_id, &args->id);
939 rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
944 /* Create new socket file */
945 if (msf->ref_cnt == 0)
947 struct stat file_stat;
949 /* If we are creating listener make sure file doesn't exist or if it
950 * exists thn delete it if it is old socket file */
951 if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
953 if (S_ISSOCK (file_stat.st_mode))
955 unlink ((char *) msf->filename);
959 error = clib_error_return (0, "File exists for %s",
961 rv = VNET_API_ERROR_VALUE_EXIST;
966 mhash_init (&msf->dev_instance_by_id, sizeof (uword),
967 sizeof (memif_interface_id_t));
968 msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
969 msf->is_listener = (args->is_master != 0);
971 memif_log_debug (0, "initializing socket file %s", msf->filename);
974 if (mm->per_thread_data == 0)
978 vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
979 CLIB_CACHE_LINE_BYTES);
981 for (i = 0; i < tm->n_vlib_mains; i++)
983 memif_per_thread_data_t *ptd =
984 vec_elt_at_index (mm->per_thread_data, i);
985 vlib_buffer_t *bt = &ptd->buffer_template;
986 clib_memset (bt, 0, sizeof (vlib_buffer_t));
987 bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
988 bt->total_length_not_including_first_buffer = 0;
989 vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
991 /* initially prealloc copy_ops so we can use
992 _vec_len instead of vec_elen */
993 vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
994 vec_reset_length (ptd->copy_ops);
995 vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
996 vec_reset_length (ptd->buffers);
1000 pool_get (mm->interfaces, mif);
1001 clib_memset (mif, 0, sizeof (*mif));
1002 mif->dev_instance = mif - mm->interfaces;
1003 mif->socket_file_index = msf - mm->socket_files;
1005 mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
1006 mif->mode = args->mode;
1008 mif->secret = vec_dup (args->secret);
1010 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
1013 if (!args->hw_addr_set)
1015 f64 now = vlib_time_now (vm);
1017 rnd = (u32) (now * 1e6);
1018 rnd = random_u32 (&rnd);
1020 memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
1021 args->hw_addr[0] = 2;
1022 args->hw_addr[1] = 0xfe;
1025 eir.dev_class_index = memif_device_class.index;
1026 eir.dev_instance = mif->dev_instance;
1027 eir.address = args->hw_addr;
1028 eir.cb.flag_change = memif_eth_flag_change;
1029 eir.cb.set_max_frame_size = memif_eth_set_max_frame_size;
1030 mif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
1032 else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1035 vnet_register_interface (vnm, memif_device_class.index,
1037 memif_ip_hw_if_class.index,
1041 error = clib_error_return (0, "unsupported interface mode");
1045 ret = VNET_API_ERROR_SYSCALL_ERROR_2;
1049 sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
1050 mif->sw_if_index = sw->sw_if_index;
1052 mif->cfg.log2_ring_size = args->log2_ring_size;
1053 mif->cfg.buffer_size = args->buffer_size;
1054 mif->cfg.num_s2m_rings =
1055 args->is_master ? args->rx_queues : args->tx_queues;
1056 mif->cfg.num_m2s_rings =
1057 args->is_master ? args->tx_queues : args->rx_queues;
1059 args->sw_if_index = mif->sw_if_index;
1061 /* If this is new one, start listening */
1062 if (msf->is_listener && msf->ref_cnt == 0)
1064 struct stat file_stat;
1065 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
1067 ASSERT (msf->sock == 0);
1070 clib_memset (s, 0, sizeof (clib_socket_t));
1071 s->config = (char *) msf->filename;
1072 s->flags = CLIB_SOCKET_F_IS_SERVER |
1073 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1074 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1076 if ((error = clib_socket_init (s)))
1078 ret = VNET_API_ERROR_SYSCALL_ERROR_4;
1082 if (stat ((char *) msf->filename, &file_stat) == -1)
1084 ret = VNET_API_ERROR_SYSCALL_ERROR_8;
1088 clib_file_t template = { 0 };
1089 template.read_function = memif_conn_fd_accept_ready;
1090 template.file_descriptor = msf->sock->fd;
1091 template.private_data = mif->socket_file_index;
1092 template.description = format (0, "memif listener %s", msf->filename);
1093 memif_file_add (&msf->sock->private_data, &template);
1098 if (args->is_master == 0)
1100 mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
1101 if (args->is_zero_copy)
1102 mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
1105 vnet_hw_if_set_caps (vnm, mif->hw_if_index, VNET_HW_IF_CAP_INT_MODE);
1106 vnet_hw_if_set_input_node (vnm, mif->hw_if_index, memif_input_node.index);
1107 mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
1109 if (pool_elts (mm->interfaces) == 1)
1111 vlib_process_signal_event (vm, memif_process_node.index,
1112 MEMIF_PROCESS_EVENT_START, 0);
1117 memif_delete_if (vm, mif);
1120 memif_log_err (mif, "%U", format_clib_error, error);
1121 clib_error_free (error);
1130 memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
1132 memif_main_t *mm = &memif_main;
1133 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1134 memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1135 static clib_error_t *error = 0;
1137 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1139 if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
1141 vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
1142 VNET_HW_INTERFACE_FLAG_LINK_UP);
1144 mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
1147 mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
1149 vlib_process_signal_event (vnm->vlib_main, memif_process_node.index,
1150 MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN, 0);
1154 static clib_error_t *
1155 memif_init (vlib_main_t * vm)
1157 memif_main_t *mm = &memif_main;
1159 clib_memset (mm, 0, sizeof (memif_main_t));
1161 mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1162 memif_log_debug (0, "initialized");
1164 /* initialize binary API */
1165 memif_plugin_api_hookup (vm);
1168 * Pre-stuff socket filename pool with a non-modifieable mapping
1169 * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1170 * default run-time directory.
1172 memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1177 VLIB_INIT_FUNCTION (memif_init);
1180 VLIB_PLUGIN_REGISTER () = {
1181 .version = VPP_BUILD_VER,
1182 .description = "Packet Memory Interface (memif) -- Experimental",
1187 * fd.io coding-style-patch-verification: ON
1190 * eval: (c-set-style "gnu")