2 *------------------------------------------------------------------
5 * Copyright (c) 2014 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <fcntl.h> /* for open */
21 #include <sys/ioctl.h>
22 #include <sys/socket.h>
25 #include <sys/types.h>
26 #include <sys/uio.h> /* for iovec */
27 #include <netinet/in.h>
30 #include <linux/if_arp.h>
31 #include <linux/if_tun.h>
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
36 #include <vnet/ip/ip.h>
38 #include <vnet/ethernet/ethernet.h>
39 #include <vnet/devices/devices.h>
40 #include <vnet/feature/feature.h>
42 #include <vnet/devices/virtio/vhost-user.h>
46 * @brief vHost User Device Driver.
48 * This file contains the source code for vHost User interface.
52 #define VHOST_DEBUG_VQ 0
54 #define DBG_SOCK(args...) \
56 vhost_user_main_t *_vum = &vhost_user_main; \
61 #if VHOST_DEBUG_VQ == 1
62 #define DBG_VQ(args...) clib_warning(args);
64 #define DBG_VQ(args...)
68 * When an RX queue is down but active, received packets
69 * must be discarded. This value controls up to how many
70 * packets will be discarded during each round.
72 #define VHOST_USER_DOWN_DISCARD_COUNT 256
75 * When the number of available buffers gets under this threshold,
76 * RX node will start discarding packets.
78 #define VHOST_USER_RX_BUFFER_STARVATION 32
81 * On the receive side, the host should free descriptors as soon
82 * as possible in order to avoid TX drop in the VM.
83 * This value controls the number of copy operations that are stacked
84 * before copy is done for all and descriptors are given back to
86 * The value 64 was obtained by testing (48 and 128 were not as good).
88 #define VHOST_USER_RX_COPY_THRESHOLD 64
90 * On the transmit side, we keep processing the buffers from vlib in the while
91 * loop and prepare the copy order to be executed later. However, the static
92 * array which we keep the copy order is limited to VHOST_USER_COPY_ARRAY_N
93 * entries. In order to not corrupt memory, we have to do the copy when the
94 * static array reaches the copy threshold. We subtract 40 in case the code
95 * goes into the inner loop for a maximum of 64k frames which may require
98 #define VHOST_USER_TX_COPY_THRESHOLD (VHOST_USER_COPY_ARRAY_N - 40)
100 #define UNIX_GET_FD(unixfd_idx) \
101 (unixfd_idx != ~0) ? \
102 pool_elt_at_index (file_main.file_pool, \
103 unixfd_idx)->file_descriptor : -1;
105 #define foreach_virtio_trace_flags \
106 _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
107 _ (SINGLE_DESC, 1, "Single descriptor packet") \
108 _ (INDIRECT, 2, "Indirect descriptor") \
109 _ (MAP_ERROR, 4, "Memory mapping error")
113 #define _(n,i,s) VIRTIO_TRACE_F_##n,
114 foreach_virtio_trace_flags
116 } virtio_trace_flag_t;
118 vlib_node_registration_t vhost_user_input_node;
120 #define foreach_vhost_user_tx_func_error \
121 _(NONE, "no error") \
122 _(NOT_READY, "vhost vring not ready") \
123 _(DOWN, "vhost interface is down") \
124 _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)") \
125 _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)") \
126 _(MMAP_FAIL, "mmap failure") \
127 _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
131 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
132 foreach_vhost_user_tx_func_error
134 VHOST_USER_TX_FUNC_N_ERROR,
135 } vhost_user_tx_func_error_t;
137 static char *vhost_user_tx_func_error_strings[] = {
139 foreach_vhost_user_tx_func_error
143 #define foreach_vhost_user_input_func_error \
144 _(NO_ERROR, "no error") \
145 _(NO_BUFFER, "no available buffer") \
146 _(MMAP_FAIL, "mmap failure") \
147 _(INDIRECT_OVERFLOW, "indirect descriptor overflows table") \
148 _(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
149 _(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")
153 #define _(f,s) VHOST_USER_INPUT_FUNC_ERROR_##f,
154 foreach_vhost_user_input_func_error
156 VHOST_USER_INPUT_FUNC_N_ERROR,
157 } vhost_user_input_func_error_t;
159 static char *vhost_user_input_func_error_strings[] = {
161 foreach_vhost_user_input_func_error
166 static vhost_user_main_t vhost_user_main = {
170 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
171 .name = "vhost-user",
176 format_vhost_user_interface_name (u8 * s, va_list * args)
178 u32 i = va_arg (*args, u32);
179 u32 show_dev_instance = ~0;
180 vhost_user_main_t *vum = &vhost_user_main;
182 if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
183 show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
185 if (show_dev_instance != ~0)
186 i = show_dev_instance;
188 s = format (s, "VirtualEthernet0/0/%d", i);
193 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
195 // FIXME: check if the new dev instance is already used
196 vhost_user_main_t *vum = &vhost_user_main;
197 vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
198 hi->dev_instance, ~0);
200 vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
203 DBG_SOCK ("renumbered vhost-user interface dev_instance %d to %d",
204 hi->dev_instance, new_dev_instance);
209 static_always_inline void *
210 map_guest_mem (vhost_user_intf_t * vui, uword addr, u32 * hint)
213 if (PREDICT_TRUE ((vui->regions[i].guest_phys_addr <= addr) &&
214 ((vui->regions[i].guest_phys_addr +
215 vui->regions[i].memory_size) > addr)))
217 return (void *) (vui->region_mmap_addr[i] + addr -
218 vui->regions[i].guest_phys_addr);
221 __m128i rl, rh, al, ah, r;
222 al = _mm_set1_epi64x (addr + 1);
223 ah = _mm_set1_epi64x (addr);
225 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[0]);
226 rl = _mm_cmpgt_epi64 (al, rl);
227 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[0]);
228 rh = _mm_cmpgt_epi64 (rh, ah);
229 r = _mm_and_si128 (rl, rh);
231 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[2]);
232 rl = _mm_cmpgt_epi64 (al, rl);
233 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[2]);
234 rh = _mm_cmpgt_epi64 (rh, ah);
235 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x22);
237 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[4]);
238 rl = _mm_cmpgt_epi64 (al, rl);
239 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[4]);
240 rh = _mm_cmpgt_epi64 (rh, ah);
241 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x44);
243 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[6]);
244 rl = _mm_cmpgt_epi64 (al, rl);
245 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[6]);
246 rh = _mm_cmpgt_epi64 (rh, ah);
247 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x88);
249 r = _mm_shuffle_epi8 (r, _mm_set_epi64x (0, 0x0e060c040a020800));
250 i = __builtin_ctzll (_mm_movemask_epi8 (r) |
251 (1 << VHOST_MEMORY_MAX_NREGIONS));
253 if (i < vui->nregions)
256 return (void *) (vui->region_mmap_addr[i] + addr -
257 vui->regions[i].guest_phys_addr);
261 for (i = 0; i < vui->nregions; i++)
263 if ((vui->regions[i].guest_phys_addr <= addr) &&
264 ((vui->regions[i].guest_phys_addr + vui->regions[i].memory_size) >
268 return (void *) (vui->region_mmap_addr[i] + addr -
269 vui->regions[i].guest_phys_addr);
273 DBG_VQ ("failed to map guest mem addr %llx", addr);
279 map_user_mem (vhost_user_intf_t * vui, uword addr)
282 for (i = 0; i < vui->nregions; i++)
284 if ((vui->regions[i].userspace_addr <= addr) &&
285 ((vui->regions[i].userspace_addr + vui->regions[i].memory_size) >
288 return (void *) (vui->region_mmap_addr[i] + addr -
289 vui->regions[i].userspace_addr);
296 get_huge_page_size (int fd)
304 unmap_all_mem_regions (vhost_user_intf_t * vui)
307 for (i = 0; i < vui->nregions; i++)
309 if (vui->region_mmap_addr[i] != (void *) -1)
312 long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
314 ssize_t map_sz = (vui->regions[i].memory_size +
315 vui->regions[i].mmap_offset +
316 page_sz - 1) & ~(page_sz - 1);
319 munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
323 ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
324 vui->region_mmap_addr[i], map_sz, page_sz);
326 vui->region_mmap_addr[i] = (void *) -1;
330 clib_warning ("failed to unmap memory region (errno %d)",
333 close (vui->region_mmap_fd[i]);
340 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
342 //Let's try to assign one queue to each thread
344 u32 thread_index = 0;
345 vui->use_tx_spinlock = 0;
348 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
350 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
351 if (!rxvq->started || !rxvq->enabled)
354 vui->per_cpu_tx_qid[thread_index] = qid;
356 if (thread_index == vlib_get_thread_main ()->n_vlib_mains)
359 //We need to loop, meaning the spinlock has to be used
360 vui->use_tx_spinlock = 1;
361 if (thread_index == 0)
363 //Could not find a single valid one
364 for (thread_index = 0;
365 thread_index < vlib_get_thread_main ()->n_vlib_mains;
368 vui->per_cpu_tx_qid[thread_index] = 0;
376 * @brief Unassign existing interface/queue to thread mappings and re-assign
377 * new interface/queue to thread mappings
380 vhost_user_rx_thread_placement ()
382 vhost_user_main_t *vum = &vhost_user_main;
383 vhost_user_intf_t *vui;
384 vhost_user_vring_t *txvq;
385 vnet_main_t *vnm = vnet_get_main ();
390 // Scrap all existing mappings for all interfaces/queues
392 pool_foreach (vui, vum->vhost_user_interfaces, {
393 vec_foreach (queue, vui->rx_queues)
395 rv = vnet_hw_interface_unassign_rx_thread (vnm, vui->hw_if_index,
398 clib_warning ("Warning: unable to unassign interface %d, "
399 "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
401 vec_reset_length (vui->rx_queues);
405 // Create the rx_queues for all interfaces
407 pool_foreach (vui, vum->vhost_user_interfaces, {
408 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
410 txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
413 if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
414 /* Set polling as the default */
415 txvq->mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
416 vec_add1 (vui->rx_queues, qid);
422 // Assign new mappings for all interfaces/queues
424 pool_foreach (vui, vum->vhost_user_interfaces, {
425 vnet_hw_interface_set_input_node (vnm, vui->hw_if_index,
426 vhost_user_input_node.index);
427 vec_foreach (queue, vui->rx_queues)
429 vnet_hw_interface_assign_rx_thread (vnm, vui->hw_if_index, *queue,
431 txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
432 rv = vnet_hw_interface_set_rx_mode (vnm, vui->hw_if_index, *queue,
435 clib_warning ("Warning: unable to set rx mode for interface %d, "
436 "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
442 /** @brief Returns whether at least one TX and one RX vring are enabled */
444 vhost_user_intf_ready (vhost_user_intf_t * vui)
446 int i, found[2] = { }; //RX + TX
448 for (i = 0; i < VHOST_VRING_MAX_N; i++)
449 if (vui->vrings[i].started && vui->vrings[i].enabled)
452 return found[0] && found[1];
456 vhost_user_update_iface_state (vhost_user_intf_t * vui)
458 /* if we have pointers to descriptor table, go up */
459 int is_up = vhost_user_intf_ready (vui);
460 if (is_up != vui->is_up)
462 DBG_SOCK ("interface %d %s", vui->sw_if_index,
463 is_up ? "ready" : "down");
464 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
465 is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
469 vhost_user_rx_thread_placement ();
470 vhost_user_tx_thread_placement (vui);
474 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
477 vnet_main_t *vnm = vnet_get_main ();
481 /* Only care about the odd number, or TX, virtqueue */
484 if (vhost_user_intf_ready (vui))
485 // qid >> 1 is to convert virtqueue number to vring queue index
486 vnet_device_input_set_interrupt_pending (vnm, vui->hw_if_index, qid >> 1);
489 static clib_error_t *
490 vhost_user_callfd_read_ready (clib_file_t * uf)
492 __attribute__ ((unused)) int n;
495 n = read (uf->file_descriptor, ((char *) &buff), 8);
500 static clib_error_t *
501 vhost_user_kickfd_read_ready (clib_file_t * uf)
503 __attribute__ ((unused)) int n;
505 vhost_user_intf_t *vui =
506 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
507 uf->private_data >> 8);
508 u32 qid = uf->private_data & 0xff;
510 n = read (uf->file_descriptor, ((char *) &buff), 8);
511 DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
512 if (!vui->vrings[qid].started ||
513 (vhost_user_intf_ready (vui) != vui->is_up))
515 vlib_worker_thread_barrier_sync (vlib_get_main ());
516 vui->vrings[qid].started = 1;
517 vhost_user_update_iface_state (vui);
518 vlib_worker_thread_barrier_release (vlib_get_main ());
521 vhost_user_set_interrupt_pending (vui, uf->private_data);
526 * @brief Try once to lock the vring
527 * @return 0 on success, non-zero on failure.
530 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
532 return __sync_lock_test_and_set (vui->vring_locks[qid], 1);
536 * @brief Spin until the vring is successfully locked
539 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
541 while (vhost_user_vring_try_lock (vui, qid))
546 * @brief Unlock the vring lock
549 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
551 *vui->vring_locks[qid] = 0;
555 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
557 vhost_user_vring_t *vring = &vui->vrings[qid];
558 memset (vring, 0, sizeof (*vring));
559 vring->kickfd_idx = ~0;
560 vring->callfd_idx = ~0;
564 * We have a bug with some qemu 2.5, and this may be a fix.
565 * Feel like interpretation holy text, but this is from vhost-user.txt.
567 * One queue pair is enabled initially. More queues are enabled
568 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
570 * Don't know who's right, but this is what DPDK does.
572 if (qid == 0 || qid == 1)
577 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
579 vhost_user_vring_t *vring = &vui->vrings[qid];
580 if (vring->kickfd_idx != ~0)
582 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
584 clib_file_del (&file_main, uf);
585 vring->kickfd_idx = ~0;
587 if (vring->callfd_idx != ~0)
589 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
591 clib_file_del (&file_main, uf);
592 vring->callfd_idx = ~0;
594 if (vring->errfd != -1)
596 close (vring->errfd);
599 vhost_user_vring_init (vui, qid);
603 vhost_user_if_disconnect (vhost_user_intf_t * vui)
605 vnet_main_t *vnm = vnet_get_main ();
608 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
610 if (vui->clib_file_index != ~0)
612 clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
613 vui->clib_file_index = ~0;
618 for (q = 0; q < VHOST_VRING_MAX_N; q++)
619 vhost_user_vring_close (vui, q);
621 unmap_all_mem_regions (vui);
622 DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
625 #define VHOST_LOG_PAGE 0x1000
626 static_always_inline void
627 vhost_user_log_dirty_pages_2 (vhost_user_intf_t * vui,
628 u64 addr, u64 len, u8 is_host_address)
630 if (PREDICT_TRUE (vui->log_base_addr == 0
631 || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
637 addr = pointer_to_uword (map_user_mem (vui, (uword) addr));
639 if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
641 DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
645 CLIB_MEMORY_BARRIER ();
646 u64 page = addr / VHOST_LOG_PAGE;
647 while (page * VHOST_LOG_PAGE < addr + len)
649 ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
654 static_always_inline void
655 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
657 vhost_user_log_dirty_pages_2 (vui, addr, len, 0);
660 #define vhost_user_log_dirty_ring(vui, vq, member) \
661 if (PREDICT_FALSE(vq->log_used)) { \
662 vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
663 sizeof(vq->used->member)); \
666 static clib_error_t *
667 vhost_user_socket_read (clib_file_t * uf)
670 int fd, number_of_fds = 0;
671 int fds[VHOST_MEMORY_MAX_NREGIONS];
672 vhost_user_msg_t msg;
675 vhost_user_main_t *vum = &vhost_user_main;
676 vhost_user_intf_t *vui;
677 struct cmsghdr *cmsg;
679 clib_file_t template = { 0 };
680 vnet_main_t *vnm = vnet_get_main ();
682 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
684 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
686 memset (&mh, 0, sizeof (mh));
687 memset (control, 0, sizeof (control));
689 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
692 /* set the payload */
693 iov[0].iov_base = (void *) &msg;
694 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
698 mh.msg_control = control;
699 mh.msg_controllen = sizeof (control);
701 n = recvmsg (uf->file_descriptor, &mh, 0);
703 /* Stop workers to avoid end of the world */
704 vlib_worker_thread_barrier_sync (vlib_get_main ());
706 if (n != VHOST_USER_MSG_HDR_SZ)
710 DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
714 DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
715 n, VHOST_USER_MSG_HDR_SZ);
720 if (mh.msg_flags & MSG_CTRUNC)
722 DBG_SOCK ("MSG_CTRUNC is set");
726 cmsg = CMSG_FIRSTHDR (&mh);
728 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
729 (cmsg->cmsg_type == SCM_RIGHTS) &&
730 (cmsg->cmsg_len - CMSG_LEN (0) <=
731 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
733 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
734 clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
737 /* version 1, no reply bit set */
738 if ((msg.flags & 7) != 1)
740 DBG_SOCK ("malformed message received. closing socket");
747 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
751 DBG_SOCK ("read failed %s", strerror (errno));
754 else if (rv != msg.size)
756 DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
763 case VHOST_USER_GET_FEATURES:
765 msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
766 (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
767 (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
768 (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
769 (1ULL << FEAT_VHOST_F_LOG_ALL) |
770 (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
771 (1ULL << FEAT_VIRTIO_NET_F_MQ) |
772 (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
773 (1ULL << FEAT_VIRTIO_F_VERSION_1);
774 msg.u64 &= vui->feature_mask;
775 msg.size = sizeof (msg.u64);
776 DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
777 vui->hw_if_index, msg.u64);
780 case VHOST_USER_SET_FEATURES:
781 DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
782 vui->hw_if_index, msg.u64);
784 vui->features = msg.u64;
787 ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
788 (1ULL << FEAT_VIRTIO_F_VERSION_1)))
789 vui->virtio_net_hdr_sz = 12;
791 vui->virtio_net_hdr_sz = 10;
794 (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
796 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
797 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
800 /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
801 vhost_user_vring_close(&vui->vrings[q]); */
805 case VHOST_USER_SET_MEM_TABLE:
806 DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
807 vui->hw_if_index, msg.memory.nregions);
809 if ((msg.memory.nregions < 1) ||
810 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
813 DBG_SOCK ("number of mem regions must be between 1 and %i",
814 VHOST_MEMORY_MAX_NREGIONS);
819 if (msg.memory.nregions != number_of_fds)
821 DBG_SOCK ("each memory region must have FD");
824 unmap_all_mem_regions (vui);
825 for (i = 0; i < msg.memory.nregions; i++)
827 clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
828 sizeof (vhost_user_memory_region_t));
830 long page_sz = get_huge_page_size (fds[i]);
832 /* align size to 2M page */
833 ssize_t map_sz = (vui->regions[i].memory_size +
834 vui->regions[i].mmap_offset +
835 page_sz - 1) & ~(page_sz - 1);
837 vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
838 MAP_SHARED, fds[i], 0);
839 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
840 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
841 vui->regions[i].memory_size;
844 ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
845 "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
848 if (vui->region_mmap_addr[i] == MAP_FAILED)
850 clib_warning ("failed to map memory. errno is %d", errno);
853 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
854 vui->region_mmap_fd[i] = fds[i];
856 vui->nregions = msg.memory.nregions;
859 case VHOST_USER_SET_VRING_NUM:
860 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
861 vui->hw_if_index, msg.state.index, msg.state.num);
863 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
864 (msg.state.num == 0) || /* it cannot be zero */
865 ((msg.state.num - 1) & msg.state.num)) /* must be power of 2 */
867 vui->vrings[msg.state.index].qsz_mask = msg.state.num - 1;
870 case VHOST_USER_SET_VRING_ADDR:
871 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
872 vui->hw_if_index, msg.state.index);
874 if (msg.state.index >= VHOST_VRING_MAX_N)
876 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
877 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
881 if (msg.size < sizeof (msg.addr))
883 DBG_SOCK ("vhost message is too short (%d < %d)",
884 msg.size, sizeof (msg.addr));
888 vui->vrings[msg.state.index].desc = (vring_desc_t *)
889 map_user_mem (vui, msg.addr.desc_user_addr);
890 vui->vrings[msg.state.index].used = (vring_used_t *)
891 map_user_mem (vui, msg.addr.used_user_addr);
892 vui->vrings[msg.state.index].avail = (vring_avail_t *)
893 map_user_mem (vui, msg.addr.avail_user_addr);
895 if ((vui->vrings[msg.state.index].desc == NULL) ||
896 (vui->vrings[msg.state.index].used == NULL) ||
897 (vui->vrings[msg.state.index].avail == NULL))
899 DBG_SOCK ("failed to map user memory for hw_if_index %d",
904 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
905 vui->vrings[msg.state.index].log_used =
906 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
908 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
909 the ring is initialized in an enabled state. */
910 if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
912 vui->vrings[msg.state.index].enabled = 1;
915 vui->vrings[msg.state.index].last_used_idx =
916 vui->vrings[msg.state.index].last_avail_idx =
917 vui->vrings[msg.state.index].used->idx;
919 /* tell driver that we don't want interrupts */
920 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
923 case VHOST_USER_SET_OWNER:
924 DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
927 case VHOST_USER_RESET_OWNER:
928 DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
931 case VHOST_USER_SET_VRING_CALL:
932 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL %d",
933 vui->hw_if_index, msg.u64);
935 q = (u8) (msg.u64 & 0xFF);
937 /* if there is old fd, delete and close it */
938 if (vui->vrings[q].callfd_idx != ~0)
940 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
941 vui->vrings[q].callfd_idx);
942 clib_file_del (&file_main, uf);
943 vui->vrings[q].callfd_idx = ~0;
946 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
948 if (number_of_fds != 1)
950 DBG_SOCK ("More than one fd received !");
954 template.read_function = vhost_user_callfd_read_ready;
955 template.file_descriptor = fds[0];
956 template.private_data =
957 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
958 vui->vrings[q].callfd_idx = clib_file_add (&file_main, &template);
961 vui->vrings[q].callfd_idx = ~0;
964 case VHOST_USER_SET_VRING_KICK:
965 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK %d",
966 vui->hw_if_index, msg.u64);
968 q = (u8) (msg.u64 & 0xFF);
970 if (vui->vrings[q].kickfd_idx != ~0)
972 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
973 vui->vrings[q].kickfd_idx);
974 clib_file_del (&file_main, uf);
975 vui->vrings[q].kickfd_idx = ~0;
978 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
980 if (number_of_fds != 1)
982 DBG_SOCK ("More than one fd received !");
986 template.read_function = vhost_user_kickfd_read_ready;
987 template.file_descriptor = fds[0];
988 template.private_data =
989 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
991 vui->vrings[q].kickfd_idx = clib_file_add (&file_main, &template);
995 //When no kickfd is set, the queue is initialized as started
996 vui->vrings[q].kickfd_idx = ~0;
997 vui->vrings[q].started = 1;
1002 case VHOST_USER_SET_VRING_ERR:
1003 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR %d",
1004 vui->hw_if_index, msg.u64);
1006 q = (u8) (msg.u64 & 0xFF);
1008 if (vui->vrings[q].errfd != -1)
1009 close (vui->vrings[q].errfd);
1011 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
1013 if (number_of_fds != 1)
1016 vui->vrings[q].errfd = fds[0];
1019 vui->vrings[q].errfd = -1;
1023 case VHOST_USER_SET_VRING_BASE:
1024 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1025 vui->hw_if_index, msg.state.index, msg.state.num);
1027 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
1030 case VHOST_USER_GET_VRING_BASE:
1031 if (msg.state.index >= VHOST_VRING_MAX_N)
1033 DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
1034 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1039 * Copy last_avail_idx from the vring before closing it because
1040 * closing the vring also initializes the vring last_avail_idx
1042 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
1044 msg.size = sizeof (msg.state);
1046 /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
1047 vhost_user_vring_close (vui, msg.state.index);
1048 DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1049 vui->hw_if_index, msg.state.index, msg.state.num);
1052 case VHOST_USER_NONE:
1053 DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
1057 case VHOST_USER_SET_LOG_BASE:
1059 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
1061 if (msg.size != sizeof (msg.log))
1064 ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
1065 msg.size, sizeof (msg.log));
1070 (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
1073 ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
1078 /* align size to 2M page */
1079 long page_sz = get_huge_page_size (fd);
1081 (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
1083 vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
1087 ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
1088 map_sz, msg.log.offset, fd, vui->log_base_addr);
1090 if (vui->log_base_addr == MAP_FAILED)
1092 clib_warning ("failed to map memory. errno is %d", errno);
1096 vui->log_base_addr += msg.log.offset;
1097 vui->log_size = msg.log.size;
1100 msg.size = sizeof (msg.u64);
1105 case VHOST_USER_SET_LOG_FD:
1106 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
1110 case VHOST_USER_GET_PROTOCOL_FEATURES:
1112 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
1113 (1 << VHOST_USER_PROTOCOL_F_MQ);
1114 msg.size = sizeof (msg.u64);
1116 ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES - reply 0x%016llx",
1117 vui->hw_if_index, msg.u64);
1120 case VHOST_USER_SET_PROTOCOL_FEATURES:
1122 ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%016llx",
1123 vui->hw_if_index, msg.u64);
1125 vui->protocol_features = msg.u64;
1129 case VHOST_USER_GET_QUEUE_NUM:
1131 msg.u64 = VHOST_VRING_MAX_N;
1132 msg.size = sizeof (msg.u64);
1133 DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM - reply %d",
1134 vui->hw_if_index, msg.u64);
1137 case VHOST_USER_SET_VRING_ENABLE:
1138 DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
1139 vui->hw_if_index, msg.state.num ? "enable" : "disable",
1141 if (msg.state.index >= VHOST_VRING_MAX_N)
1143 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
1144 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1148 vui->vrings[msg.state.index].enabled = msg.state.num;
1152 DBG_SOCK ("unknown vhost-user message %d received. closing socket",
1157 /* if we need to reply */
1161 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1162 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1164 DBG_SOCK ("could not send message response");
1169 vhost_user_update_iface_state (vui);
1170 vlib_worker_thread_barrier_release (vlib_get_main ());
1174 vhost_user_if_disconnect (vui);
1175 vhost_user_update_iface_state (vui);
1176 vlib_worker_thread_barrier_release (vlib_get_main ());
1180 static clib_error_t *
1181 vhost_user_socket_error (clib_file_t * uf)
1183 vlib_main_t *vm = vlib_get_main ();
1184 vhost_user_main_t *vum = &vhost_user_main;
1185 vhost_user_intf_t *vui =
1186 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1188 DBG_SOCK ("socket error on if %d", vui->sw_if_index);
1189 vlib_worker_thread_barrier_sync (vm);
1190 vhost_user_if_disconnect (vui);
1191 vhost_user_rx_thread_placement ();
1192 vlib_worker_thread_barrier_release (vm);
1196 static clib_error_t *
1197 vhost_user_socksvr_accept_ready (clib_file_t * uf)
1199 int client_fd, client_len;
1200 struct sockaddr_un client;
1201 clib_file_t template = { 0 };
1202 vhost_user_main_t *vum = &vhost_user_main;
1203 vhost_user_intf_t *vui;
1205 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1207 client_len = sizeof (client);
1208 client_fd = accept (uf->file_descriptor,
1209 (struct sockaddr *) &client,
1210 (socklen_t *) & client_len);
1213 return clib_error_return_unix (0, "accept");
1215 DBG_SOCK ("New client socket for vhost interface %d", vui->sw_if_index);
1216 template.read_function = vhost_user_socket_read;
1217 template.error_function = vhost_user_socket_error;
1218 template.file_descriptor = client_fd;
1219 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1220 vui->clib_file_index = clib_file_add (&file_main, &template);
1224 static clib_error_t *
1225 vhost_user_init (vlib_main_t * vm)
1227 clib_error_t *error;
1228 vhost_user_main_t *vum = &vhost_user_main;
1229 vlib_thread_main_t *tm = vlib_get_thread_main ();
1231 error = vlib_call_init_function (vm, ip4_init);
1235 vum->coalesce_frames = 32;
1236 vum->coalesce_time = 1e-3;
1238 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1241 vec_foreach (cpu, vum->cpus)
1243 /* This is actually not necessary as validate already zeroes it
1244 * Just keeping the loop here for later because I am lazy. */
1245 cpu->rx_buffers_len = 0;
1248 vum->random = random_default_seed ();
1250 mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
1255 VLIB_INIT_FUNCTION (vhost_user_init);
1258 format_vhost_trace (u8 * s, va_list * va)
1260 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
1261 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
1262 CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
1263 vhost_user_main_t *vum = &vhost_user_main;
1264 vhost_trace_t *t = va_arg (*va, vhost_trace_t *);
1265 vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
1268 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
1270 u32 indent = format_get_indent (s);
1272 s = format (s, "%U %U queue %d\n", format_white_space, indent,
1273 format_vnet_sw_interface_name, vnm, sw, t->qid);
1275 s = format (s, "%U virtio flags:\n", format_white_space, indent);
1277 if (t->virtio_ring_flags & (1 << VIRTIO_TRACE_F_##n)) \
1278 s = format (s, "%U %s %s\n", format_white_space, indent, #n, st);
1279 foreach_virtio_trace_flags
1281 s = format (s, "%U virtio_net_hdr first_desc_len %u\n",
1282 format_white_space, indent, t->first_desc_len);
1284 s = format (s, "%U flags 0x%02x gso_type %u\n",
1285 format_white_space, indent,
1286 t->hdr.hdr.flags, t->hdr.hdr.gso_type);
1288 if (vui->virtio_net_hdr_sz == 12)
1289 s = format (s, "%U num_buff %u",
1290 format_white_space, indent, t->hdr.num_buffers);
1296 vhost_user_rx_trace (vhost_trace_t * t,
1297 vhost_user_intf_t * vui, u16 qid,
1298 vlib_buffer_t * b, vhost_user_vring_t * txvq)
1300 vhost_user_main_t *vum = &vhost_user_main;
1301 u32 last_avail_idx = txvq->last_avail_idx;
1302 u32 desc_current = txvq->avail->ring[last_avail_idx & txvq->qsz_mask];
1303 vring_desc_t *hdr_desc = 0;
1304 virtio_net_hdr_mrg_rxbuf_t *hdr;
1307 memset (t, 0, sizeof (*t));
1308 t->device_index = vui - vum->vhost_user_interfaces;
1311 hdr_desc = &txvq->desc[desc_current];
1312 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1314 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1315 /* Header is the first here */
1316 hdr_desc = map_guest_mem (vui, txvq->desc[desc_current].addr, &hint);
1318 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1320 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1322 if (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1323 !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1325 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1328 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1330 if (!hdr_desc || !(hdr = map_guest_mem (vui, hdr_desc->addr, &hint)))
1332 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_MAP_ERROR;
1336 u32 len = vui->virtio_net_hdr_sz;
1337 memcpy (&t->hdr, hdr, len > hdr_desc->len ? hdr_desc->len : len);
1342 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1344 vhost_user_main_t *vum = &vhost_user_main;
1346 int fd = UNIX_GET_FD (vq->callfd_idx);
1349 rv = write (fd, &x, sizeof (x));
1353 ("Error: Could not write to unix socket for callfd %d", fd);
1357 vq->n_since_last_int = 0;
1358 vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1361 static_always_inline u32
1362 vhost_user_input_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1363 u16 copy_len, u32 * map_hint)
1365 void *src0, *src1, *src2, *src3;
1366 if (PREDICT_TRUE (copy_len >= 4))
1368 if (PREDICT_FALSE (!(src2 = map_guest_mem (vui, cpy[0].src, map_hint))))
1370 if (PREDICT_FALSE (!(src3 = map_guest_mem (vui, cpy[1].src, map_hint))))
1373 while (PREDICT_TRUE (copy_len >= 4))
1379 (!(src2 = map_guest_mem (vui, cpy[2].src, map_hint))))
1382 (!(src3 = map_guest_mem (vui, cpy[3].src, map_hint))))
1385 CLIB_PREFETCH (src2, 64, LOAD);
1386 CLIB_PREFETCH (src3, 64, LOAD);
1388 clib_memcpy ((void *) cpy[0].dst, src0, cpy[0].len);
1389 clib_memcpy ((void *) cpy[1].dst, src1, cpy[1].len);
1396 if (PREDICT_FALSE (!(src0 = map_guest_mem (vui, cpy->src, map_hint))))
1398 clib_memcpy ((void *) cpy->dst, src0, cpy->len);
1406 * Try to discard packets from the tx ring (VPP RX path).
1407 * Returns the number of discarded packets.
1410 vhost_user_rx_discard_packet (vlib_main_t * vm,
1411 vhost_user_intf_t * vui,
1412 vhost_user_vring_t * txvq, u32 discard_max)
1415 * On the RX side, each packet corresponds to one descriptor
1416 * (it is the same whether it is a shallow descriptor, chained, or indirect).
1417 * Therefore, discarding a packet is like discarding a descriptor.
1419 u32 discarded_packets = 0;
1420 u32 avail_idx = txvq->avail->idx;
1421 while (discarded_packets != discard_max)
1423 if (avail_idx == txvq->last_avail_idx)
1426 u16 desc_chain_head =
1427 txvq->avail->ring[txvq->last_avail_idx & txvq->qsz_mask];
1428 txvq->last_avail_idx++;
1429 txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].id =
1431 txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].len = 0;
1432 vhost_user_log_dirty_ring (vui, txvq,
1433 ring[txvq->last_used_idx & txvq->qsz_mask]);
1434 txvq->last_used_idx++;
1435 discarded_packets++;
1439 CLIB_MEMORY_BARRIER ();
1440 txvq->used->idx = txvq->last_used_idx;
1441 vhost_user_log_dirty_ring (vui, txvq, idx);
1442 return discarded_packets;
1446 * In case of overflow, we need to rewind the array of allocated buffers.
1449 vhost_user_input_rewind_buffers (vlib_main_t * vm,
1450 vhost_cpu_t * cpu, vlib_buffer_t * b_head)
1452 u32 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1453 vlib_buffer_t *b_current = vlib_get_buffer (vm, bi_current);
1454 b_current->current_length = 0;
1455 b_current->flags = 0;
1456 while (b_current != b_head)
1458 cpu->rx_buffers_len++;
1459 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1460 b_current = vlib_get_buffer (vm, bi_current);
1461 b_current->current_length = 0;
1462 b_current->flags = 0;
1464 cpu->rx_buffers_len++;
1468 vhost_user_if_input (vlib_main_t * vm,
1469 vhost_user_main_t * vum,
1470 vhost_user_intf_t * vui,
1471 u16 qid, vlib_node_runtime_t * node,
1472 vnet_hw_interface_rx_mode mode)
1474 vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
1475 u16 n_rx_packets = 0;
1478 u32 n_left_to_next, *to_next;
1479 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1480 u32 n_trace = vlib_get_trace_count (vm, node);
1482 u16 thread_index = vlib_get_thread_index ();
1486 /* do we have pending interrupts ? */
1487 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
1488 f64 now = vlib_time_now (vm);
1490 if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1491 vhost_user_send_call (vm, txvq);
1493 if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1494 vhost_user_send_call (vm, rxvq);
1498 * For adaptive mode, it is optimized to reduce interrupts.
1499 * If the scheduler switches the input node to polling due
1500 * to burst of traffic, we tell the driver no interrupt.
1501 * When the traffic subsides, the scheduler switches the node back to
1502 * interrupt mode. We must tell the driver we want interrupt.
1504 if (PREDICT_FALSE (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE))
1507 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE) ||
1509 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1510 /* Tell driver we want notification */
1511 txvq->used->flags = 0;
1513 /* Tell driver we don't want notification */
1514 txvq->used->flags = VRING_USED_F_NO_NOTIFY;
1517 if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1520 n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1523 if (PREDICT_FALSE (n_left == 0))
1526 if (PREDICT_FALSE (!vui->admin_up || !(txvq->enabled)))
1529 * Discard input packet if interface is admin down or vring is not
1531 * "For example, for a networking device, in the disabled state
1532 * client must not supply any new RX packets, but must process
1533 * and discard any TX packets."
1535 vhost_user_rx_discard_packet (vm, vui, txvq,
1536 VHOST_USER_DOWN_DISCARD_COUNT);
1540 if (PREDICT_FALSE (n_left == (txvq->qsz_mask + 1)))
1543 * Informational error logging when VPP is not
1544 * receiving packets fast enough.
1546 vlib_error_count (vm, node->node_index,
1547 VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1550 if (n_left > VLIB_FRAME_SIZE)
1551 n_left = VLIB_FRAME_SIZE;
1554 * For small packets (<2kB), we will not need more than one vlib buffer
1555 * per packet. In case packets are bigger, we will just yeld at some point
1556 * in the loop and come back later. This is not an issue as for big packet,
1557 * processing cost really comes from the memory copy.
1558 * The assumption is that big packets will fit in 40 buffers.
1560 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len < n_left + 1 ||
1561 vum->cpus[thread_index].rx_buffers_len < 40))
1563 u32 curr_len = vum->cpus[thread_index].rx_buffers_len;
1564 vum->cpus[thread_index].rx_buffers_len +=
1565 vlib_buffer_alloc_from_free_list (vm,
1566 vum->cpus[thread_index].rx_buffers +
1568 VHOST_USER_RX_BUFFERS_N - curr_len,
1569 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1572 (vum->cpus[thread_index].rx_buffers_len <
1573 VHOST_USER_RX_BUFFER_STARVATION))
1575 /* In case of buffer starvation, discard some packets from the queue
1576 * and log the event.
1577 * We keep doing best effort for the remaining packets. */
1578 u32 flush = (n_left + 1 > vum->cpus[thread_index].rx_buffers_len) ?
1579 n_left + 1 - vum->cpus[thread_index].rx_buffers_len : 1;
1580 flush = vhost_user_rx_discard_packet (vm, vui, txvq, flush);
1583 vlib_increment_simple_counter (vnet_main.
1584 interface_main.sw_if_counters +
1585 VNET_INTERFACE_COUNTER_DROP,
1586 vlib_get_thread_index (),
1587 vui->sw_if_index, flush);
1589 vlib_error_count (vm, vhost_user_input_node.index,
1590 VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1596 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1598 while (n_left > 0 && n_left_to_next > 0)
1600 vlib_buffer_t *b_head, *b_current;
1603 u32 desc_data_offset;
1604 vring_desc_t *desc_table = txvq->desc;
1606 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len <= 1))
1608 /* Not enough rx_buffers
1609 * Note: We yeld on 1 so we don't need to do an additional
1610 * check for the next buffer prefetch.
1617 txvq->avail->ring[txvq->last_avail_idx & txvq->qsz_mask];
1618 vum->cpus[thread_index].rx_buffers_len--;
1619 bi_current = (vum->cpus[thread_index].rx_buffers)
1620 [vum->cpus[thread_index].rx_buffers_len];
1621 b_head = b_current = vlib_get_buffer (vm, bi_current);
1622 to_next[0] = bi_current; //We do that now so we can forget about bi_current
1626 vlib_prefetch_buffer_with_index (vm,
1628 cpus[thread_index].rx_buffers)
1629 [vum->cpus[thread_index].
1630 rx_buffers_len - 1], LOAD);
1632 /* Just preset the used descriptor id and length for later */
1633 txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].id =
1635 txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].len = 0;
1636 vhost_user_log_dirty_ring (vui, txvq,
1637 ring[txvq->last_used_idx &
1640 /* The buffer should already be initialized */
1641 b_head->total_length_not_including_first_buffer = 0;
1642 b_head->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1644 if (PREDICT_FALSE (n_trace))
1646 //TODO: next_index is not exactly known at that point
1647 vlib_trace_buffer (vm, node, next_index, b_head,
1648 /* follow_chain */ 0);
1650 vlib_add_trace (vm, node, b_head, sizeof (t0[0]));
1651 vhost_user_rx_trace (t0, vui, qid, b_head, txvq);
1653 vlib_set_trace_count (vm, node, n_trace);
1656 /* This depends on the setup but is very consistent
1657 * So I think the CPU branch predictor will make a pretty good job
1658 * at optimizing the decision. */
1659 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1661 desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1664 if (PREDICT_FALSE (desc_table == 0))
1666 vlib_error_count (vm, node->node_index,
1667 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1672 if (PREDICT_TRUE (vui->is_any_layout) ||
1673 (!(desc_table[desc_current].flags & VIRTQ_DESC_F_NEXT)))
1675 /* ANYLAYOUT or single buffer */
1676 desc_data_offset = vui->virtio_net_hdr_sz;
1680 /* CSR case without ANYLAYOUT, skip 1st buffer */
1681 desc_data_offset = desc_table[desc_current].len;
1686 /* Get more input if necessary. Or end of packet. */
1687 if (desc_data_offset == desc_table[desc_current].len)
1689 if (PREDICT_FALSE (desc_table[desc_current].flags &
1692 desc_current = desc_table[desc_current].next;
1693 desc_data_offset = 0;
1701 /* Get more output if necessary. Or end of packet. */
1703 (b_current->current_length == VLIB_BUFFER_DATA_SIZE))
1706 (vum->cpus[thread_index].rx_buffers_len == 0))
1708 /* Cancel speculation */
1713 * Checking if there are some left buffers.
1714 * If not, just rewind the used buffers and stop.
1715 * Note: Scheduled copies are not cancelled. This is
1716 * not an issue as they would still be valid. Useless,
1719 vhost_user_input_rewind_buffers (vm,
1727 /* Get next output */
1728 vum->cpus[thread_index].rx_buffers_len--;
1730 (vum->cpus[thread_index].rx_buffers)[vum->cpus
1731 [thread_index].rx_buffers_len];
1732 b_current->next_buffer = bi_next;
1733 b_current->flags |= VLIB_BUFFER_NEXT_PRESENT;
1734 bi_current = bi_next;
1735 b_current = vlib_get_buffer (vm, bi_current);
1738 /* Prepare a copy order executed later for the data */
1739 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
1742 desc_table[desc_current].len - desc_data_offset;
1743 cpy->len = VLIB_BUFFER_DATA_SIZE - b_current->current_length;
1744 cpy->len = (cpy->len > desc_data_l) ? desc_data_l : cpy->len;
1745 cpy->dst = (uword) (vlib_buffer_get_current (b_current) +
1746 b_current->current_length);
1747 cpy->src = desc_table[desc_current].addr + desc_data_offset;
1749 desc_data_offset += cpy->len;
1751 b_current->current_length += cpy->len;
1752 b_head->total_length_not_including_first_buffer += cpy->len;
1756 CLIB_PREFETCH (&n_left, sizeof (n_left), LOAD);
1758 n_rx_bytes += b_head->total_length_not_including_first_buffer;
1761 b_head->total_length_not_including_first_buffer -=
1762 b_head->current_length;
1764 /* consume the descriptor and return it as used */
1765 txvq->last_avail_idx++;
1766 txvq->last_used_idx++;
1768 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1770 vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1771 vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1775 u32 next0 = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1777 /* redirect if feature path enabled */
1778 vnet_feature_start_device_input_x1 (vui->sw_if_index, &next0,
1781 u32 bi = to_next[-1]; //Cannot use to_next[-1] in the macro
1782 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1783 to_next, n_left_to_next,
1790 * Although separating memory copies from virtio ring parsing
1791 * is beneficial, we can offer to perform the copies from time
1792 * to time in order to free some space in the ring.
1794 if (PREDICT_FALSE (copy_len >= VHOST_USER_RX_COPY_THRESHOLD))
1797 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1798 copy_len, &map_hint)))
1800 vlib_error_count (vm, node->node_index,
1801 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1805 /* give buffers back to driver */
1806 CLIB_MEMORY_BARRIER ();
1807 txvq->used->idx = txvq->last_used_idx;
1808 vhost_user_log_dirty_ring (vui, txvq, idx);
1812 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1815 /* Do the memory copies */
1817 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1818 copy_len, &map_hint)))
1820 vlib_error_count (vm, node->node_index,
1821 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1824 /* give buffers back to driver */
1825 CLIB_MEMORY_BARRIER ();
1826 txvq->used->idx = txvq->last_used_idx;
1827 vhost_user_log_dirty_ring (vui, txvq, idx);
1829 /* interrupt (call) handling */
1830 if ((txvq->callfd_idx != ~0) &&
1831 !(txvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
1833 txvq->n_since_last_int += n_rx_packets;
1835 if (txvq->n_since_last_int > vum->coalesce_frames)
1836 vhost_user_send_call (vm, txvq);
1839 /* increase rx counters */
1840 vlib_increment_combined_counter
1841 (vnet_main.interface_main.combined_sw_if_counters
1842 + VNET_INTERFACE_COUNTER_RX,
1843 vlib_get_thread_index (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1845 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
1847 return n_rx_packets;
1851 vhost_user_input (vlib_main_t * vm,
1852 vlib_node_runtime_t * node, vlib_frame_t * f)
1854 vhost_user_main_t *vum = &vhost_user_main;
1855 uword n_rx_packets = 0;
1856 vhost_user_intf_t *vui;
1857 vnet_device_input_runtime_t *rt =
1858 (vnet_device_input_runtime_t *) node->runtime_data;
1859 vnet_device_and_queue_t *dq;
1861 vec_foreach (dq, rt->devices_and_queues)
1863 if (clib_smp_swap (&dq->interrupt_pending, 0) ||
1864 (node->state == VLIB_NODE_STATE_POLLING))
1867 pool_elt_at_index (vum->vhost_user_interfaces, dq->dev_instance);
1868 n_rx_packets = vhost_user_if_input (vm, vum, vui, dq->queue_id, node,
1873 return n_rx_packets;
1877 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1878 .function = vhost_user_input,
1879 .type = VLIB_NODE_TYPE_INPUT,
1880 .name = "vhost-user-input",
1881 .sibling_of = "device-input",
1883 /* Will be enabled if/when hardware is detected. */
1884 .state = VLIB_NODE_STATE_DISABLED,
1886 .format_buffer = format_ethernet_header_with_length,
1887 .format_trace = format_vhost_trace,
1889 .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1890 .error_strings = vhost_user_input_func_error_strings,
1893 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
1898 vhost_user_tx_trace (vhost_trace_t * t,
1899 vhost_user_intf_t * vui, u16 qid,
1900 vlib_buffer_t * b, vhost_user_vring_t * rxvq)
1902 vhost_user_main_t *vum = &vhost_user_main;
1903 u32 last_avail_idx = rxvq->last_avail_idx;
1904 u32 desc_current = rxvq->avail->ring[last_avail_idx & rxvq->qsz_mask];
1905 vring_desc_t *hdr_desc = 0;
1908 memset (t, 0, sizeof (*t));
1909 t->device_index = vui - vum->vhost_user_interfaces;
1912 hdr_desc = &rxvq->desc[desc_current];
1913 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1915 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1916 /* Header is the first here */
1917 hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
1919 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1921 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1923 if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1924 !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1926 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1929 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1932 static_always_inline u32
1933 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1934 u16 copy_len, u32 * map_hint)
1936 void *dst0, *dst1, *dst2, *dst3;
1937 if (PREDICT_TRUE (copy_len >= 4))
1939 if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
1941 if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
1943 while (PREDICT_TRUE (copy_len >= 4))
1949 (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
1952 (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
1955 CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
1956 CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
1958 clib_memcpy (dst0, (void *) cpy[0].src, cpy[0].len);
1959 clib_memcpy (dst1, (void *) cpy[1].src, cpy[1].len);
1961 vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
1962 vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
1969 if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
1971 clib_memcpy (dst0, (void *) cpy->src, cpy->len);
1972 vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
1981 vhost_user_tx (vlib_main_t * vm,
1982 vlib_node_runtime_t * node, vlib_frame_t * frame)
1984 u32 *buffers = vlib_frame_args (frame);
1985 u32 n_left = frame->n_vectors;
1986 vhost_user_main_t *vum = &vhost_user_main;
1987 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
1988 vhost_user_intf_t *vui =
1989 pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
1991 vhost_user_vring_t *rxvq;
1993 u32 thread_index = vlib_get_thread_index ();
1999 if (PREDICT_FALSE (!vui->admin_up))
2001 error = VHOST_USER_TX_FUNC_ERROR_DOWN;
2005 if (PREDICT_FALSE (!vui->is_up))
2007 error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
2012 VHOST_VRING_IDX_RX (*vec_elt_at_index
2013 (vui->per_cpu_tx_qid, thread_index));
2014 rxvq = &vui->vrings[qid];
2015 if (PREDICT_FALSE (vui->use_tx_spinlock))
2016 vhost_user_vring_lock (vui, qid);
2019 error = VHOST_USER_TX_FUNC_ERROR_NONE;
2024 vlib_buffer_t *b0, *current_b0;
2025 u16 desc_head, desc_index, desc_len;
2026 vring_desc_t *desc_table;
2027 uword buffer_map_addr;
2031 if (PREDICT_TRUE (n_left > 1))
2032 vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
2034 b0 = vlib_get_buffer (vm, buffers[0]);
2036 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2038 vum->cpus[thread_index].current_trace =
2039 vlib_add_trace (vm, node, b0,
2040 sizeof (*vum->cpus[thread_index].current_trace));
2041 vhost_user_tx_trace (vum->cpus[thread_index].current_trace,
2042 vui, qid / 2, b0, rxvq);
2045 if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
2047 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2051 desc_table = rxvq->desc;
2052 desc_head = desc_index =
2053 rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
2055 /* Go deeper in case of indirect descriptor
2056 * I don't know of any driver providing indirect for RX. */
2057 if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2060 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2062 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2067 map_guest_mem (vui, rxvq->desc[desc_index].addr,
2070 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2076 desc_len = vui->virtio_net_hdr_sz;
2077 buffer_map_addr = desc_table[desc_index].addr;
2078 buffer_len = desc_table[desc_index].len;
2081 // Get a header from the header array
2082 virtio_net_hdr_mrg_rxbuf_t *hdr =
2083 &vum->cpus[thread_index].tx_headers[tx_headers_len];
2086 hdr->hdr.gso_type = 0;
2087 hdr->num_buffers = 1; //This is local, no need to check
2089 // Prepare a copy order executed later for the header
2090 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2092 cpy->len = vui->virtio_net_hdr_sz;
2093 cpy->dst = buffer_map_addr;
2094 cpy->src = (uword) hdr;
2097 buffer_map_addr += vui->virtio_net_hdr_sz;
2098 buffer_len -= vui->virtio_net_hdr_sz;
2099 bytes_left = b0->current_length;
2103 if (buffer_len == 0)
2105 if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
2107 //Next one is chained
2108 desc_index = desc_table[desc_index].next;
2109 buffer_map_addr = desc_table[desc_index].addr;
2110 buffer_len = desc_table[desc_index].len;
2112 else if (vui->virtio_net_hdr_sz == 12) //MRG is available
2114 virtio_net_hdr_mrg_rxbuf_t *hdr =
2115 &vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2117 //Move from available to used buffer
2118 rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id =
2120 rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len =
2122 vhost_user_log_dirty_ring (vui, rxvq,
2123 ring[rxvq->last_used_idx &
2126 rxvq->last_avail_idx++;
2127 rxvq->last_used_idx++;
2132 (rxvq->last_avail_idx == rxvq->avail->idx))
2134 //Dequeue queued descriptors for this packet
2135 rxvq->last_used_idx -= hdr->num_buffers - 1;
2136 rxvq->last_avail_idx -= hdr->num_buffers - 1;
2137 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2141 desc_table = rxvq->desc;
2142 desc_head = desc_index =
2143 rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
2145 (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2147 //It is seriously unlikely that a driver will put indirect descriptor
2148 //after non-indirect descriptor.
2150 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2152 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2158 rxvq->desc[desc_index].addr,
2161 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2166 buffer_map_addr = desc_table[desc_index].addr;
2167 buffer_len = desc_table[desc_index].len;
2171 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
2177 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2179 cpy->len = bytes_left;
2180 cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
2181 cpy->dst = buffer_map_addr;
2182 cpy->src = (uword) vlib_buffer_get_current (current_b0) +
2183 current_b0->current_length - bytes_left;
2185 bytes_left -= cpy->len;
2186 buffer_len -= cpy->len;
2187 buffer_map_addr += cpy->len;
2188 desc_len += cpy->len;
2190 CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
2193 // Check if vlib buffer has more data. If not, get more or break.
2194 if (PREDICT_TRUE (!bytes_left))
2197 (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
2199 current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
2200 bytes_left = current_b0->current_length;
2210 //Move from available to used ring
2211 rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id = desc_head;
2212 rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len = desc_len;
2213 vhost_user_log_dirty_ring (vui, rxvq,
2214 ring[rxvq->last_used_idx & rxvq->qsz_mask]);
2215 rxvq->last_avail_idx++;
2216 rxvq->last_used_idx++;
2218 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2220 vum->cpus[thread_index].current_trace->hdr =
2221 vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2224 n_left--; //At the end for error counting when 'goto done' is invoked
2227 * Do the copy periodically to prevent
2228 * vum->cpus[thread_index].copy array overflow and corrupt memory
2230 if (PREDICT_FALSE (copy_len >= VHOST_USER_TX_COPY_THRESHOLD))
2233 (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2234 copy_len, &map_hint)))
2236 vlib_error_count (vm, node->node_index,
2237 VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
2241 /* give buffers back to driver */
2242 CLIB_MEMORY_BARRIER ();
2243 rxvq->used->idx = rxvq->last_used_idx;
2244 vhost_user_log_dirty_ring (vui, rxvq, idx);
2250 //Do the memory copies
2252 (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2253 copy_len, &map_hint)))
2255 vlib_error_count (vm, node->node_index,
2256 VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
2259 CLIB_MEMORY_BARRIER ();
2260 rxvq->used->idx = rxvq->last_used_idx;
2261 vhost_user_log_dirty_ring (vui, rxvq, idx);
2264 * When n_left is set, error is always set to something too.
2265 * In case error is due to lack of remaining buffers, we go back up and
2267 * The idea is that it is better to waste some time on packets
2268 * that have been processed already than dropping them and get
2269 * more fresh packets with a good likelyhood that they will be dropped too.
2270 * This technique also gives more time to VM driver to pick-up packets.
2271 * In case the traffic flows from physical to virtual interfaces, this
2272 * technique will end-up leveraging the physical NIC buffer in order to
2273 * absorb the VM's CPU jitter.
2275 if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
2281 /* interrupt (call) handling */
2282 if ((rxvq->callfd_idx != ~0) &&
2283 !(rxvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
2285 rxvq->n_since_last_int += frame->n_vectors - n_left;
2287 if (rxvq->n_since_last_int > vum->coalesce_frames)
2288 vhost_user_send_call (vm, rxvq);
2291 vhost_user_vring_unlock (vui, qid);
2294 if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
2296 vlib_error_count (vm, node->node_index, error, n_left);
2297 vlib_increment_simple_counter
2298 (vnet_main.interface_main.sw_if_counters
2299 + VNET_INTERFACE_COUNTER_DROP,
2300 thread_index, vui->sw_if_index, n_left);
2303 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
2304 return frame->n_vectors;
2308 vhost_user_send_interrupt_process (vlib_main_t * vm,
2309 vlib_node_runtime_t * rt, vlib_frame_t * f)
2311 vhost_user_intf_t *vui;
2312 f64 timeout = 3153600000.0 /* 100 years */ ;
2313 uword event_type, *event_data = 0;
2314 vhost_user_main_t *vum = &vhost_user_main;
2316 f64 now, poll_time_remaining;
2322 poll_time_remaining =
2323 vlib_process_wait_for_event_or_clock (vm, timeout);
2324 event_type = vlib_process_get_events (vm, &event_data);
2325 vec_reset_length (event_data);
2328 * Use the remaining timeout if it is less than coalesce time to avoid
2329 * resetting the existing timer in the middle of expiration
2331 timeout = poll_time_remaining;
2332 if (vlib_process_suspend_time_is_zero (timeout) ||
2333 (timeout > vum->coalesce_time))
2334 timeout = vum->coalesce_time;
2336 now = vlib_time_now (vm);
2339 case VHOST_USER_EVENT_STOP_TIMER:
2343 case VHOST_USER_EVENT_START_TIMER:
2345 if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
2351 pool_foreach (vui, vum->vhost_user_interfaces, {
2352 next_timeout = timeout;
2353 vec_foreach (queue, vui->rx_queues)
2355 vhost_user_vring_t *rxvq =
2356 &vui->vrings[VHOST_VRING_IDX_RX (*queue)];
2357 vhost_user_vring_t *txvq =
2358 &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
2360 if (txvq->n_since_last_int)
2362 if (now >= txvq->int_deadline)
2363 vhost_user_send_call (vm, txvq);
2365 next_timeout = txvq->int_deadline - now;
2368 if (rxvq->n_since_last_int)
2370 if (now >= rxvq->int_deadline)
2371 vhost_user_send_call (vm, rxvq);
2373 next_timeout = rxvq->int_deadline - now;
2376 if ((next_timeout < timeout) && (next_timeout > 0.0))
2377 timeout = next_timeout;
2384 clib_warning ("BUG: unhandled event type %d", event_type);
2387 /* No less than 1 millisecond */
2391 timeout = 3153600000.0;
2397 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node,static) = {
2398 .function = vhost_user_send_interrupt_process,
2399 .type = VLIB_NODE_TYPE_PROCESS,
2400 .name = "vhost-user-send-interrupt-process",
2404 static clib_error_t *
2405 vhost_user_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index,
2406 u32 qid, vnet_hw_interface_rx_mode mode)
2408 vlib_main_t *vm = vnm->vlib_main;
2409 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2410 vhost_user_main_t *vum = &vhost_user_main;
2411 vhost_user_intf_t *vui =
2412 pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2413 vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
2415 if ((mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2416 (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE))
2418 if (txvq->kickfd_idx == ~0)
2420 // We cannot support interrupt mode if the driver opts out
2421 return clib_error_return (0, "Driver does not support interrupt");
2423 if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2426 // Start the timer if this is the first encounter on interrupt
2428 if ((vum->ifq_count == 1) &&
2429 (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2430 vlib_process_signal_event (vm,
2431 vhost_user_send_interrupt_node.index,
2432 VHOST_USER_EVENT_START_TIMER, 0);
2435 else if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2437 if (((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2438 (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)) &&
2442 // Stop the timer if there is no more interrupt interface/queue
2443 if ((vum->ifq_count == 0) &&
2444 (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2445 vlib_process_signal_event (vm,
2446 vhost_user_send_interrupt_node.index,
2447 VHOST_USER_EVENT_STOP_TIMER, 0);
2452 if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2453 txvq->used->flags = VRING_USED_F_NO_NOTIFY;
2454 else if ((mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE) ||
2455 (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT))
2456 txvq->used->flags = 0;
2459 clib_warning ("BUG: unhandled mode %d changed for if %d queue %d", mode,
2461 return clib_error_return (0, "unsupported");
2467 static clib_error_t *
2468 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
2471 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2472 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
2473 vhost_user_main_t *vum = &vhost_user_main;
2474 vhost_user_intf_t *vui =
2475 pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2477 vui->admin_up = is_up;
2479 if (is_up && vui->is_up)
2480 vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
2481 VNET_HW_INTERFACE_FLAG_LINK_UP);
2483 return /* no error */ 0;
2487 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
2488 .name = "vhost-user",
2489 .tx_function = vhost_user_tx,
2490 .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
2491 .tx_function_error_strings = vhost_user_tx_func_error_strings,
2492 .format_device_name = format_vhost_user_interface_name,
2493 .name_renumber = vhost_user_name_renumber,
2494 .admin_up_down_function = vhost_user_interface_admin_up_down,
2495 .rx_mode_change_function = vhost_user_interface_rx_mode_change,
2496 .format_tx_trace = format_vhost_trace,
2499 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
2504 vhost_user_process (vlib_main_t * vm,
2505 vlib_node_runtime_t * rt, vlib_frame_t * f)
2507 vhost_user_main_t *vum = &vhost_user_main;
2508 vhost_user_intf_t *vui;
2509 struct sockaddr_un sun;
2511 clib_file_t template = { 0 };
2512 f64 timeout = 3153600000.0 /* 100 years */ ;
2513 uword *event_data = 0;
2516 sun.sun_family = AF_UNIX;
2517 template.read_function = vhost_user_socket_read;
2518 template.error_function = vhost_user_socket_error;
2522 vlib_process_wait_for_event_or_clock (vm, timeout);
2523 vlib_process_get_events (vm, &event_data);
2524 vec_reset_length (event_data);
2529 pool_foreach (vui, vum->vhost_user_interfaces, {
2531 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
2532 if (vui->clib_file_index == ~0)
2535 ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
2538 * 1st time error or new error for this interface,
2539 * spit out the message and record the error
2541 if (!vui->sock_errno || (vui->sock_errno != errno))
2544 ("Error: Could not open unix socket for %s",
2545 vui->sock_filename);
2546 vui->sock_errno = errno;
2551 /* try to connect */
2552 strncpy (sun.sun_path, (char *) vui->sock_filename,
2553 sizeof (sun.sun_path) - 1);
2555 /* Avoid hanging VPP if the other end does not accept */
2556 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
2557 clib_unix_warning ("fcntl");
2559 if (connect (sockfd, (struct sockaddr *) &sun,
2560 sizeof (struct sockaddr_un)) == 0)
2562 /* Set the socket to blocking as it was before */
2563 if (fcntl(sockfd, F_SETFL, 0) < 0)
2564 clib_unix_warning ("fcntl2");
2566 vui->sock_errno = 0;
2567 template.file_descriptor = sockfd;
2568 template.private_data =
2569 vui - vhost_user_main.vhost_user_interfaces;
2570 vui->clib_file_index = clib_file_add (&file_main, &template);
2572 /* This sockfd is considered consumed */
2577 vui->sock_errno = errno;
2582 /* check if socket is alive */
2584 socklen_t len = sizeof (error);
2585 int fd = UNIX_GET_FD(vui->clib_file_index);
2587 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
2591 DBG_SOCK ("getsockopt returned %d", retval);
2592 vhost_user_if_disconnect (vui);
2603 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
2604 .function = vhost_user_process,
2605 .type = VLIB_NODE_TYPE_PROCESS,
2606 .name = "vhost-user-process",
2611 * Disables and reset interface structure.
2612 * It can then be either init again, or removed from used interfaces.
2615 vhost_user_term_if (vhost_user_intf_t * vui)
2618 vhost_user_main_t *vum = &vhost_user_main;
2620 // disconnect interface sockets
2621 vhost_user_if_disconnect (vui);
2622 vhost_user_update_iface_state (vui);
2624 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2626 clib_mem_free ((void *) vui->vring_locks[q]);
2629 if (vui->unix_server_index != ~0)
2631 //Close server socket
2632 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
2633 vui->unix_server_index);
2634 clib_file_del (&file_main, uf);
2635 vui->unix_server_index = ~0;
2636 unlink (vui->sock_filename);
2639 mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
2644 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
2646 vhost_user_main_t *vum = &vhost_user_main;
2647 vhost_user_intf_t *vui;
2649 vnet_hw_interface_t *hwif;
2652 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2653 hwif->dev_class_index != vhost_user_dev_class.index)
2654 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2656 DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
2657 hwif->name, hwif->dev_instance);
2659 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2661 vec_foreach (queue, vui->rx_queues)
2663 vhost_user_vring_t *txvq;
2665 txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
2666 if ((vum->ifq_count > 0) &&
2667 ((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2668 (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)))
2671 // Stop the timer if there is no more interrupt interface/queue
2672 if ((vum->ifq_count == 0) &&
2673 (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2675 vlib_process_signal_event (vm,
2676 vhost_user_send_interrupt_node.index,
2677 VHOST_USER_EVENT_STOP_TIMER, 0);
2683 // Disable and reset interface
2684 vhost_user_term_if (vui);
2686 // Reset renumbered iface
2687 if (hwif->dev_instance <
2688 vec_len (vum->show_dev_instance_by_real_dev_instance))
2689 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
2691 // Delete ethernet interface
2692 ethernet_delete_interface (vnm, vui->hw_if_index);
2695 pool_put (vum->vhost_user_interfaces, vui);
2700 static clib_error_t *
2701 vhost_user_exit (vlib_main_t * vm)
2703 vnet_main_t *vnm = vnet_get_main ();
2704 vhost_user_main_t *vum = &vhost_user_main;
2705 vhost_user_intf_t *vui;
2707 vlib_worker_thread_barrier_sync (vlib_get_main ());
2709 pool_foreach (vui, vum->vhost_user_interfaces, {
2710 vhost_user_delete_if (vnm, vm, vui->sw_if_index);
2713 vlib_worker_thread_barrier_release (vlib_get_main ());
2717 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
2720 * Open server unix socket on specified sock_filename.
2723 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
2726 struct sockaddr_un un = { };
2728 /* create listening socket */
2729 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
2730 return VNET_API_ERROR_SYSCALL_ERROR_1;
2732 un.sun_family = AF_UNIX;
2733 strncpy ((char *) un.sun_path, (char *) sock_filename,
2734 sizeof (un.sun_path) - 1);
2736 /* remove if exists */
2737 unlink ((char *) sock_filename);
2739 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
2741 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
2745 if (listen (fd, 1) == -1)
2747 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
2760 * Create ethernet interface for vhost user interface.
2763 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
2764 vhost_user_intf_t * vui, u8 * hwaddress)
2766 vhost_user_main_t *vum = &vhost_user_main;
2768 clib_error_t *error;
2770 /* create hw and sw interface */
2773 clib_memcpy (hwaddr, hwaddress, 6);
2777 random_u32 (&vum->random);
2778 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
2783 error = ethernet_register_interface
2785 vhost_user_dev_class.index,
2786 vui - vum->vhost_user_interfaces /* device instance */ ,
2787 hwaddr /* ethernet address */ ,
2788 &vui->hw_if_index, 0 /* flag change */ );
2791 clib_error_report (error);
2793 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, vui->hw_if_index);
2794 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
2798 * Initialize vui with specified attributes
2801 vhost_user_vui_init (vnet_main_t * vnm,
2802 vhost_user_intf_t * vui,
2804 const char *sock_filename,
2805 u64 feature_mask, u32 * sw_if_index)
2807 vnet_sw_interface_t *sw;
2809 vhost_user_main_t *vum = &vhost_user_main;
2810 vnet_hw_interface_t *hw;
2812 hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
2813 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
2814 if (server_sock_fd != -1)
2816 clib_file_t template = { 0 };
2817 template.read_function = vhost_user_socksvr_accept_ready;
2818 template.file_descriptor = server_sock_fd;
2819 template.private_data = vui - vum->vhost_user_interfaces; //hw index
2820 vui->unix_server_index = clib_file_add (&file_main, &template);
2824 vui->unix_server_index = ~0;
2827 vui->sw_if_index = sw->sw_if_index;
2828 strncpy (vui->sock_filename, sock_filename,
2829 ARRAY_LEN (vui->sock_filename) - 1);
2830 vui->sock_errno = 0;
2832 vui->feature_mask = feature_mask;
2833 vui->clib_file_index = ~0;
2834 vui->log_base_addr = 0;
2835 vui->if_index = vui - vum->vhost_user_interfaces;
2836 mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
2839 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2840 vhost_user_vring_init (vui, q);
2842 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
2843 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
2846 *sw_if_index = vui->sw_if_index;
2848 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2850 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
2851 CLIB_CACHE_LINE_BYTES);
2852 memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
2855 vec_validate (vui->per_cpu_tx_qid,
2856 vlib_get_thread_main ()->n_vlib_mains - 1);
2857 vhost_user_tx_thread_placement (vui);
2861 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2862 const char *sock_filename,
2866 u8 renumber, u32 custom_dev_instance, u8 * hwaddr)
2868 vhost_user_intf_t *vui = NULL;
2871 int server_sock_fd = -1;
2872 vhost_user_main_t *vum = &vhost_user_main;
2875 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2877 return VNET_API_ERROR_INVALID_ARGUMENT;
2880 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
2885 vui = &vum->vhost_user_interfaces[*if_index];
2886 *sw_if_index = vui->sw_if_index;
2888 return VNET_API_ERROR_IF_ALREADY_EXISTS;
2894 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
2900 pool_get (vhost_user_main.vhost_user_interfaces, vui);
2902 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2903 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
2904 feature_mask, &sw_if_idx);
2907 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2910 *sw_if_index = sw_if_idx;
2912 // Process node must connect
2913 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2919 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2920 const char *sock_filename,
2923 u64 feature_mask, u8 renumber, u32 custom_dev_instance)
2925 vhost_user_main_t *vum = &vhost_user_main;
2926 vhost_user_intf_t *vui = NULL;
2928 int server_sock_fd = -1;
2930 vnet_hw_interface_t *hwif;
2933 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2934 hwif->dev_class_index != vhost_user_dev_class.index)
2935 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2937 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2938 return VNET_API_ERROR_INVALID_ARGUMENT;
2940 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2943 * Disallow changing the interface to have the same path name
2944 * as other interface
2946 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
2947 if (if_index && (*if_index != vui->if_index))
2948 return VNET_API_ERROR_IF_ALREADY_EXISTS;
2950 // First try to open server socket
2952 if ((rv = vhost_user_init_server_sock (sock_filename,
2953 &server_sock_fd)) != 0)
2956 vhost_user_term_if (vui);
2957 vhost_user_vui_init (vnm, vui, server_sock_fd,
2958 sock_filename, feature_mask, &sw_if_idx);
2961 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2963 // Process node must connect
2964 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2970 vhost_user_connect_command_fn (vlib_main_t * vm,
2971 unformat_input_t * input,
2972 vlib_cli_command_t * cmd)
2974 unformat_input_t _line_input, *line_input = &_line_input;
2975 u8 *sock_filename = NULL;
2978 u64 feature_mask = (u64) ~ (0ULL);
2980 u32 custom_dev_instance = ~0;
2983 clib_error_t *error = NULL;
2985 /* Get a line of input. */
2986 if (!unformat_user (input, unformat_line_input, line_input))
2989 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2991 if (unformat (line_input, "socket %s", &sock_filename))
2993 else if (unformat (line_input, "server"))
2995 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
2999 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
3001 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
3007 error = clib_error_return (0, "unknown input `%U'",
3008 format_unformat_error, line_input);
3013 vnet_main_t *vnm = vnet_get_main ();
3016 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
3017 is_server, &sw_if_index, feature_mask,
3018 renumber, custom_dev_instance, hw)))
3020 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
3024 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
3028 vec_free (sock_filename);
3029 unformat_free (line_input);
3035 vhost_user_delete_command_fn (vlib_main_t * vm,
3036 unformat_input_t * input,
3037 vlib_cli_command_t * cmd)
3039 unformat_input_t _line_input, *line_input = &_line_input;
3040 u32 sw_if_index = ~0;
3041 vnet_main_t *vnm = vnet_get_main ();
3042 clib_error_t *error = NULL;
3044 /* Get a line of input. */
3045 if (!unformat_user (input, unformat_line_input, line_input))
3048 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3050 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
3053 (line_input, "%U", unformat_vnet_sw_interface, vnm,
3056 vnet_hw_interface_t *hwif =
3057 vnet_get_sup_hw_interface (vnm, sw_if_index);
3059 vhost_user_dev_class.index != hwif->dev_class_index)
3061 error = clib_error_return (0, "Not a vhost interface");
3067 error = clib_error_return (0, "unknown input `%U'",
3068 format_unformat_error, line_input);
3073 vhost_user_delete_if (vnm, vm, sw_if_index);
3076 unformat_free (line_input);
3082 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
3083 vhost_user_intf_details_t ** out_vuids)
3086 vhost_user_main_t *vum = &vhost_user_main;
3087 vhost_user_intf_t *vui;
3088 vhost_user_intf_details_t *r_vuids = NULL;
3089 vhost_user_intf_details_t *vuid = NULL;
3090 u32 *hw_if_indices = 0;
3091 vnet_hw_interface_t *hi;
3098 pool_foreach (vui, vum->vhost_user_interfaces,
3099 vec_add1 (hw_if_indices, vui->hw_if_index);
3102 for (i = 0; i < vec_len (hw_if_indices); i++)
3104 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3105 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3107 vec_add2 (r_vuids, vuid, 1);
3108 vuid->sw_if_index = vui->sw_if_index;
3109 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
3110 vuid->features = vui->features;
3111 vuid->num_regions = vui->nregions;
3112 vuid->is_server = vui->unix_server_index != ~0;
3113 vuid->sock_errno = vui->sock_errno;
3114 strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
3115 ARRAY_LEN (vuid->sock_filename) - 1);
3117 s = format (s, "%v%c", hi->name, 0);
3119 strncpy ((char *) vuid->if_name, (char *) s,
3120 ARRAY_LEN (vuid->if_name) - 1);
3125 vec_free (hw_if_indices);
3127 *out_vuids = r_vuids;
3133 show_vhost_user_command_fn (vlib_main_t * vm,
3134 unformat_input_t * input,
3135 vlib_cli_command_t * cmd)
3137 clib_error_t *error = 0;
3138 vnet_main_t *vnm = vnet_get_main ();
3139 vhost_user_main_t *vum = &vhost_user_main;
3140 vhost_user_intf_t *vui;
3141 u32 hw_if_index, *hw_if_indices = 0;
3142 vnet_hw_interface_t *hi;
3152 struct feat_struct *feat_entry;
3154 static struct feat_struct feat_array[] = {
3155 #define _(s,b) { .str = #s, .bit = b, },
3156 foreach_virtio_net_feature
3161 #define foreach_protocol_feature \
3162 _(VHOST_USER_PROTOCOL_F_MQ) \
3163 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
3165 static struct feat_struct proto_feat_array[] = {
3166 #define _(s) { .str = #s, .bit = s},
3167 foreach_protocol_feature
3172 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3175 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
3177 vec_add1 (hw_if_indices, hw_if_index);
3179 else if (unformat (input, "descriptors") || unformat (input, "desc"))
3183 error = clib_error_return (0, "unknown input `%U'",
3184 format_unformat_error, input);
3188 if (vec_len (hw_if_indices) == 0)
3190 pool_foreach (vui, vum->vhost_user_interfaces,
3191 vec_add1 (hw_if_indices, vui->hw_if_index);
3194 vlib_cli_output (vm, "Virtio vhost-user interfaces");
3195 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
3196 vum->coalesce_frames, vum->coalesce_time);
3197 vlib_cli_output (vm, " number of rx virtqueues in interrupt mode: %d",
3200 for (i = 0; i < vec_len (hw_if_indices); i++)
3202 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3203 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3204 vlib_cli_output (vm, "Interface: %s (ifindex %d)",
3205 hi->name, hw_if_indices[i]);
3207 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
3208 " features mask (0x%llx): \n"
3209 " features (0x%llx): \n",
3210 vui->virtio_net_hdr_sz, vui->feature_mask,
3213 feat_entry = (struct feat_struct *) &feat_array;
3214 while (feat_entry->str)
3216 if (vui->features & (1ULL << feat_entry->bit))
3217 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3222 vlib_cli_output (vm, " protocol features (0x%llx)",
3223 vui->protocol_features);
3224 feat_entry = (struct feat_struct *) &proto_feat_array;
3225 while (feat_entry->str)
3227 if (vui->protocol_features & (1ULL << feat_entry->bit))
3228 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3233 vlib_cli_output (vm, "\n");
3235 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
3237 (vui->unix_server_index != ~0) ? "server" : "client",
3238 strerror (vui->sock_errno));
3240 vlib_cli_output (vm, " rx placement: ");
3242 vec_foreach (queue, vui->rx_queues)
3244 vnet_main_t *vnm = vnet_get_main ();
3246 vnet_hw_interface_rx_mode mode;
3248 thread_index = vnet_get_device_input_thread_index (vnm,
3251 vnet_hw_interface_get_rx_mode (vnm, vui->hw_if_index, *queue, &mode);
3252 vlib_cli_output (vm, " thread %d on vring %d, %U\n",
3253 thread_index, VHOST_VRING_IDX_TX (*queue),
3254 format_vnet_hw_interface_rx_mode, mode);
3257 vlib_cli_output (vm, " tx placement: %s\n",
3258 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
3260 vec_foreach_index (ci, vui->per_cpu_tx_qid)
3262 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
3263 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
3266 vlib_cli_output (vm, "\n");
3268 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
3272 vlib_cli_output (vm,
3273 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
3274 vlib_cli_output (vm,
3275 " ====== ===== ================== ================== ================== ================== ==================\n");
3277 for (j = 0; j < vui->nregions; j++)
3279 vlib_cli_output (vm,
3280 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
3281 j, vui->region_mmap_fd[j],
3282 vui->regions[j].guest_phys_addr,
3283 vui->regions[j].memory_size,
3284 vui->regions[j].userspace_addr,
3285 vui->regions[j].mmap_offset,
3286 pointer_to_uword (vui->region_mmap_addr[j]));
3288 for (q = 0; q < VHOST_VRING_MAX_N; q++)
3290 if (!vui->vrings[q].started)
3293 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
3294 (q & 1) ? "RX" : "TX",
3295 vui->vrings[q].enabled ? "" : " disabled");
3297 vlib_cli_output (vm,
3298 " qsz %d last_avail_idx %d last_used_idx %d\n",
3299 vui->vrings[q].qsz_mask + 1,
3300 vui->vrings[q].last_avail_idx,
3301 vui->vrings[q].last_used_idx);
3303 if (vui->vrings[q].avail && vui->vrings[q].used)
3304 vlib_cli_output (vm,
3305 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
3306 vui->vrings[q].avail->flags,
3307 vui->vrings[q].avail->idx,
3308 vui->vrings[q].used->flags,
3309 vui->vrings[q].used->idx);
3311 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
3312 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
3313 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n",
3314 kickfd, callfd, vui->vrings[q].errfd);
3318 vlib_cli_output (vm, "\n descriptor table:\n");
3319 vlib_cli_output (vm,
3320 " id addr len flags next user_addr\n");
3321 vlib_cli_output (vm,
3322 " ===== ================== ===== ====== ===== ==================\n");
3323 for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
3326 vlib_cli_output (vm,
3327 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
3328 j, vui->vrings[q].desc[j].addr,
3329 vui->vrings[q].desc[j].len,
3330 vui->vrings[q].desc[j].flags,
3331 vui->vrings[q].desc[j].next,
3332 pointer_to_uword (map_guest_mem
3334 vui->vrings[q].desc[j].
3339 vlib_cli_output (vm, "\n");
3342 vec_free (hw_if_indices);
3351 * Create a vHost User interface. Once created, a new virtual interface
3352 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
3353 * is the next free index.
3355 * There are several parameters associated with a vHost interface:
3357 * - <b>socket <socket-filename></b> - Name of the linux socket used by QEMU/VM and
3358 * VPP to manage the vHost interface. If socket does not already exist, VPP will
3359 * create the socket.
3361 * - <b>server</b> - Optional flag to indicate that VPP should be the server for the
3362 * linux socket. If not provided, VPP will be the client.
3364 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
3365 * startup. By default, all supported features will be advertised. Otherwise,
3366 * provide the set of features desired.
3367 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
3368 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
3369 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
3370 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
3371 * - 0x004000000 (26) - VHOST_F_LOG_ALL
3372 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
3373 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
3374 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
3375 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
3377 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
3378 * X:X:X:X:X:X unix or X.X.X cisco format.
3380 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
3381 * in the name to be specified. If instance already exists, name will be used
3382 * anyway and multiple instances will have the same name. Use with caution.
3384 * - <b>mode [interrupt | polling]</b> - Optional parameter specifying
3385 * the input thread polling policy.
3388 * Example of how to create a vhost interface with VPP as the client and all features enabled:
3389 * @cliexstart{create vhost-user socket /tmp/vhost1.sock}
3390 * VirtualEthernet0/0/0
3392 * Example of how to create a vhost interface with VPP as the server and with just
3393 * multiple queues enabled:
3394 * @cliexstart{create vhost-user socket /tmp/vhost2.sock server feature-mask 0x40400000}
3395 * VirtualEthernet0/0/1
3397 * Once the vHost interface is created, enable the interface using:
3398 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
3401 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
3402 .path = "create vhost-user",
3403 .short_help = "create vhost-user socket <socket-filename> [server] "
3404 "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] ",
3405 .function = vhost_user_connect_command_fn,
3410 * Delete a vHost User interface using the interface name or the
3411 * software interface index. Use the '<em>show interface</em>'
3412 * command to determine the software interface index. On deletion,
3413 * the linux socket will not be deleted.
3416 * Example of how to delete a vhost interface by name:
3417 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
3418 * Example of how to delete a vhost interface by software interface index:
3419 * @cliexcmd{delete vhost-user sw_if_index 1}
3422 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
3423 .path = "delete vhost-user",
3424 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
3425 .function = vhost_user_delete_command_fn,
3429 * Display the attributes of a single vHost User interface (provide interface
3430 * name), multiple vHost User interfaces (provide a list of interface names seperated
3431 * by spaces) or all Vhost User interfaces (omit an interface name to display all
3432 * vHost interfaces).
3436 * Example of how to display a vhost interface:
3437 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
3438 * Virtio vhost-user interfaces
3440 * coalesce frames 32 time 1e-3
3441 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3442 * virtio_net_hdr_sz 12
3443 * features mask (0xffffffffffffffff):
3444 * features (0x50408000):
3445 * VIRTIO_NET_F_MRG_RXBUF (15)
3446 * VIRTIO_NET_F_MQ (22)
3447 * VIRTIO_F_INDIRECT_DESC (28)
3448 * VHOST_USER_F_PROTOCOL_FEATURES (30)
3449 * protocol features (0x3)
3450 * VHOST_USER_PROTOCOL_F_MQ (0)
3451 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
3453 * socket filename /tmp/vhost1.sock type client errno "Success"
3456 * thread 1 on vring 1
3457 * thread 1 on vring 5
3458 * thread 2 on vring 3
3459 * thread 2 on vring 7
3460 * tx placement: spin-lock
3461 * thread 0 on vring 0
3462 * thread 1 on vring 2
3463 * thread 2 on vring 0
3465 * Memory regions (total 2)
3466 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
3467 * ====== ===== ================== ================== ================== ================== ==================
3468 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
3469 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
3472 * qsz 256 last_avail_idx 0 last_used_idx 0
3473 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3474 * kickfd 62 callfd 64 errfd -1
3477 * qsz 256 last_avail_idx 0 last_used_idx 0
3478 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3479 * kickfd 65 callfd 66 errfd -1
3482 * qsz 256 last_avail_idx 0 last_used_idx 0
3483 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3484 * kickfd 63 callfd 70 errfd -1
3487 * qsz 256 last_avail_idx 0 last_used_idx 0
3488 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3489 * kickfd 72 callfd 74 errfd -1
3491 * Virtqueue 4 (TX disabled)
3492 * qsz 256 last_avail_idx 0 last_used_idx 0
3493 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3494 * kickfd 76 callfd 78 errfd -1
3496 * Virtqueue 5 (RX disabled)
3497 * qsz 256 last_avail_idx 0 last_used_idx 0
3498 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3499 * kickfd 80 callfd 82 errfd -1
3501 * Virtqueue 6 (TX disabled)
3502 * qsz 256 last_avail_idx 0 last_used_idx 0
3503 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3504 * kickfd 84 callfd 86 errfd -1
3506 * Virtqueue 7 (RX disabled)
3507 * qsz 256 last_avail_idx 0 last_used_idx 0
3508 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3509 * kickfd 88 callfd 90 errfd -1
3513 * The optional '<em>descriptors</em>' parameter will display the same output as
3514 * the previous example but will include the descriptor table for each queue.
3515 * The output is truncated below:
3516 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
3517 * Virtio vhost-user interfaces
3519 * coalesce frames 32 time 1e-3
3520 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3521 * virtio_net_hdr_sz 12
3522 * features mask (0xffffffffffffffff):
3523 * features (0x50408000):
3524 * VIRTIO_NET_F_MRG_RXBUF (15)
3525 * VIRTIO_NET_F_MQ (22)
3528 * qsz 256 last_avail_idx 0 last_used_idx 0
3529 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3530 * kickfd 62 callfd 64 errfd -1
3533 * id addr len flags next user_addr
3534 * ===== ================== ===== ====== ===== ==================
3535 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
3536 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
3537 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
3538 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
3539 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
3540 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
3541 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
3542 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
3543 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
3544 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
3545 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
3547 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
3548 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
3549 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
3550 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
3551 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
3552 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
3553 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
3556 * qsz 256 last_avail_idx 0 last_used_idx 0
3562 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
3563 .path = "show vhost-user",
3564 .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
3565 .function = show_vhost_user_command_fn,
3570 debug_vhost_user_command_fn (vlib_main_t * vm,
3571 unformat_input_t * input,
3572 vlib_cli_command_t * cmd)
3574 unformat_input_t _line_input, *line_input = &_line_input;
3575 clib_error_t *error = NULL;
3576 vhost_user_main_t *vum = &vhost_user_main;
3580 /* Get a line of input. */
3581 if (!unformat_user (input, unformat_line_input, line_input))
3582 return clib_error_return (0, "missing argument");
3584 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3588 error = clib_error_return (0, "unknown input `%U'",
3589 format_unformat_error, line_input);
3593 if (unformat (line_input, "on"))
3598 else if (unformat (line_input, "off"))
3605 error = clib_error_return (0, "unknown input `%U'",
3606 format_unformat_error, line_input);
3614 unformat_free (line_input);
3620 VLIB_CLI_COMMAND (debug_vhost_user_command, static) = {
3621 .path = "debug vhost-user",
3622 .short_help = "debug vhost-user <on | off>",
3623 .function = debug_vhost_user_command_fn,
3627 static clib_error_t *
3628 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
3630 vhost_user_main_t *vum = &vhost_user_main;
3632 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3634 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
3636 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
3638 else if (unformat (input, "dont-dump-memory"))
3639 vum->dont_dump_vhost_user_memory = 1;
3641 return clib_error_return (0, "unknown input `%U'",
3642 format_unformat_error, input);
3648 /* vhost-user { ... } configuration. */
3649 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
3652 vhost_user_unmap_all (void)
3654 vhost_user_main_t *vum = &vhost_user_main;
3655 vhost_user_intf_t *vui;
3657 if (vum->dont_dump_vhost_user_memory)
3659 pool_foreach (vui, vum->vhost_user_interfaces,
3660 unmap_all_mem_regions (vui);
3666 * fd.io coding-style-patch-verification: ON
3669 * eval: (c-set-style "gnu")