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_USER_DEBUG_SOCKET 0
53 #define VHOST_DEBUG_VQ 0
55 #if VHOST_USER_DEBUG_SOCKET == 1
56 #define DBG_SOCK(args...) clib_warning(args);
58 #define DBG_SOCK(args...)
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 #define UNIX_GET_FD(unixfd_idx) \
91 (unixfd_idx != ~0) ? \
92 pool_elt_at_index (unix_main.file_pool, \
93 unixfd_idx)->file_descriptor : -1;
95 #define foreach_virtio_trace_flags \
96 _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
97 _ (SINGLE_DESC, 1, "Single descriptor packet") \
98 _ (INDIRECT, 2, "Indirect descriptor") \
99 _ (MAP_ERROR, 4, "Memory mapping error")
103 #define _(n,i,s) VIRTIO_TRACE_F_##n,
104 foreach_virtio_trace_flags
106 } virtio_trace_flag_t;
108 vlib_node_registration_t vhost_user_input_node;
110 #define foreach_vhost_user_tx_func_error \
111 _(NONE, "no error") \
112 _(NOT_READY, "vhost vring not ready") \
113 _(DOWN, "vhost interface is down") \
114 _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)") \
115 _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)") \
116 _(MMAP_FAIL, "mmap failure") \
117 _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
121 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
122 foreach_vhost_user_tx_func_error
124 VHOST_USER_TX_FUNC_N_ERROR,
125 } vhost_user_tx_func_error_t;
127 static char *vhost_user_tx_func_error_strings[] = {
129 foreach_vhost_user_tx_func_error
133 #define foreach_vhost_user_input_func_error \
134 _(NO_ERROR, "no error") \
135 _(NO_BUFFER, "no available buffer") \
136 _(MMAP_FAIL, "mmap failure") \
137 _(INDIRECT_OVERFLOW, "indirect descriptor overflows table") \
138 _(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
139 _(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")
143 #define _(f,s) VHOST_USER_INPUT_FUNC_ERROR_##f,
144 foreach_vhost_user_input_func_error
146 VHOST_USER_INPUT_FUNC_N_ERROR,
147 } vhost_user_input_func_error_t;
149 static char *vhost_user_input_func_error_strings[] = {
151 foreach_vhost_user_input_func_error
156 static vhost_user_main_t vhost_user_main = {
160 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
161 .name = "vhost-user",
166 format_vhost_user_interface_name (u8 * s, va_list * args)
168 u32 i = va_arg (*args, u32);
169 u32 show_dev_instance = ~0;
170 vhost_user_main_t *vum = &vhost_user_main;
172 if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
173 show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
175 if (show_dev_instance != ~0)
176 i = show_dev_instance;
178 s = format (s, "VirtualEthernet0/0/%d", i);
183 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
185 // FIXME: check if the new dev instance is already used
186 vhost_user_main_t *vum = &vhost_user_main;
187 vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
188 hi->dev_instance, ~0);
190 vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
193 DBG_SOCK ("renumbered vhost-user interface dev_instance %d to %d",
194 hi->dev_instance, new_dev_instance);
199 static_always_inline void *
200 map_guest_mem (vhost_user_intf_t * vui, uword addr, u32 * hint)
203 if (PREDICT_TRUE ((vui->regions[i].guest_phys_addr <= addr) &&
204 ((vui->regions[i].guest_phys_addr +
205 vui->regions[i].memory_size) > addr)))
207 return (void *) (vui->region_mmap_addr[i] + addr -
208 vui->regions[i].guest_phys_addr);
211 __m128i rl, rh, al, ah, r;
212 al = _mm_set1_epi64x (addr + 1);
213 ah = _mm_set1_epi64x (addr);
215 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[0]);
216 rl = _mm_cmpgt_epi64 (al, rl);
217 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[0]);
218 rh = _mm_cmpgt_epi64 (rh, ah);
219 r = _mm_and_si128 (rl, rh);
221 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[2]);
222 rl = _mm_cmpgt_epi64 (al, rl);
223 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[2]);
224 rh = _mm_cmpgt_epi64 (rh, ah);
225 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x22);
227 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[4]);
228 rl = _mm_cmpgt_epi64 (al, rl);
229 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[4]);
230 rh = _mm_cmpgt_epi64 (rh, ah);
231 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x44);
233 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[6]);
234 rl = _mm_cmpgt_epi64 (al, rl);
235 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[6]);
236 rh = _mm_cmpgt_epi64 (rh, ah);
237 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x88);
239 r = _mm_shuffle_epi8 (r, _mm_set_epi64x (0, 0x0e060c040a020800));
240 i = __builtin_ctzll (_mm_movemask_epi8 (r) |
241 (1 << VHOST_MEMORY_MAX_NREGIONS));
243 if (i < vui->nregions)
246 return (void *) (vui->region_mmap_addr[i] + addr -
247 vui->regions[i].guest_phys_addr);
251 for (i = 0; i < vui->nregions; i++)
253 if ((vui->regions[i].guest_phys_addr <= addr) &&
254 ((vui->regions[i].guest_phys_addr + vui->regions[i].memory_size) >
258 return (void *) (vui->region_mmap_addr[i] + addr -
259 vui->regions[i].guest_phys_addr);
263 DBG_VQ ("failed to map guest mem addr %llx", addr);
269 map_user_mem (vhost_user_intf_t * vui, uword addr)
272 for (i = 0; i < vui->nregions; i++)
274 if ((vui->regions[i].userspace_addr <= addr) &&
275 ((vui->regions[i].userspace_addr + vui->regions[i].memory_size) >
278 return (void *) (vui->region_mmap_addr[i] + addr -
279 vui->regions[i].userspace_addr);
286 get_huge_page_size (int fd)
294 unmap_all_mem_regions (vhost_user_intf_t * vui)
297 for (i = 0; i < vui->nregions; i++)
299 if (vui->region_mmap_addr[i] != (void *) -1)
302 long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
304 ssize_t map_sz = (vui->regions[i].memory_size +
305 vui->regions[i].mmap_offset +
306 page_sz) & ~(page_sz - 1);
309 munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
313 ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
314 vui->region_mmap_addr[i], map_sz, page_sz);
316 vui->region_mmap_addr[i] = (void *) -1;
320 clib_warning ("failed to unmap memory region (errno %d)",
323 close (vui->region_mmap_fd[i]);
330 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
332 //Let's try to assign one queue to each thread
335 vui->use_tx_spinlock = 0;
338 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
340 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
341 if (!rxvq->started || !rxvq->enabled)
344 vui->per_cpu_tx_qid[cpu_index] = qid;
346 if (cpu_index == vlib_get_thread_main ()->n_vlib_mains)
349 //We need to loop, meaning the spinlock has to be used
350 vui->use_tx_spinlock = 1;
353 //Could not find a single valid one
355 cpu_index < vlib_get_thread_main ()->n_vlib_mains; cpu_index++)
357 vui->per_cpu_tx_qid[cpu_index] = 0;
365 vhost_user_rx_thread_placement ()
367 vhost_user_main_t *vum = &vhost_user_main;
368 vhost_user_intf_t *vui;
372 //Let's list all workers cpu indexes
374 for (i = vum->input_cpu_first_index;
375 i < vum->input_cpu_first_index + vum->input_cpu_count; i++)
377 vlib_node_set_state (vlib_mains ? vlib_mains[i] : &vlib_global_main,
378 vhost_user_input_node.index,
379 VLIB_NODE_STATE_DISABLED);
380 vec_add1 (workers, i);
383 vec_foreach (vhc, vum->cpus)
385 vec_reset_length (vhc->rx_queues);
389 vhost_iface_and_queue_t iaq;
391 pool_foreach (vui, vum->vhost_user_interfaces, {
392 u32 *vui_workers = vec_len (vui->workers) ? vui->workers : workers;
394 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
396 vhost_user_vring_t *txvq =
397 &vui->vrings[VHOST_VRING_IDX_TX (qid)];
401 i %= vec_len (vui_workers);
402 u32 cpu_index = vui_workers[i];
404 vhc = &vum->cpus[cpu_index];
407 iaq.vhost_iface_index = vui - vum->vhost_user_interfaces;
408 vec_add1 (vhc->rx_queues, iaq);
409 vlib_node_set_state (vlib_mains ? vlib_mains[cpu_index] :
410 &vlib_global_main, vhost_user_input_node.index,
411 VLIB_NODE_STATE_POLLING);
418 vhost_user_thread_placement (u32 sw_if_index, u32 worker_thread_index, u8 del)
420 vhost_user_main_t *vum = &vhost_user_main;
421 vhost_user_intf_t *vui;
422 vnet_hw_interface_t *hw;
424 if (worker_thread_index < vum->input_cpu_first_index ||
425 worker_thread_index >=
426 vum->input_cpu_first_index + vum->input_cpu_count)
429 if (!(hw = vnet_get_sup_hw_interface (vnet_get_main (), sw_if_index)))
432 vui = pool_elt_at_index (vum->vhost_user_interfaces, hw->dev_instance);
434 vec_foreach (w, vui->workers)
436 if (*w == worker_thread_index)
438 found = w - vui->workers;
447 vec_del1 (vui->workers, found);
449 else if (found == ~0)
451 vec_add1 (vui->workers, worker_thread_index);
454 vhost_user_rx_thread_placement ();
458 /** @brief Returns whether at least one TX and one RX vring are enabled */
460 vhost_user_intf_ready (vhost_user_intf_t * vui)
462 int i, found[2] = { }; //RX + TX
464 for (i = 0; i < VHOST_VRING_MAX_N; i++)
465 if (vui->vrings[i].started && vui->vrings[i].enabled)
468 return found[0] && found[1];
472 vhost_user_update_iface_state (vhost_user_intf_t * vui)
474 /* if we have pointers to descriptor table, go up */
475 int is_up = vhost_user_intf_ready (vui);
476 if (is_up != vui->is_up)
478 DBG_SOCK ("interface %d %s", vui->sw_if_index,
479 is_up ? "ready" : "down");
480 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
481 is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
485 vhost_user_rx_thread_placement ();
486 vhost_user_tx_thread_placement (vui);
489 static clib_error_t *
490 vhost_user_callfd_read_ready (unix_file_t * uf)
492 __attribute__ ((unused)) int n;
494 n = read (uf->file_descriptor, ((char *) &buff), 8);
498 static clib_error_t *
499 vhost_user_kickfd_read_ready (unix_file_t * uf)
501 __attribute__ ((unused)) int n;
503 vhost_user_intf_t *vui =
504 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
505 uf->private_data >> 8);
506 u32 qid = uf->private_data & 0xff;
507 n = read (uf->file_descriptor, ((char *) &buff), 8);
508 DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
510 vlib_worker_thread_barrier_sync (vlib_get_main ());
511 vui->vrings[qid].started = 1;
512 vhost_user_update_iface_state (vui);
513 vlib_worker_thread_barrier_release (vlib_get_main ());
518 * @brief Try once to lock the vring
519 * @return 0 on success, non-zero on failure.
522 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
524 return __sync_lock_test_and_set (vui->vring_locks[qid], 1);
528 * @brief Spin until the vring is successfully locked
531 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
533 while (vhost_user_vring_try_lock (vui, qid))
538 * @brief Unlock the vring lock
541 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
543 *vui->vring_locks[qid] = 0;
547 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
549 vhost_user_vring_t *vring = &vui->vrings[qid];
550 memset (vring, 0, sizeof (*vring));
551 vring->kickfd_idx = ~0;
552 vring->callfd_idx = ~0;
556 * We have a bug with some qemu 2.5, and this may be a fix.
557 * Feel like interpretation holy text, but this is from vhost-user.txt.
559 * One queue pair is enabled initially. More queues are enabled
560 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
562 * Don't know who's right, but this is what DPDK does.
564 if (qid == 0 || qid == 1)
569 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
571 vhost_user_vring_t *vring = &vui->vrings[qid];
572 if (vring->kickfd_idx != ~0)
574 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
576 unix_file_del (&unix_main, uf);
577 vring->kickfd_idx = ~0;
579 if (vring->callfd_idx != ~0)
581 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
583 unix_file_del (&unix_main, uf);
584 vring->callfd_idx = ~0;
586 if (vring->errfd != -1)
587 close (vring->errfd);
588 vhost_user_vring_init (vui, qid);
592 vhost_user_if_disconnect (vhost_user_intf_t * vui)
594 vnet_main_t *vnm = vnet_get_main ();
597 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
599 if (vui->unix_file_index != ~0)
601 unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
602 vui->unix_file_index = ~0;
607 for (q = 0; q < VHOST_VRING_MAX_N; q++)
608 vhost_user_vring_close (vui, q);
610 unmap_all_mem_regions (vui);
611 DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
614 #define VHOST_LOG_PAGE 0x1000
615 static_always_inline void
616 vhost_user_log_dirty_pages_2 (vhost_user_intf_t * vui,
617 u64 addr, u64 len, u8 is_host_address)
619 if (PREDICT_TRUE (vui->log_base_addr == 0
620 || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
626 addr = (u64) map_user_mem (vui, (uword) addr);
628 if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
630 DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
634 CLIB_MEMORY_BARRIER ();
635 u64 page = addr / VHOST_LOG_PAGE;
636 while (page * VHOST_LOG_PAGE < addr + len)
638 ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
643 static_always_inline void
644 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
646 vhost_user_log_dirty_pages_2 (vui, addr, len, 0);
649 #define vhost_user_log_dirty_ring(vui, vq, member) \
650 if (PREDICT_FALSE(vq->log_used)) { \
651 vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
652 sizeof(vq->used->member)); \
655 static clib_error_t *
656 vhost_user_socket_read (unix_file_t * uf)
659 int fd, number_of_fds = 0;
660 int fds[VHOST_MEMORY_MAX_NREGIONS];
661 vhost_user_msg_t msg;
664 vhost_user_main_t *vum = &vhost_user_main;
665 vhost_user_intf_t *vui;
666 struct cmsghdr *cmsg;
668 unix_file_t template = { 0 };
669 vnet_main_t *vnm = vnet_get_main ();
671 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
673 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
675 memset (&mh, 0, sizeof (mh));
676 memset (control, 0, sizeof (control));
678 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
681 /* set the payload */
682 iov[0].iov_base = (void *) &msg;
683 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
687 mh.msg_control = control;
688 mh.msg_controllen = sizeof (control);
690 n = recvmsg (uf->file_descriptor, &mh, 0);
692 /* Stop workers to avoid end of the world */
693 vlib_worker_thread_barrier_sync (vlib_get_main ());
695 if (n != VHOST_USER_MSG_HDR_SZ)
699 DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
703 DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
704 n, VHOST_USER_MSG_HDR_SZ);
709 if (mh.msg_flags & MSG_CTRUNC)
711 DBG_SOCK ("MSG_CTRUNC is set");
715 cmsg = CMSG_FIRSTHDR (&mh);
717 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
718 (cmsg->cmsg_type == SCM_RIGHTS) &&
719 (cmsg->cmsg_len - CMSG_LEN (0) <=
720 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
722 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
723 clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
726 /* version 1, no reply bit set */
727 if ((msg.flags & 7) != 1)
729 DBG_SOCK ("malformed message received. closing socket");
736 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
740 DBG_SOCK ("read failed %s", strerror (errno));
743 else if (rv != msg.size)
745 DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
752 case VHOST_USER_GET_FEATURES:
754 msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
755 (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
756 (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
757 (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
758 (1ULL << FEAT_VHOST_F_LOG_ALL) |
759 (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
760 (1ULL << FEAT_VIRTIO_NET_F_MQ) |
761 (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
762 (1ULL << FEAT_VIRTIO_F_VERSION_1);
763 msg.u64 &= vui->feature_mask;
764 msg.size = sizeof (msg.u64);
765 DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
766 vui->hw_if_index, msg.u64);
769 case VHOST_USER_SET_FEATURES:
770 DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
771 vui->hw_if_index, msg.u64);
773 vui->features = msg.u64;
776 ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
777 (1ULL << FEAT_VIRTIO_F_VERSION_1)))
778 vui->virtio_net_hdr_sz = 12;
780 vui->virtio_net_hdr_sz = 10;
783 (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
785 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
786 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
789 /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
790 vhost_user_vring_close(&vui->vrings[q]); */
794 case VHOST_USER_SET_MEM_TABLE:
795 DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
796 vui->hw_if_index, msg.memory.nregions);
798 if ((msg.memory.nregions < 1) ||
799 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
802 DBG_SOCK ("number of mem regions must be between 1 and %i",
803 VHOST_MEMORY_MAX_NREGIONS);
808 if (msg.memory.nregions != number_of_fds)
810 DBG_SOCK ("each memory region must have FD");
813 unmap_all_mem_regions (vui);
814 for (i = 0; i < msg.memory.nregions; i++)
816 clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
817 sizeof (vhost_user_memory_region_t));
819 long page_sz = get_huge_page_size (fds[i]);
821 /* align size to 2M page */
822 ssize_t map_sz = (vui->regions[i].memory_size +
823 vui->regions[i].mmap_offset +
824 page_sz) & ~(page_sz - 1);
826 vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
827 MAP_SHARED, fds[i], 0);
828 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
829 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
830 vui->regions[i].memory_size;
833 ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
834 "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
837 if (vui->region_mmap_addr[i] == MAP_FAILED)
839 clib_warning ("failed to map memory. errno is %d", errno);
842 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
843 vui->region_mmap_fd[i] = fds[i];
845 vui->nregions = msg.memory.nregions;
848 case VHOST_USER_SET_VRING_NUM:
849 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
850 vui->hw_if_index, msg.state.index, msg.state.num);
852 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
853 (msg.state.num == 0) || /* it cannot be zero */
854 ((msg.state.num - 1) & msg.state.num)) /* must be power of 2 */
856 vui->vrings[msg.state.index].qsz = msg.state.num;
859 case VHOST_USER_SET_VRING_ADDR:
860 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
861 vui->hw_if_index, msg.state.index);
863 if (msg.state.index >= VHOST_VRING_MAX_N)
865 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
866 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
870 if (msg.size < sizeof (msg.addr))
872 DBG_SOCK ("vhost message is too short (%d < %d)",
873 msg.size, sizeof (msg.addr));
877 vui->vrings[msg.state.index].desc = (vring_desc_t *)
878 map_user_mem (vui, msg.addr.desc_user_addr);
879 vui->vrings[msg.state.index].used = (vring_used_t *)
880 map_user_mem (vui, msg.addr.used_user_addr);
881 vui->vrings[msg.state.index].avail = (vring_avail_t *)
882 map_user_mem (vui, msg.addr.avail_user_addr);
884 if ((vui->vrings[msg.state.index].desc == NULL) ||
885 (vui->vrings[msg.state.index].used == NULL) ||
886 (vui->vrings[msg.state.index].avail == NULL))
888 DBG_SOCK ("failed to map user memory for hw_if_index %d",
893 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
894 vui->vrings[msg.state.index].log_used =
895 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
897 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
898 the ring is initialized in an enabled state. */
899 if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
901 vui->vrings[msg.state.index].enabled = 1;
904 vui->vrings[msg.state.index].last_used_idx =
905 vui->vrings[msg.state.index].last_avail_idx =
906 vui->vrings[msg.state.index].used->idx;
908 /* tell driver that we don't want interrupts */
909 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
912 case VHOST_USER_SET_OWNER:
913 DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
916 case VHOST_USER_RESET_OWNER:
917 DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
920 case VHOST_USER_SET_VRING_CALL:
921 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL u64 %d",
922 vui->hw_if_index, msg.u64);
924 q = (u8) (msg.u64 & 0xFF);
926 /* if there is old fd, delete and close it */
927 if (vui->vrings[q].callfd_idx != ~0)
929 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
930 vui->vrings[q].callfd_idx);
931 unix_file_del (&unix_main, uf);
932 vui->vrings[q].callfd_idx = ~0;
935 if (!(msg.u64 & 0x100))
937 if (number_of_fds != 1)
939 DBG_SOCK ("More than one fd received !");
943 template.read_function = vhost_user_callfd_read_ready;
944 template.file_descriptor = fds[0];
945 template.private_data =
946 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
947 vui->vrings[q].callfd_idx = unix_file_add (&unix_main, &template);
950 vui->vrings[q].callfd_idx = ~0;
953 case VHOST_USER_SET_VRING_KICK:
954 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK u64 %d",
955 vui->hw_if_index, msg.u64);
957 q = (u8) (msg.u64 & 0xFF);
959 if (vui->vrings[q].kickfd_idx != ~0)
961 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
962 vui->vrings[q].kickfd_idx);
963 unix_file_del (&unix_main, uf);
964 vui->vrings[q].kickfd_idx = ~0;
967 if (!(msg.u64 & 0x100))
969 if (number_of_fds != 1)
971 DBG_SOCK ("More than one fd received !");
975 template.read_function = vhost_user_kickfd_read_ready;
976 template.file_descriptor = fds[0];
977 template.private_data =
978 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
980 vui->vrings[q].kickfd_idx = unix_file_add (&unix_main, &template);
984 //When no kickfd is set, the queue is initialized as started
985 vui->vrings[q].kickfd_idx = ~0;
986 vui->vrings[q].started = 1;
991 case VHOST_USER_SET_VRING_ERR:
992 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR u64 %d",
993 vui->hw_if_index, msg.u64);
995 q = (u8) (msg.u64 & 0xFF);
997 if (vui->vrings[q].errfd != -1)
998 close (vui->vrings[q].errfd);
1000 if (!(msg.u64 & 0x100))
1002 if (number_of_fds != 1)
1005 vui->vrings[q].errfd = fds[0];
1008 vui->vrings[q].errfd = -1;
1012 case VHOST_USER_SET_VRING_BASE:
1013 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1014 vui->hw_if_index, msg.state.index, msg.state.num);
1016 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
1019 case VHOST_USER_GET_VRING_BASE:
1020 DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1021 vui->hw_if_index, msg.state.index, msg.state.num);
1023 if (msg.state.index >= VHOST_VRING_MAX_N)
1025 DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
1026 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1030 /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
1031 vhost_user_vring_close (vui, msg.state.index);
1033 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
1035 msg.size = sizeof (msg.state);
1038 case VHOST_USER_NONE:
1039 DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
1043 case VHOST_USER_SET_LOG_BASE:
1045 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
1047 if (msg.size != sizeof (msg.log))
1050 ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
1051 msg.size, sizeof (msg.log));
1056 (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
1059 ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
1064 /* align size to 2M page */
1065 long page_sz = get_huge_page_size (fd);
1067 (msg.log.size + msg.log.offset + page_sz) & ~(page_sz - 1);
1069 vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
1073 ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
1074 map_sz, msg.log.offset, fd, vui->log_base_addr);
1076 if (vui->log_base_addr == MAP_FAILED)
1078 clib_warning ("failed to map memory. errno is %d", errno);
1082 vui->log_base_addr += msg.log.offset;
1083 vui->log_size = msg.log.size;
1086 msg.size = sizeof (msg.u64);
1091 case VHOST_USER_SET_LOG_FD:
1092 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
1096 case VHOST_USER_GET_PROTOCOL_FEATURES:
1097 DBG_SOCK ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
1101 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
1102 (1 << VHOST_USER_PROTOCOL_F_MQ);
1103 msg.size = sizeof (msg.u64);
1106 case VHOST_USER_SET_PROTOCOL_FEATURES:
1107 DBG_SOCK ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%lx",
1108 vui->hw_if_index, msg.u64);
1110 vui->protocol_features = msg.u64;
1114 case VHOST_USER_GET_QUEUE_NUM:
1115 DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM", vui->hw_if_index);
1117 msg.u64 = VHOST_VRING_MAX_N;
1118 msg.size = sizeof (msg.u64);
1121 case VHOST_USER_SET_VRING_ENABLE:
1122 DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
1123 vui->hw_if_index, msg.state.num ? "enable" : "disable",
1125 if (msg.state.index >= VHOST_VRING_MAX_N)
1127 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
1128 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1132 vui->vrings[msg.state.index].enabled = msg.state.num;
1136 DBG_SOCK ("unknown vhost-user message %d received. closing socket",
1141 /* if we need to reply */
1145 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1146 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1148 DBG_SOCK ("could not send message response");
1153 vhost_user_update_iface_state (vui);
1154 vlib_worker_thread_barrier_release (vlib_get_main ());
1158 vhost_user_if_disconnect (vui);
1159 vhost_user_update_iface_state (vui);
1160 vlib_worker_thread_barrier_release (vlib_get_main ());
1164 static clib_error_t *
1165 vhost_user_socket_error (unix_file_t * uf)
1167 vlib_main_t *vm = vlib_get_main ();
1168 vhost_user_main_t *vum = &vhost_user_main;
1169 vhost_user_intf_t *vui =
1170 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1172 DBG_SOCK ("socket error on if %d", vui->sw_if_index);
1173 vlib_worker_thread_barrier_sync (vm);
1174 vhost_user_if_disconnect (vui);
1175 vhost_user_rx_thread_placement ();
1176 vlib_worker_thread_barrier_release (vm);
1180 static clib_error_t *
1181 vhost_user_socksvr_accept_ready (unix_file_t * uf)
1183 int client_fd, client_len;
1184 struct sockaddr_un client;
1185 unix_file_t template = { 0 };
1186 vhost_user_main_t *vum = &vhost_user_main;
1187 vhost_user_intf_t *vui;
1189 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1191 client_len = sizeof (client);
1192 client_fd = accept (uf->file_descriptor,
1193 (struct sockaddr *) &client,
1194 (socklen_t *) & client_len);
1197 return clib_error_return_unix (0, "accept");
1199 DBG_SOCK ("New client socket for vhost interface %d", vui->sw_if_index);
1200 template.read_function = vhost_user_socket_read;
1201 template.error_function = vhost_user_socket_error;
1202 template.file_descriptor = client_fd;
1203 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1204 vui->unix_file_index = unix_file_add (&unix_main, &template);
1208 static clib_error_t *
1209 vhost_user_init (vlib_main_t * vm)
1211 clib_error_t *error;
1212 vhost_user_main_t *vum = &vhost_user_main;
1213 vlib_thread_main_t *tm = vlib_get_thread_main ();
1214 vlib_thread_registration_t *tr;
1217 error = vlib_call_init_function (vm, ip4_init);
1221 vum->coalesce_frames = 32;
1222 vum->coalesce_time = 1e-3;
1224 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1227 vec_foreach (cpu, vum->cpus)
1229 /* This is actually not necessary as validate already zeroes it
1230 * Just keeping the loop here for later because I am lazy. */
1231 cpu->rx_buffers_len = 0;
1234 /* find out which cpus will be used for input */
1235 vum->input_cpu_first_index = 0;
1236 vum->input_cpu_count = 1;
1237 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1238 tr = p ? (vlib_thread_registration_t *) p[0] : 0;
1240 if (tr && tr->count > 0)
1242 vum->input_cpu_first_index = tr->first_index;
1243 vum->input_cpu_count = tr->count;
1246 vum->random = random_default_seed ();
1251 VLIB_INIT_FUNCTION (vhost_user_init);
1253 static clib_error_t *
1254 vhost_user_exit (vlib_main_t * vm)
1260 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
1263 format_vhost_trace (u8 * s, va_list * va)
1265 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
1266 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
1267 CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
1268 vhost_user_main_t *vum = &vhost_user_main;
1269 vhost_trace_t *t = va_arg (*va, vhost_trace_t *);
1270 vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
1273 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
1275 uword indent = format_get_indent (s);
1277 s = format (s, "%U %U queue %d\n", format_white_space, indent,
1278 format_vnet_sw_interface_name, vnm, sw, t->qid);
1280 s = format (s, "%U virtio flags:\n", format_white_space, indent);
1282 if (t->virtio_ring_flags & (1 << VIRTIO_TRACE_F_##n)) \
1283 s = format (s, "%U %s %s\n", format_white_space, indent, #n, st);
1284 foreach_virtio_trace_flags
1286 s = format (s, "%U virtio_net_hdr first_desc_len %u\n",
1287 format_white_space, indent, t->first_desc_len);
1289 s = format (s, "%U flags 0x%02x gso_type %u\n",
1290 format_white_space, indent,
1291 t->hdr.hdr.flags, t->hdr.hdr.gso_type);
1293 if (vui->virtio_net_hdr_sz == 12)
1294 s = format (s, "%U num_buff %u",
1295 format_white_space, indent, t->hdr.num_buffers);
1301 vhost_user_rx_trace (vhost_trace_t * t,
1302 vhost_user_intf_t * vui, u16 qid,
1303 vlib_buffer_t * b, vhost_user_vring_t * txvq)
1305 vhost_user_main_t *vum = &vhost_user_main;
1306 u32 qsz_mask = txvq->qsz - 1;
1307 u32 last_avail_idx = txvq->last_avail_idx;
1308 u32 desc_current = txvq->avail->ring[last_avail_idx & qsz_mask];
1309 vring_desc_t *hdr_desc = 0;
1310 virtio_net_hdr_mrg_rxbuf_t *hdr;
1313 memset (t, 0, sizeof (*t));
1314 t->device_index = vui - vum->vhost_user_interfaces;
1317 hdr_desc = &txvq->desc[desc_current];
1318 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1320 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1321 /* Header is the first here */
1322 hdr_desc = map_guest_mem (vui, txvq->desc[desc_current].addr, &hint);
1324 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1326 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1328 if (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1329 !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1331 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1334 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1336 if (!hdr_desc || !(hdr = map_guest_mem (vui, hdr_desc->addr, &hint)))
1338 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_MAP_ERROR;
1342 u32 len = vui->virtio_net_hdr_sz;
1343 memcpy (&t->hdr, hdr, len > hdr_desc->len ? hdr_desc->len : len);
1348 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1350 vhost_user_main_t *vum = &vhost_user_main;
1352 int fd = UNIX_GET_FD (vq->callfd_idx);
1353 int rv __attribute__ ((unused));
1354 /* TODO: pay attention to rv */
1355 rv = write (fd, &x, sizeof (x));
1356 vq->n_since_last_int = 0;
1357 vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1360 static_always_inline u32
1361 vhost_user_input_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1362 u16 copy_len, u32 * map_hint)
1364 void *src0, *src1, *src2, *src3;
1365 if (PREDICT_TRUE (copy_len >= 4))
1367 if (PREDICT_FALSE (!(src2 = map_guest_mem (vui, cpy[0].src, map_hint))))
1369 if (PREDICT_FALSE (!(src3 = map_guest_mem (vui, cpy[1].src, map_hint))))
1372 while (PREDICT_TRUE (copy_len >= 4))
1378 (!(src2 = map_guest_mem (vui, cpy[2].src, map_hint))))
1381 (!(src3 = map_guest_mem (vui, cpy[3].src, map_hint))))
1384 CLIB_PREFETCH (src2, 64, LOAD);
1385 CLIB_PREFETCH (src3, 64, LOAD);
1387 clib_memcpy ((void *) cpy[0].dst, src0, cpy[0].len);
1388 clib_memcpy ((void *) cpy[1].dst, src1, cpy[1].len);
1395 if (PREDICT_FALSE (!(src0 = map_guest_mem (vui, cpy->src, map_hint))))
1397 clib_memcpy ((void *) cpy->dst, src0, cpy->len);
1405 * Try to discard packets from the tx ring (VPP RX path).
1406 * Returns the number of discarded packets.
1409 vhost_user_rx_discard_packet (vlib_main_t * vm,
1410 vhost_user_intf_t * vui,
1411 vhost_user_vring_t * txvq, u32 discard_max)
1414 * On the RX side, each packet corresponds to one descriptor
1415 * (it is the same whether it is a shallow descriptor, chained, or indirect).
1416 * Therefore, discarding a packet is like discarding a descriptor.
1418 u32 discarded_packets = 0;
1419 u32 avail_idx = txvq->avail->idx;
1420 u16 qsz_mask = txvq->qsz - 1;
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 & qsz_mask];
1428 txvq->last_avail_idx++;
1429 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_chain_head;
1430 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1431 vhost_user_log_dirty_ring (vui, txvq,
1432 ring[txvq->last_used_idx & qsz_mask]);
1433 txvq->last_used_idx++;
1434 discarded_packets++;
1438 CLIB_MEMORY_BARRIER ();
1439 txvq->used->idx = txvq->last_used_idx;
1440 vhost_user_log_dirty_ring (vui, txvq, idx);
1441 return discarded_packets;
1445 * In case of overflow, we need to rewind the array of allocated buffers.
1448 vhost_user_input_rewind_buffers (vlib_main_t * vm,
1449 vhost_cpu_t * cpu, vlib_buffer_t * b_head)
1451 u32 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1452 vlib_buffer_t *b_current = vlib_get_buffer (vm, bi_current);
1453 b_current->current_length = 0;
1454 b_current->flags = 0;
1455 while (b_current != b_head)
1457 cpu->rx_buffers_len++;
1458 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1459 b_current = vlib_get_buffer (vm, bi_current);
1460 b_current->current_length = 0;
1461 b_current->flags = 0;
1466 vhost_user_if_input (vlib_main_t * vm,
1467 vhost_user_main_t * vum,
1468 vhost_user_intf_t * vui,
1469 u16 qid, vlib_node_runtime_t * node)
1471 vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
1472 u16 n_rx_packets = 0;
1475 u32 n_left_to_next, *to_next;
1476 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1477 u32 n_trace = vlib_get_trace_count (vm, node);
1480 u16 cpu_index = os_get_cpu_number ();
1484 /* do we have pending interrupts ? */
1485 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
1486 f64 now = vlib_time_now (vm);
1488 if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1489 vhost_user_send_call (vm, txvq);
1491 if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1492 vhost_user_send_call (vm, rxvq);
1495 if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1498 n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1501 if (PREDICT_FALSE (n_left == 0))
1504 if (PREDICT_FALSE (!vui->admin_up || !(txvq->enabled)))
1507 * Discard input packet if interface is admin down or vring is not
1509 * "For example, for a networking device, in the disabled state
1510 * client must not supply any new RX packets, but must process
1511 * and discard any TX packets."
1513 vhost_user_rx_discard_packet (vm, vui, txvq,
1514 VHOST_USER_DOWN_DISCARD_COUNT);
1518 if (PREDICT_FALSE (n_left == txvq->qsz))
1521 * Informational error logging when VPP is not
1522 * receiving packets fast enough.
1524 vlib_error_count (vm, node->node_index,
1525 VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1528 qsz_mask = txvq->qsz - 1;
1530 if (n_left > VLIB_FRAME_SIZE)
1531 n_left = VLIB_FRAME_SIZE;
1534 * For small packets (<2kB), we will not need more than one vlib buffer
1535 * per packet. In case packets are bigger, we will just yeld at some point
1536 * in the loop and come back later. This is not an issue as for big packet,
1537 * processing cost really comes from the memory copy.
1539 if (PREDICT_FALSE (vum->cpus[cpu_index].rx_buffers_len < n_left + 1))
1541 u32 curr_len = vum->cpus[cpu_index].rx_buffers_len;
1542 vum->cpus[cpu_index].rx_buffers_len +=
1543 vlib_buffer_alloc_from_free_list (vm,
1544 vum->cpus[cpu_index].rx_buffers +
1546 VHOST_USER_RX_BUFFERS_N - curr_len,
1547 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1550 (vum->cpus[cpu_index].rx_buffers_len <
1551 VHOST_USER_RX_BUFFER_STARVATION))
1553 /* In case of buffer starvation, discard some packets from the queue
1554 * and log the event.
1555 * We keep doing best effort for the remaining packets. */
1556 u32 flush = (n_left + 1 > vum->cpus[cpu_index].rx_buffers_len) ?
1557 n_left + 1 - vum->cpus[cpu_index].rx_buffers_len : 1;
1558 flush = vhost_user_rx_discard_packet (vm, vui, txvq, flush);
1561 vlib_increment_simple_counter (vnet_main.
1562 interface_main.sw_if_counters +
1563 VNET_INTERFACE_COUNTER_DROP,
1564 os_get_cpu_number (),
1565 vui->sw_if_index, flush);
1567 vlib_error_count (vm, vhost_user_input_node.index,
1568 VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1574 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1576 while (n_left > 0 && n_left_to_next > 0)
1578 vlib_buffer_t *b_head, *b_current;
1581 u32 desc_data_offset;
1582 vring_desc_t *desc_table = txvq->desc;
1584 if (PREDICT_FALSE (vum->cpus[cpu_index].rx_buffers_len <= 1))
1586 /* Not enough rx_buffers
1587 * Note: We yeld on 1 so we don't need to do an additional
1588 * check for the next buffer prefetch.
1594 desc_current = txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1595 vum->cpus[cpu_index].rx_buffers_len--;
1596 bi_current = (vum->cpus[cpu_index].rx_buffers)
1597 [vum->cpus[cpu_index].rx_buffers_len];
1598 b_head = b_current = vlib_get_buffer (vm, bi_current);
1599 to_next[0] = bi_current; //We do that now so we can forget about bi_current
1603 vlib_prefetch_buffer_with_index (vm,
1604 (vum->cpus[cpu_index].rx_buffers)
1605 [vum->cpus[cpu_index].
1606 rx_buffers_len - 1], LOAD);
1608 /* Just preset the used descriptor id and length for later */
1609 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_current;
1610 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1611 vhost_user_log_dirty_ring (vui, txvq,
1612 ring[txvq->last_used_idx & qsz_mask]);
1614 /* The buffer should already be initialized */
1615 b_head->total_length_not_including_first_buffer = 0;
1616 b_head->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1618 if (PREDICT_FALSE (n_trace))
1620 //TODO: next_index is not exactly known at that point
1621 vlib_trace_buffer (vm, node, next_index, b_head,
1622 /* follow_chain */ 0);
1624 vlib_add_trace (vm, node, b_head, sizeof (t0[0]));
1625 vhost_user_rx_trace (t0, vui, qid, b_head, txvq);
1627 vlib_set_trace_count (vm, node, n_trace);
1630 /* This depends on the setup but is very consistent
1631 * So I think the CPU branch predictor will make a pretty good job
1632 * at optimizing the decision. */
1633 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1635 desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1638 if (PREDICT_FALSE (desc_table == 0))
1640 //FIXME: Handle error by shutdown the queue
1645 if (PREDICT_TRUE (vui->is_any_layout) ||
1646 (!(desc_table[desc_current].flags & VIRTQ_DESC_F_NEXT)))
1648 /* ANYLAYOUT or single buffer */
1649 desc_data_offset = vui->virtio_net_hdr_sz;
1653 /* CSR case without ANYLAYOUT, skip 1st buffer */
1654 desc_data_offset = desc_table[desc_current].len;
1659 /* Get more input if necessary. Or end of packet. */
1660 if (desc_data_offset == desc_table[desc_current].len)
1662 if (PREDICT_FALSE (desc_table[desc_current].flags &
1665 desc_current = desc_table[desc_current].next;
1666 desc_data_offset = 0;
1674 /* Get more output if necessary. Or end of packet. */
1676 (b_current->current_length == VLIB_BUFFER_DATA_SIZE))
1679 (vum->cpus[cpu_index].rx_buffers_len == 0))
1681 /* Cancel speculation */
1686 * Checking if there are some left buffers.
1687 * If not, just rewind the used buffers and stop.
1688 * Note: Scheduled copies are not cancelled. This is
1689 * not an issue as they would still be valid. Useless,
1692 vhost_user_input_rewind_buffers (vm,
1693 &vum->cpus[cpu_index],
1699 /* Get next output */
1700 vum->cpus[cpu_index].rx_buffers_len--;
1702 (vum->cpus[cpu_index].rx_buffers)[vum->cpus
1703 [cpu_index].rx_buffers_len];
1704 b_current->next_buffer = bi_next;
1705 b_current->flags |= VLIB_BUFFER_NEXT_PRESENT;
1706 bi_current = bi_next;
1707 b_current = vlib_get_buffer (vm, bi_current);
1710 /* Prepare a copy order executed later for the data */
1711 vhost_copy_t *cpy = &vum->cpus[cpu_index].copy[copy_len];
1714 desc_table[desc_current].len - desc_data_offset;
1715 cpy->len = VLIB_BUFFER_DATA_SIZE - b_current->current_length;
1716 cpy->len = (cpy->len > desc_data_l) ? desc_data_l : cpy->len;
1717 cpy->dst = (uword) vlib_buffer_get_current (b_current);
1718 cpy->src = desc_table[desc_current].addr + desc_data_offset;
1720 desc_data_offset += cpy->len;
1722 b_current->current_length += cpy->len;
1723 b_head->total_length_not_including_first_buffer += cpy->len;
1727 CLIB_PREFETCH (&n_left, sizeof (n_left), LOAD);
1729 n_rx_bytes += b_head->total_length_not_including_first_buffer;
1732 b_head->total_length_not_including_first_buffer -=
1733 b_head->current_length;
1735 /* consume the descriptor and return it as used */
1736 txvq->last_avail_idx++;
1737 txvq->last_used_idx++;
1739 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1741 vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1742 vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1746 u32 next0 = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1748 /* redirect if feature path enabled */
1749 vnet_feature_start_device_input_x1 (vui->sw_if_index, &next0,
1752 u32 bi = to_next[-1]; //Cannot use to_next[-1] in the macro
1753 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1754 to_next, n_left_to_next,
1761 * Although separating memory copies from virtio ring parsing
1762 * is beneficial, we can offer to perform the copies from time
1763 * to time in order to free some space in the ring.
1765 if (PREDICT_FALSE (copy_len >= VHOST_USER_RX_COPY_THRESHOLD))
1768 (vhost_user_input_copy (vui, vum->cpus[cpu_index].copy,
1769 copy_len, &map_hint)))
1772 ("Memory mapping error on interface hw_if_index=%d "
1773 "(Shutting down - Switch interface down and up to restart)",
1781 /* give buffers back to driver */
1782 CLIB_MEMORY_BARRIER ();
1783 txvq->used->idx = txvq->last_used_idx;
1784 vhost_user_log_dirty_ring (vui, txvq, idx);
1788 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1791 /* Do the memory copies */
1793 (vhost_user_input_copy (vui, vum->cpus[cpu_index].copy,
1794 copy_len, &map_hint)))
1796 clib_warning ("Memory mapping error on interface hw_if_index=%d "
1797 "(Shutting down - Switch interface down and up to restart)",
1802 /* give buffers back to driver */
1803 CLIB_MEMORY_BARRIER ();
1804 txvq->used->idx = txvq->last_used_idx;
1805 vhost_user_log_dirty_ring (vui, txvq, idx);
1807 /* interrupt (call) handling */
1808 if ((txvq->callfd_idx != ~0) && !(txvq->avail->flags & 1))
1810 txvq->n_since_last_int += n_rx_packets;
1812 if (txvq->n_since_last_int > vum->coalesce_frames)
1813 vhost_user_send_call (vm, txvq);
1816 /* increase rx counters */
1817 vlib_increment_combined_counter
1818 (vnet_main.interface_main.combined_sw_if_counters
1819 + VNET_INTERFACE_COUNTER_RX,
1820 os_get_cpu_number (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1822 vnet_device_increment_rx_packets (cpu_index, n_rx_packets);
1824 return n_rx_packets;
1828 vhost_user_input (vlib_main_t * vm,
1829 vlib_node_runtime_t * node, vlib_frame_t * f)
1831 vhost_user_main_t *vum = &vhost_user_main;
1832 uword n_rx_packets = 0;
1833 u32 cpu_index = os_get_cpu_number ();
1836 vhost_iface_and_queue_t *vhiq;
1837 vec_foreach (vhiq, vum->cpus[cpu_index].rx_queues)
1839 vhost_user_intf_t *vui =
1840 &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
1841 n_rx_packets += vhost_user_if_input (vm, vum, vui, vhiq->qid, node);
1844 return n_rx_packets;
1848 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1849 .function = vhost_user_input,
1850 .type = VLIB_NODE_TYPE_INPUT,
1851 .name = "vhost-user-input",
1852 .sibling_of = "device-input",
1854 /* Will be enabled if/when hardware is detected. */
1855 .state = VLIB_NODE_STATE_DISABLED,
1857 .format_buffer = format_ethernet_header_with_length,
1858 .format_trace = format_vhost_trace,
1860 .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1861 .error_strings = vhost_user_input_func_error_strings,
1864 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
1869 vhost_user_tx_trace (vhost_trace_t * t,
1870 vhost_user_intf_t * vui, u16 qid,
1871 vlib_buffer_t * b, vhost_user_vring_t * rxvq)
1873 vhost_user_main_t *vum = &vhost_user_main;
1874 u32 qsz_mask = rxvq->qsz - 1;
1875 u32 last_avail_idx = rxvq->last_avail_idx;
1876 u32 desc_current = rxvq->avail->ring[last_avail_idx & qsz_mask];
1877 vring_desc_t *hdr_desc = 0;
1880 memset (t, 0, sizeof (*t));
1881 t->device_index = vui - vum->vhost_user_interfaces;
1884 hdr_desc = &rxvq->desc[desc_current];
1885 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1887 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1888 /* Header is the first here */
1889 hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
1891 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1893 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1895 if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1896 !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1898 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1901 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1904 static_always_inline u32
1905 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1906 u16 copy_len, u32 * map_hint)
1908 void *dst0, *dst1, *dst2, *dst3;
1909 if (PREDICT_TRUE (copy_len >= 4))
1911 if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
1913 if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
1915 while (PREDICT_TRUE (copy_len >= 4))
1921 (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
1924 (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
1927 CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
1928 CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
1930 clib_memcpy (dst0, (void *) cpy[0].src, cpy[0].len);
1931 clib_memcpy (dst1, (void *) cpy[1].src, cpy[1].len);
1933 vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
1934 vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
1941 if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
1943 clib_memcpy (dst0, (void *) cpy->src, cpy->len);
1944 vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
1953 vhost_user_tx (vlib_main_t * vm,
1954 vlib_node_runtime_t * node, vlib_frame_t * frame)
1956 u32 *buffers = vlib_frame_args (frame);
1957 u32 n_left = frame->n_vectors;
1958 vhost_user_main_t *vum = &vhost_user_main;
1959 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
1960 vhost_user_intf_t *vui =
1961 pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
1963 vhost_user_vring_t *rxvq;
1966 u32 cpu_index = os_get_cpu_number ();
1972 if (PREDICT_FALSE (!vui->admin_up))
1974 error = VHOST_USER_TX_FUNC_ERROR_DOWN;
1978 if (PREDICT_FALSE (!vui->is_up))
1980 error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
1985 VHOST_VRING_IDX_RX (*vec_elt_at_index
1986 (vui->per_cpu_tx_qid, os_get_cpu_number ()));
1987 rxvq = &vui->vrings[qid];
1988 if (PREDICT_FALSE (vui->use_tx_spinlock))
1989 vhost_user_vring_lock (vui, qid);
1991 qsz_mask = rxvq->qsz - 1; /* qsz is always power of 2 */
1994 error = VHOST_USER_TX_FUNC_ERROR_NONE;
1999 vlib_buffer_t *b0, *current_b0;
2000 u16 desc_head, desc_index, desc_len;
2001 vring_desc_t *desc_table;
2002 uword buffer_map_addr;
2006 if (PREDICT_TRUE (n_left > 1))
2007 vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
2009 b0 = vlib_get_buffer (vm, buffers[0]);
2011 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2013 vum->cpus[cpu_index].current_trace =
2014 vlib_add_trace (vm, node, b0,
2015 sizeof (*vum->cpus[cpu_index].current_trace));
2016 vhost_user_tx_trace (vum->cpus[cpu_index].current_trace,
2017 vui, qid / 2, b0, rxvq);
2020 if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
2022 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2026 desc_table = rxvq->desc;
2027 desc_head = desc_index =
2028 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2030 /* Go deeper in case of indirect descriptor
2031 * I don't know of any driver providing indirect for RX. */
2032 if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2035 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2037 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2042 map_guest_mem (vui, rxvq->desc[desc_index].addr,
2045 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2051 desc_len = vui->virtio_net_hdr_sz;
2052 buffer_map_addr = desc_table[desc_index].addr;
2053 buffer_len = desc_table[desc_index].len;
2056 // Get a header from the header array
2057 virtio_net_hdr_mrg_rxbuf_t *hdr =
2058 &vum->cpus[cpu_index].tx_headers[tx_headers_len];
2061 hdr->hdr.gso_type = 0;
2062 hdr->num_buffers = 1; //This is local, no need to check
2064 // Prepare a copy order executed later for the header
2065 vhost_copy_t *cpy = &vum->cpus[cpu_index].copy[copy_len];
2067 cpy->len = vui->virtio_net_hdr_sz;
2068 cpy->dst = buffer_map_addr;
2069 cpy->src = (uword) hdr;
2072 buffer_map_addr += vui->virtio_net_hdr_sz;
2073 buffer_len -= vui->virtio_net_hdr_sz;
2074 bytes_left = b0->current_length;
2078 if (buffer_len == 0)
2080 if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
2082 //Next one is chained
2083 desc_index = desc_table[desc_index].next;
2084 buffer_map_addr = desc_table[desc_index].addr;
2085 buffer_len = desc_table[desc_index].len;
2087 else if (vui->virtio_net_hdr_sz == 12) //MRG is available
2089 virtio_net_hdr_mrg_rxbuf_t *hdr =
2090 &vum->cpus[cpu_index].tx_headers[tx_headers_len - 1];
2092 //Move from available to used buffer
2093 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id =
2095 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len =
2097 vhost_user_log_dirty_ring (vui, rxvq,
2098 ring[rxvq->last_used_idx &
2101 rxvq->last_avail_idx++;
2102 rxvq->last_used_idx++;
2107 (rxvq->last_avail_idx == rxvq->avail->idx))
2109 //Dequeue queued descriptors for this packet
2110 rxvq->last_used_idx -= hdr->num_buffers - 1;
2111 rxvq->last_avail_idx -= hdr->num_buffers - 1;
2112 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2116 desc_table = rxvq->desc;
2117 desc_head = desc_index =
2118 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2120 (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2122 //It is seriously unlikely that a driver will put indirect descriptor
2123 //after non-indirect descriptor.
2125 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2127 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2133 rxvq->desc[desc_index].addr,
2136 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2141 buffer_map_addr = desc_table[desc_index].addr;
2142 buffer_len = desc_table[desc_index].len;
2146 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
2152 vhost_copy_t *cpy = &vum->cpus[cpu_index].copy[copy_len];
2154 cpy->len = bytes_left;
2155 cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
2156 cpy->dst = buffer_map_addr;
2157 cpy->src = (uword) vlib_buffer_get_current (current_b0) +
2158 current_b0->current_length - bytes_left;
2160 bytes_left -= cpy->len;
2161 buffer_len -= cpy->len;
2162 buffer_map_addr += cpy->len;
2163 desc_len += cpy->len;
2165 CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
2168 // Check if vlib buffer has more data. If not, get more or break.
2169 if (PREDICT_TRUE (!bytes_left))
2172 (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
2174 current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
2175 bytes_left = current_b0->current_length;
2185 //Move from available to used ring
2186 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id = desc_head;
2187 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len = desc_len;
2188 vhost_user_log_dirty_ring (vui, rxvq,
2189 ring[rxvq->last_used_idx & qsz_mask]);
2190 rxvq->last_avail_idx++;
2191 rxvq->last_used_idx++;
2193 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2195 vum->cpus[cpu_index].current_trace->hdr =
2196 vum->cpus[cpu_index].tx_headers[tx_headers_len - 1];
2199 n_left--; //At the end for error counting when 'goto done' is invoked
2204 //Do the memory copies
2206 (vhost_user_tx_copy (vui, vum->cpus[cpu_index].copy,
2207 copy_len, &map_hint)))
2209 clib_warning ("Memory mapping error on interface hw_if_index=%d "
2210 "(Shutting down - Switch interface down and up to restart)",
2215 CLIB_MEMORY_BARRIER ();
2216 rxvq->used->idx = rxvq->last_used_idx;
2217 vhost_user_log_dirty_ring (vui, rxvq, idx);
2220 * When n_left is set, error is always set to something too.
2221 * In case error is due to lack of remaining buffers, we go back up and
2223 * The idea is that it is better to waste some time on packets
2224 * that have been processed already than dropping them and get
2225 * more fresh packets with a good likelyhood that they will be dropped too.
2226 * This technique also gives more time to VM driver to pick-up packets.
2227 * In case the traffic flows from physical to virtual interfaces, this
2228 * technique will end-up leveraging the physical NIC buffer in order to
2229 * absorb the VM's CPU jitter.
2231 if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
2237 /* interrupt (call) handling */
2238 if ((rxvq->callfd_idx != ~0) && !(rxvq->avail->flags & 1))
2240 rxvq->n_since_last_int += frame->n_vectors - n_left;
2242 if (rxvq->n_since_last_int > vum->coalesce_frames)
2243 vhost_user_send_call (vm, rxvq);
2246 vhost_user_vring_unlock (vui, qid);
2249 if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
2251 vlib_error_count (vm, node->node_index, error, n_left);
2252 vlib_increment_simple_counter
2253 (vnet_main.interface_main.sw_if_counters
2254 + VNET_INTERFACE_COUNTER_DROP,
2255 os_get_cpu_number (), vui->sw_if_index, n_left);
2258 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
2259 return frame->n_vectors;
2262 static clib_error_t *
2263 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
2266 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2267 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
2268 vhost_user_main_t *vum = &vhost_user_main;
2269 vhost_user_intf_t *vui =
2270 pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2272 vui->admin_up = is_up;
2275 vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
2276 VNET_HW_INTERFACE_FLAG_LINK_UP);
2278 return /* no error */ 0;
2282 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
2283 .name = "vhost-user",
2284 .tx_function = vhost_user_tx,
2285 .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
2286 .tx_function_error_strings = vhost_user_tx_func_error_strings,
2287 .format_device_name = format_vhost_user_interface_name,
2288 .name_renumber = vhost_user_name_renumber,
2289 .admin_up_down_function = vhost_user_interface_admin_up_down,
2290 .format_tx_trace = format_vhost_trace,
2293 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
2298 vhost_user_process (vlib_main_t * vm,
2299 vlib_node_runtime_t * rt, vlib_frame_t * f)
2301 vhost_user_main_t *vum = &vhost_user_main;
2302 vhost_user_intf_t *vui;
2303 struct sockaddr_un sun;
2305 unix_file_t template = { 0 };
2306 f64 timeout = 3153600000.0 /* 100 years */ ;
2307 uword *event_data = 0;
2309 sockfd = socket (AF_UNIX, SOCK_STREAM, 0);
2310 sun.sun_family = AF_UNIX;
2311 template.read_function = vhost_user_socket_read;
2312 template.error_function = vhost_user_socket_error;
2319 vlib_process_wait_for_event_or_clock (vm, timeout);
2320 vlib_process_get_events (vm, &event_data);
2321 vec_reset_length (event_data);
2326 pool_foreach (vui, vum->vhost_user_interfaces, {
2328 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
2329 if (vui->unix_file_index == ~0)
2331 /* try to connect */
2332 strncpy (sun.sun_path, (char *) vui->sock_filename,
2333 sizeof (sun.sun_path) - 1);
2335 /* Avoid hanging VPP if the other end does not accept */
2336 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
2337 clib_unix_warning ("fcntl");
2339 if (connect (sockfd, (struct sockaddr *) &sun,
2340 sizeof (struct sockaddr_un)) == 0)
2342 /* Set the socket to blocking as it was before */
2343 if (fcntl(sockfd, F_SETFL, 0) < 0)
2344 clib_unix_warning ("fcntl2");
2346 vui->sock_errno = 0;
2347 template.file_descriptor = sockfd;
2348 template.private_data =
2349 vui - vhost_user_main.vhost_user_interfaces;
2350 vui->unix_file_index = unix_file_add (&unix_main, &template);
2352 //Re-open for next connect
2353 if ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0) {
2354 clib_warning("Critical: Could not open unix socket");
2360 vui->sock_errno = errno;
2365 /* check if socket is alive */
2367 socklen_t len = sizeof (error);
2368 int fd = UNIX_GET_FD(vui->unix_file_index);
2370 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
2374 DBG_SOCK ("getsockopt returned %d", retval);
2375 vhost_user_if_disconnect (vui);
2386 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
2387 .function = vhost_user_process,
2388 .type = VLIB_NODE_TYPE_PROCESS,
2389 .name = "vhost-user-process",
2394 * Disables and reset interface structure.
2395 * It can then be either init again, or removed from used interfaces.
2398 vhost_user_term_if (vhost_user_intf_t * vui)
2402 // Delete configured thread pinning
2403 vec_reset_length (vui->workers);
2404 // disconnect interface sockets
2405 vhost_user_if_disconnect (vui);
2406 vhost_user_update_iface_state (vui);
2408 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2410 clib_mem_free ((void *) vui->vring_locks[q]);
2413 if (vui->unix_server_index != ~0)
2415 //Close server socket
2416 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
2417 vui->unix_server_index);
2418 unix_file_del (&unix_main, uf);
2419 vui->unix_server_index = ~0;
2424 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
2426 vhost_user_main_t *vum = &vhost_user_main;
2427 vhost_user_intf_t *vui;
2429 vnet_hw_interface_t *hwif;
2431 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2432 hwif->dev_class_index != vhost_user_dev_class.index)
2433 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2435 DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
2436 hwif->name, hwif->dev_instance);
2438 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2440 // Disable and reset interface
2441 vhost_user_term_if (vui);
2443 // Reset renumbered iface
2444 if (hwif->dev_instance <
2445 vec_len (vum->show_dev_instance_by_real_dev_instance))
2446 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
2448 // Delete ethernet interface
2449 ethernet_delete_interface (vnm, vui->hw_if_index);
2452 pool_put (vum->vhost_user_interfaces, vui);
2458 * Open server unix socket on specified sock_filename.
2461 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
2464 struct sockaddr_un un = { };
2466 /* create listening socket */
2467 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
2468 return VNET_API_ERROR_SYSCALL_ERROR_1;
2470 un.sun_family = AF_UNIX;
2471 strncpy ((char *) un.sun_path, (char *) sock_filename,
2472 sizeof (un.sun_path) - 1);
2474 /* remove if exists */
2475 unlink ((char *) sock_filename);
2477 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
2479 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
2483 if (listen (fd, 1) == -1)
2485 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
2498 * Create ethernet interface for vhost user interface.
2501 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
2502 vhost_user_intf_t * vui, u8 * hwaddress)
2504 vhost_user_main_t *vum = &vhost_user_main;
2506 clib_error_t *error;
2508 /* create hw and sw interface */
2511 clib_memcpy (hwaddr, hwaddress, 6);
2515 random_u32 (&vum->random);
2516 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
2521 error = ethernet_register_interface
2523 vhost_user_dev_class.index,
2524 vui - vum->vhost_user_interfaces /* device instance */ ,
2525 hwaddr /* ethernet address */ ,
2526 &vui->hw_if_index, 0 /* flag change */ );
2529 clib_error_report (error);
2531 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, vui->hw_if_index);
2532 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
2536 * Initialize vui with specified attributes
2539 vhost_user_vui_init (vnet_main_t * vnm,
2540 vhost_user_intf_t * vui,
2542 const char *sock_filename,
2543 u64 feature_mask, u32 * sw_if_index)
2545 vnet_sw_interface_t *sw;
2546 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
2549 if (server_sock_fd != -1)
2551 unix_file_t template = { 0 };
2552 template.read_function = vhost_user_socksvr_accept_ready;
2553 template.file_descriptor = server_sock_fd;
2554 template.private_data = vui - vhost_user_main.vhost_user_interfaces; //hw index
2555 vui->unix_server_index = unix_file_add (&unix_main, &template);
2559 vui->unix_server_index = ~0;
2562 vui->sw_if_index = sw->sw_if_index;
2563 strncpy (vui->sock_filename, sock_filename,
2564 ARRAY_LEN (vui->sock_filename) - 1);
2565 vui->sock_errno = 0;
2567 vui->feature_mask = feature_mask;
2568 vui->unix_file_index = ~0;
2569 vui->log_base_addr = 0;
2571 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2572 vhost_user_vring_init (vui, q);
2574 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
2577 *sw_if_index = vui->sw_if_index;
2579 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2581 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
2582 CLIB_CACHE_LINE_BYTES);
2583 memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
2586 vec_validate (vui->per_cpu_tx_qid,
2587 vlib_get_thread_main ()->n_vlib_mains - 1);
2588 vhost_user_tx_thread_placement (vui);
2592 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2593 const char *sock_filename,
2597 u8 renumber, u32 custom_dev_instance, u8 * hwaddr)
2599 vhost_user_intf_t *vui = NULL;
2602 int server_sock_fd = -1;
2604 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2606 return VNET_API_ERROR_INVALID_ARGUMENT;
2612 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
2618 pool_get (vhost_user_main.vhost_user_interfaces, vui);
2620 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2621 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
2622 feature_mask, &sw_if_idx);
2625 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2628 *sw_if_index = sw_if_idx;
2630 // Process node must connect
2631 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2636 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2637 const char *sock_filename,
2640 u64 feature_mask, u8 renumber, u32 custom_dev_instance)
2642 vhost_user_main_t *vum = &vhost_user_main;
2643 vhost_user_intf_t *vui = NULL;
2645 int server_sock_fd = -1;
2647 vnet_hw_interface_t *hwif;
2649 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2650 hwif->dev_class_index != vhost_user_dev_class.index)
2651 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2653 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2655 // First try to open server socket
2657 if ((rv = vhost_user_init_server_sock (sock_filename,
2658 &server_sock_fd)) != 0)
2661 vhost_user_term_if (vui);
2662 vhost_user_vui_init (vnm, vui, server_sock_fd,
2663 sock_filename, feature_mask, &sw_if_idx);
2666 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2668 // Process node must connect
2669 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2674 vhost_user_connect_command_fn (vlib_main_t * vm,
2675 unformat_input_t * input,
2676 vlib_cli_command_t * cmd)
2678 unformat_input_t _line_input, *line_input = &_line_input;
2679 u8 *sock_filename = NULL;
2682 u64 feature_mask = (u64) ~ (0ULL);
2684 u32 custom_dev_instance = ~0;
2687 clib_error_t *error = NULL;
2689 /* Get a line of input. */
2690 if (!unformat_user (input, unformat_line_input, line_input))
2693 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2695 if (unformat (line_input, "socket %s", &sock_filename))
2697 else if (unformat (line_input, "server"))
2699 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
2703 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
2705 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
2711 error = clib_error_return (0, "unknown input `%U'",
2712 format_unformat_error, line_input);
2717 vnet_main_t *vnm = vnet_get_main ();
2720 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
2721 is_server, &sw_if_index, feature_mask,
2722 renumber, custom_dev_instance, hw)))
2724 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
2728 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
2732 vec_free (sock_filename);
2733 unformat_free (line_input);
2739 vhost_user_delete_command_fn (vlib_main_t * vm,
2740 unformat_input_t * input,
2741 vlib_cli_command_t * cmd)
2743 unformat_input_t _line_input, *line_input = &_line_input;
2744 u32 sw_if_index = ~0;
2745 vnet_main_t *vnm = vnet_get_main ();
2746 clib_error_t *error = NULL;
2748 /* Get a line of input. */
2749 if (!unformat_user (input, unformat_line_input, line_input))
2752 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2754 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
2757 (line_input, "%U", unformat_vnet_sw_interface, vnm,
2760 vnet_hw_interface_t *hwif =
2761 vnet_get_sup_hw_interface (vnm, sw_if_index);
2763 vhost_user_dev_class.index != hwif->dev_class_index)
2765 error = clib_error_return (0, "Not a vhost interface");
2771 error = clib_error_return (0, "unknown input `%U'",
2772 format_unformat_error, line_input);
2777 vhost_user_delete_if (vnm, vm, sw_if_index);
2780 unformat_free (line_input);
2786 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
2787 vhost_user_intf_details_t ** out_vuids)
2790 vhost_user_main_t *vum = &vhost_user_main;
2791 vhost_user_intf_t *vui;
2792 vhost_user_intf_details_t *r_vuids = NULL;
2793 vhost_user_intf_details_t *vuid = NULL;
2794 u32 *hw_if_indices = 0;
2795 vnet_hw_interface_t *hi;
2802 pool_foreach (vui, vum->vhost_user_interfaces,
2803 vec_add1 (hw_if_indices, vui->hw_if_index);
2806 for (i = 0; i < vec_len (hw_if_indices); i++)
2808 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2809 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2811 vec_add2 (r_vuids, vuid, 1);
2812 vuid->sw_if_index = vui->sw_if_index;
2813 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
2814 vuid->features = vui->features;
2815 vuid->num_regions = vui->nregions;
2816 vuid->is_server = vui->unix_server_index != ~0;
2817 vuid->sock_errno = vui->sock_errno;
2818 strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
2819 ARRAY_LEN (vuid->sock_filename) - 1);
2821 s = format (s, "%v%c", hi->name, 0);
2823 strncpy ((char *) vuid->if_name, (char *) s,
2824 ARRAY_LEN (vuid->if_name) - 1);
2829 vec_free (hw_if_indices);
2831 *out_vuids = r_vuids;
2837 show_vhost_user_command_fn (vlib_main_t * vm,
2838 unformat_input_t * input,
2839 vlib_cli_command_t * cmd)
2841 clib_error_t *error = 0;
2842 vnet_main_t *vnm = vnet_get_main ();
2843 vhost_user_main_t *vum = &vhost_user_main;
2844 vhost_user_intf_t *vui;
2845 u32 hw_if_index, *hw_if_indices = 0;
2846 vnet_hw_interface_t *hi;
2848 vhost_iface_and_queue_t *vhiq;
2858 struct feat_struct *feat_entry;
2860 static struct feat_struct feat_array[] = {
2861 #define _(s,b) { .str = #s, .bit = b, },
2862 foreach_virtio_net_feature
2867 #define foreach_protocol_feature \
2868 _(VHOST_USER_PROTOCOL_F_MQ) \
2869 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
2871 static struct feat_struct proto_feat_array[] = {
2872 #define _(s) { .str = #s, .bit = s},
2873 foreach_protocol_feature
2878 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2881 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
2883 vec_add1 (hw_if_indices, hw_if_index);
2885 else if (unformat (input, "descriptors") || unformat (input, "desc"))
2889 error = clib_error_return (0, "unknown input `%U'",
2890 format_unformat_error, input);
2894 if (vec_len (hw_if_indices) == 0)
2896 pool_foreach (vui, vum->vhost_user_interfaces,
2897 vec_add1 (hw_if_indices, vui->hw_if_index);
2900 vlib_cli_output (vm, "Virtio vhost-user interfaces");
2901 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
2902 vum->coalesce_frames, vum->coalesce_time);
2904 for (i = 0; i < vec_len (hw_if_indices); i++)
2906 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2907 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2908 vlib_cli_output (vm, "Interface: %s (ifindex %d)",
2909 hi->name, hw_if_indices[i]);
2911 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
2912 " features mask (0x%llx): \n"
2913 " features (0x%llx): \n",
2914 vui->virtio_net_hdr_sz, vui->feature_mask,
2917 feat_entry = (struct feat_struct *) &feat_array;
2918 while (feat_entry->str)
2920 if (vui->features & (1ULL << feat_entry->bit))
2921 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
2926 vlib_cli_output (vm, " protocol features (0x%llx)",
2927 vui->protocol_features);
2928 feat_entry = (struct feat_struct *) &proto_feat_array;
2929 while (feat_entry->str)
2931 if (vui->protocol_features & (1ULL << feat_entry->bit))
2932 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
2937 vlib_cli_output (vm, "\n");
2939 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
2941 (vui->unix_server_index != ~0) ? "server" : "client",
2942 strerror (vui->sock_errno));
2944 vlib_cli_output (vm, " rx placement: ");
2945 vec_foreach (vhc, vum->cpus)
2947 vec_foreach (vhiq, vhc->rx_queues)
2949 if (vhiq->vhost_iface_index == vui - vum->vhost_user_interfaces)
2950 vlib_cli_output (vm, " thread %d on vring %d\n",
2951 vhc - vum->cpus, VHOST_VRING_IDX_TX (vhiq->qid));
2955 vlib_cli_output (vm, " tx placement: %s\n",
2956 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
2958 vec_foreach_index (ci, vui->per_cpu_tx_qid)
2960 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
2961 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
2964 vlib_cli_output (vm, "\n");
2966 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
2970 vlib_cli_output (vm,
2971 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
2972 vlib_cli_output (vm,
2973 " ====== ===== ================== ================== ================== ================== ==================\n");
2975 for (j = 0; j < vui->nregions; j++)
2977 vlib_cli_output (vm,
2978 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
2979 j, vui->region_mmap_fd[j],
2980 vui->regions[j].guest_phys_addr,
2981 vui->regions[j].memory_size,
2982 vui->regions[j].userspace_addr,
2983 vui->regions[j].mmap_offset,
2984 pointer_to_uword (vui->region_mmap_addr[j]));
2986 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2988 if (!vui->vrings[q].started)
2991 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
2992 (q & 1) ? "RX" : "TX",
2993 vui->vrings[q].enabled ? "" : " disabled");
2995 vlib_cli_output (vm,
2996 " qsz %d last_avail_idx %d last_used_idx %d\n",
2997 vui->vrings[q].qsz, vui->vrings[q].last_avail_idx,
2998 vui->vrings[q].last_used_idx);
3000 if (vui->vrings[q].avail && vui->vrings[q].used)
3001 vlib_cli_output (vm,
3002 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
3003 vui->vrings[q].avail->flags,
3004 vui->vrings[q].avail->idx,
3005 vui->vrings[q].used->flags,
3006 vui->vrings[q].used->idx);
3008 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
3009 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
3010 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n",
3011 kickfd, callfd, vui->vrings[q].errfd);
3015 vlib_cli_output (vm, "\n descriptor table:\n");
3016 vlib_cli_output (vm,
3017 " id addr len flags next user_addr\n");
3018 vlib_cli_output (vm,
3019 " ===== ================== ===== ====== ===== ==================\n");
3020 for (j = 0; j < vui->vrings[q].qsz; j++)
3023 vlib_cli_output (vm,
3024 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
3025 j, vui->vrings[q].desc[j].addr,
3026 vui->vrings[q].desc[j].len,
3027 vui->vrings[q].desc[j].flags,
3028 vui->vrings[q].desc[j].next,
3029 pointer_to_uword (map_guest_mem
3031 vui->vrings[q].desc[j].
3036 vlib_cli_output (vm, "\n");
3039 vec_free (hw_if_indices);
3048 * Create a vHost User interface. Once created, a new virtual interface
3049 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
3050 * is the next free index.
3052 * There are several parameters associated with a vHost interface:
3054 * - <b>socket <socket-filename></b> - Name of the linux socket used by QEMU/VM and
3055 * VPP to manage the vHost interface. If socket does not already exist, VPP will
3056 * create the socket.
3058 * - <b>server</b> - Optional flag to indicate that VPP should be the server for the
3059 * linux socket. If not provided, VPP will be the client.
3061 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
3062 * startup. By default, all supported features will be advertised. Otherwise,
3063 * provide the set of features desired.
3064 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
3065 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
3066 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
3067 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
3068 * - 0x004000000 (26) - VHOST_F_LOG_ALL
3069 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
3070 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
3071 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
3072 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
3074 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
3075 * X:X:X:X:X:X unix or X.X.X cisco format.
3077 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
3078 * in the name to be specified. If instance already exists, name will be used
3079 * anyway and multiple instances will have the same name. Use with caution.
3082 * Example of how to create a vhost interface with VPP as the client and all features enabled:
3083 * @cliexstart{create vhost-user socket /tmp/vhost1.sock}
3084 * VirtualEthernet0/0/0
3086 * Example of how to create a vhost interface with VPP as the server and with just
3087 * multiple queues enabled:
3088 * @cliexstart{create vhost-user socket /tmp/vhost2.sock server feature-mask 0x40400000}
3089 * VirtualEthernet0/0/1
3091 * Once the vHost interface is created, enable the interface using:
3092 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
3095 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
3096 .path = "create vhost-user",
3097 .short_help = "create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>]",
3098 .function = vhost_user_connect_command_fn,
3103 * Delete a vHost User interface using the interface name or the
3104 * software interface index. Use the '<em>show interfaces</em>'
3105 * command to determine the software interface index. On deletion,
3106 * the linux socket will not be deleted.
3109 * Example of how to delete a vhost interface by name:
3110 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
3111 * Example of how to delete a vhost interface by software interface index:
3112 * @cliexcmd{delete vhost-user sw_if_index 1}
3115 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
3116 .path = "delete vhost-user",
3117 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
3118 .function = vhost_user_delete_command_fn,
3122 * Display the attributes of a single vHost User interface (provide interface
3123 * name), multiple vHost User interfaces (provide a list of interface names seperated
3124 * by spaces) or all Vhost User interfaces (omit an interface name to display all
3125 * vHost interfaces).
3129 * Example of how to display a vhost interface:
3130 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
3131 * Virtio vhost-user interfaces
3133 * coalesce frames 32 time 1e-3
3134 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3135 * virtio_net_hdr_sz 12
3136 * features mask (0xffffffffffffffff):
3137 * features (0x50408000):
3138 * VIRTIO_NET_F_MRG_RXBUF (15)
3139 * VIRTIO_NET_F_MQ (22)
3140 * VIRTIO_F_INDIRECT_DESC (28)
3141 * VHOST_USER_F_PROTOCOL_FEATURES (30)
3142 * protocol features (0x3)
3143 * VHOST_USER_PROTOCOL_F_MQ (0)
3144 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
3146 * socket filename /tmp/vhost1.sock type client errno "Success"
3149 * thread 1 on vring 1
3150 * thread 1 on vring 5
3151 * thread 2 on vring 3
3152 * thread 2 on vring 7
3153 * tx placement: spin-lock
3154 * thread 0 on vring 0
3155 * thread 1 on vring 2
3156 * thread 2 on vring 0
3158 * Memory regions (total 2)
3159 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
3160 * ====== ===== ================== ================== ================== ================== ==================
3161 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
3162 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
3165 * qsz 256 last_avail_idx 0 last_used_idx 0
3166 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3167 * kickfd 62 callfd 64 errfd -1
3170 * qsz 256 last_avail_idx 0 last_used_idx 0
3171 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3172 * kickfd 65 callfd 66 errfd -1
3175 * qsz 256 last_avail_idx 0 last_used_idx 0
3176 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3177 * kickfd 63 callfd 70 errfd -1
3180 * qsz 256 last_avail_idx 0 last_used_idx 0
3181 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3182 * kickfd 72 callfd 74 errfd -1
3184 * Virtqueue 4 (TX disabled)
3185 * qsz 256 last_avail_idx 0 last_used_idx 0
3186 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3187 * kickfd 76 callfd 78 errfd -1
3189 * Virtqueue 5 (RX disabled)
3190 * qsz 256 last_avail_idx 0 last_used_idx 0
3191 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3192 * kickfd 80 callfd 82 errfd -1
3194 * Virtqueue 6 (TX disabled)
3195 * qsz 256 last_avail_idx 0 last_used_idx 0
3196 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3197 * kickfd 84 callfd 86 errfd -1
3199 * Virtqueue 7 (RX disabled)
3200 * qsz 256 last_avail_idx 0 last_used_idx 0
3201 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3202 * kickfd 88 callfd 90 errfd -1
3206 * The optional '<em>descriptors</em>' parameter will display the same output as
3207 * the previous example but will include the descriptor table for each queue.
3208 * The output is truncated below:
3209 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
3210 * Virtio vhost-user interfaces
3212 * coalesce frames 32 time 1e-3
3213 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3214 * virtio_net_hdr_sz 12
3215 * features mask (0xffffffffffffffff):
3216 * features (0x50408000):
3217 * VIRTIO_NET_F_MRG_RXBUF (15)
3218 * VIRTIO_NET_F_MQ (22)
3221 * qsz 256 last_avail_idx 0 last_used_idx 0
3222 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3223 * kickfd 62 callfd 64 errfd -1
3226 * id addr len flags next user_addr
3227 * ===== ================== ===== ====== ===== ==================
3228 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
3229 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
3230 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
3231 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
3232 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
3233 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
3234 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
3235 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
3236 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
3237 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
3238 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
3240 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
3241 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
3242 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
3243 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
3244 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
3245 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
3246 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
3249 * qsz 256 last_avail_idx 0 last_used_idx 0
3255 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
3256 .path = "show vhost-user",
3257 .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
3258 .function = show_vhost_user_command_fn,
3262 static clib_error_t *
3263 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
3265 vhost_user_main_t *vum = &vhost_user_main;
3267 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3269 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
3271 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
3273 else if (unformat (input, "dont-dump-memory"))
3274 vum->dont_dump_vhost_user_memory = 1;
3276 return clib_error_return (0, "unknown input `%U'",
3277 format_unformat_error, input);
3283 /* vhost-user { ... } configuration. */
3284 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
3287 vhost_user_unmap_all (void)
3289 vhost_user_main_t *vum = &vhost_user_main;
3290 vhost_user_intf_t *vui;
3292 if (vum->dont_dump_vhost_user_memory)
3294 pool_foreach (vui, vum->vhost_user_interfaces,
3295 unmap_all_mem_regions (vui);
3300 static clib_error_t *
3301 vhost_thread_command_fn (vlib_main_t * vm,
3302 unformat_input_t * input, vlib_cli_command_t * cmd)
3304 unformat_input_t _line_input, *line_input = &_line_input;
3305 u32 worker_thread_index;
3309 clib_error_t *error = NULL;
3311 /* Get a line of input. */
3312 if (!unformat_user (input, unformat_line_input, line_input))
3316 (line_input, "%U %d", unformat_vnet_sw_interface, vnet_get_main (),
3317 &sw_if_index, &worker_thread_index))
3319 error = clib_error_return (0, "unknown input `%U'",
3320 format_unformat_error, line_input);
3324 if (unformat (line_input, "del"))
3328 vhost_user_thread_placement (sw_if_index, worker_thread_index, del)))
3330 error = clib_error_return (0, "vhost_user_thread_placement returned %d",
3336 unformat_free (line_input);
3343 * This command is used to move the RX processing for the given
3344 * interfaces to the provided thread. If the '<em>del</em>' option is used,
3345 * the forced thread assignment is removed and the thread assigment is
3346 * reassigned automatically. Use '<em>show vhost-user <interface></em>'
3347 * to see the thread assignment.
3350 * Example of how to move the RX processing for a given interface to a given thread:
3351 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1}
3352 * Example of how to remove the forced thread assignment for a given interface:
3353 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1 del}
3356 VLIB_CLI_COMMAND (vhost_user_thread_command, static) = {
3357 .path = "vhost thread",
3358 .short_help = "vhost thread <iface> <worker-index> [del]",
3359 .function = vhost_thread_command_fn,
3364 * fd.io coding-style-patch-verification: ON
3367 * eval: (c-set-style "gnu")