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 - 1) & ~(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
334 u32 thread_index = 0;
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[thread_index] = qid;
346 if (thread_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;
351 if (thread_index == 0)
353 //Could not find a single valid one
354 for (thread_index = 0;
355 thread_index < vlib_get_thread_main ()->n_vlib_mains;
358 vui->per_cpu_tx_qid[thread_index] = 0;
366 vhost_user_rx_thread_placement ()
368 vhost_user_main_t *vum = &vhost_user_main;
369 vhost_user_intf_t *vui;
375 //Let's list all workers cpu indexes
377 for (i = vum->input_cpu_first_index;
378 i < vum->input_cpu_first_index + vum->input_cpu_count; i++)
380 vlib_node_set_state (vlib_mains[i], vhost_user_input_node.index,
381 VLIB_NODE_STATE_DISABLED);
382 vec_add1 (workers, i);
385 vec_foreach (vhc, vum->cpus)
387 vec_reset_length (vhc->rx_queues);
391 vhost_iface_and_queue_t iaq;
393 pool_foreach (vui, vum->vhost_user_interfaces, {
394 u32 *vui_workers = vec_len (vui->workers) ? vui->workers : workers;
396 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
398 vhost_user_vring_t *txvq =
399 &vui->vrings[VHOST_VRING_IDX_TX (qid)];
403 i %= vec_len (vui_workers);
404 thread_index = vui_workers[i];
406 vhc = &vum->cpus[thread_index];
407 txvq->interrupt_thread_index = thread_index;
410 iaq.vhost_iface_index = vui - vum->vhost_user_interfaces;
411 vec_add1 (vhc->rx_queues, iaq);
416 vec_foreach (vhc, vum->cpus)
418 vhost_iface_and_queue_t *vhiq;
419 u8 mode = VHOST_USER_INTERRUPT_MODE;
421 vec_foreach (vhiq, vhc->rx_queues)
423 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
424 if (vui->operation_mode == VHOST_USER_POLLING_MODE)
426 /* At least one interface is polling, cpu is set to polling */
427 mode = VHOST_USER_POLLING_MODE;
431 vhc->operation_mode = mode;
434 for (thread_index = vum->input_cpu_first_index;
435 thread_index < vum->input_cpu_first_index + vum->input_cpu_count;
438 vlib_node_state_t state = VLIB_NODE_STATE_POLLING;
440 vhc = &vum->cpus[thread_index];
441 vm = vlib_mains ? vlib_mains[thread_index] : &vlib_global_main;
442 switch (vhc->operation_mode)
444 case VHOST_USER_INTERRUPT_MODE:
445 state = VLIB_NODE_STATE_INTERRUPT;
447 case VHOST_USER_POLLING_MODE:
448 state = VLIB_NODE_STATE_POLLING;
451 clib_warning ("BUG: bad operation mode %d", vhc->operation_mode);
454 vlib_node_set_state (vm, vhost_user_input_node.index, state);
461 vhost_user_thread_placement (u32 sw_if_index, u32 worker_thread_index, u8 del)
463 vhost_user_main_t *vum = &vhost_user_main;
464 vhost_user_intf_t *vui;
465 vnet_hw_interface_t *hw;
467 if (worker_thread_index < vum->input_cpu_first_index ||
468 worker_thread_index >=
469 vum->input_cpu_first_index + vum->input_cpu_count)
472 if (!(hw = vnet_get_sup_hw_interface (vnet_get_main (), sw_if_index)))
475 vui = pool_elt_at_index (vum->vhost_user_interfaces, hw->dev_instance);
477 vec_foreach (w, vui->workers)
479 if (*w == worker_thread_index)
481 found = w - vui->workers;
490 vec_del1 (vui->workers, found);
492 else if (found == ~0)
494 vec_add1 (vui->workers, worker_thread_index);
497 vhost_user_rx_thread_placement ();
501 /** @brief Returns whether at least one TX and one RX vring are enabled */
503 vhost_user_intf_ready (vhost_user_intf_t * vui)
505 int i, found[2] = { }; //RX + TX
507 for (i = 0; i < VHOST_VRING_MAX_N; i++)
508 if (vui->vrings[i].started && vui->vrings[i].enabled)
511 return found[0] && found[1];
515 vhost_user_update_iface_state (vhost_user_intf_t * vui)
517 /* if we have pointers to descriptor table, go up */
518 int is_up = vhost_user_intf_ready (vui);
519 if (is_up != vui->is_up)
521 DBG_SOCK ("interface %d %s", vui->sw_if_index,
522 is_up ? "ready" : "down");
523 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
524 is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
528 vhost_user_rx_thread_placement ();
529 vhost_user_tx_thread_placement (vui);
533 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
535 vhost_user_main_t *vum = &vhost_user_main;
540 vhost_user_vring_t *txvq;
544 /* Only care about the odd number virtqueue which is TX */
547 if (vhost_user_intf_ready (vui))
549 txvq = &vui->vrings[qid];
550 thread_index = txvq->interrupt_thread_index;
551 vhc = &vum->cpus[thread_index];
552 if (vhc->operation_mode == VHOST_USER_INTERRUPT_MODE)
554 vm = vlib_mains ? vlib_mains[thread_index] : &vlib_global_main;
556 * Convert virtqueue number in the lower byte to vring
557 * queue index for the input node process. Top bytes contain
558 * the interface, lower byte contains the queue index.
560 ifq2 = ((ifq >> 8) << 8) | qid / 2;
561 vhc->pending_input_bitmap =
562 clib_bitmap_set (vhc->pending_input_bitmap, ifq2, 1);
563 vlib_node_set_interrupt_pending (vm, vhost_user_input_node.index);
568 static clib_error_t *
569 vhost_user_callfd_read_ready (unix_file_t * uf)
571 __attribute__ ((unused)) int n;
573 vhost_user_intf_t *vui =
574 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
575 uf->private_data >> 8);
577 n = read (uf->file_descriptor, ((char *) &buff), 8);
578 DBG_SOCK ("if %d CALL queue %d", uf->private_data >> 8,
579 uf->private_data & 0xff);
580 vhost_user_set_interrupt_pending (vui, uf->private_data);
585 static clib_error_t *
586 vhost_user_kickfd_read_ready (unix_file_t * uf)
588 __attribute__ ((unused)) int n;
590 vhost_user_intf_t *vui =
591 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
592 uf->private_data >> 8);
593 u32 qid = uf->private_data & 0xff;
595 n = read (uf->file_descriptor, ((char *) &buff), 8);
596 DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
597 if (!vui->vrings[qid].started ||
598 (vhost_user_intf_ready (vui) != vui->is_up))
600 vlib_worker_thread_barrier_sync (vlib_get_main ());
601 vui->vrings[qid].started = 1;
602 vhost_user_update_iface_state (vui);
603 vlib_worker_thread_barrier_release (vlib_get_main ());
606 vhost_user_set_interrupt_pending (vui, uf->private_data);
611 * @brief Try once to lock the vring
612 * @return 0 on success, non-zero on failure.
615 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
617 return __sync_lock_test_and_set (vui->vring_locks[qid], 1);
621 * @brief Spin until the vring is successfully locked
624 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
626 while (vhost_user_vring_try_lock (vui, qid))
631 * @brief Unlock the vring lock
634 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
636 *vui->vring_locks[qid] = 0;
640 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
642 vhost_user_vring_t *vring = &vui->vrings[qid];
643 memset (vring, 0, sizeof (*vring));
644 vring->kickfd_idx = ~0;
645 vring->callfd_idx = ~0;
649 * We have a bug with some qemu 2.5, and this may be a fix.
650 * Feel like interpretation holy text, but this is from vhost-user.txt.
652 * One queue pair is enabled initially. More queues are enabled
653 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
655 * Don't know who's right, but this is what DPDK does.
657 if (qid == 0 || qid == 1)
662 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
664 vhost_user_vring_t *vring = &vui->vrings[qid];
665 if (vring->kickfd_idx != ~0)
667 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
669 unix_file_del (&unix_main, uf);
670 vring->kickfd_idx = ~0;
672 if (vring->callfd_idx != ~0)
674 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
676 unix_file_del (&unix_main, uf);
677 vring->callfd_idx = ~0;
679 if (vring->errfd != -1)
681 close (vring->errfd);
684 vhost_user_vring_init (vui, qid);
688 vhost_user_if_disconnect (vhost_user_intf_t * vui)
690 vnet_main_t *vnm = vnet_get_main ();
693 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
695 if (vui->unix_file_index != ~0)
697 unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
698 vui->unix_file_index = ~0;
703 for (q = 0; q < VHOST_VRING_MAX_N; q++)
704 vhost_user_vring_close (vui, q);
706 unmap_all_mem_regions (vui);
707 DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
710 #define VHOST_LOG_PAGE 0x1000
711 static_always_inline void
712 vhost_user_log_dirty_pages_2 (vhost_user_intf_t * vui,
713 u64 addr, u64 len, u8 is_host_address)
715 if (PREDICT_TRUE (vui->log_base_addr == 0
716 || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
722 addr = pointer_to_uword (map_user_mem (vui, (uword) addr));
724 if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
726 DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
730 CLIB_MEMORY_BARRIER ();
731 u64 page = addr / VHOST_LOG_PAGE;
732 while (page * VHOST_LOG_PAGE < addr + len)
734 ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
739 static_always_inline void
740 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
742 vhost_user_log_dirty_pages_2 (vui, addr, len, 0);
745 #define vhost_user_log_dirty_ring(vui, vq, member) \
746 if (PREDICT_FALSE(vq->log_used)) { \
747 vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
748 sizeof(vq->used->member)); \
751 static clib_error_t *
752 vhost_user_socket_read (unix_file_t * uf)
755 int fd, number_of_fds = 0;
756 int fds[VHOST_MEMORY_MAX_NREGIONS];
757 vhost_user_msg_t msg;
760 vhost_user_main_t *vum = &vhost_user_main;
761 vhost_user_intf_t *vui;
762 struct cmsghdr *cmsg;
764 unix_file_t template = { 0 };
765 vnet_main_t *vnm = vnet_get_main ();
767 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
769 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
771 memset (&mh, 0, sizeof (mh));
772 memset (control, 0, sizeof (control));
774 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
777 /* set the payload */
778 iov[0].iov_base = (void *) &msg;
779 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
783 mh.msg_control = control;
784 mh.msg_controllen = sizeof (control);
786 n = recvmsg (uf->file_descriptor, &mh, 0);
788 /* Stop workers to avoid end of the world */
789 vlib_worker_thread_barrier_sync (vlib_get_main ());
791 if (n != VHOST_USER_MSG_HDR_SZ)
795 DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
799 DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
800 n, VHOST_USER_MSG_HDR_SZ);
805 if (mh.msg_flags & MSG_CTRUNC)
807 DBG_SOCK ("MSG_CTRUNC is set");
811 cmsg = CMSG_FIRSTHDR (&mh);
813 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
814 (cmsg->cmsg_type == SCM_RIGHTS) &&
815 (cmsg->cmsg_len - CMSG_LEN (0) <=
816 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
818 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
819 clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
822 /* version 1, no reply bit set */
823 if ((msg.flags & 7) != 1)
825 DBG_SOCK ("malformed message received. closing socket");
832 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
836 DBG_SOCK ("read failed %s", strerror (errno));
839 else if (rv != msg.size)
841 DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
848 case VHOST_USER_GET_FEATURES:
850 msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
851 (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
852 (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
853 (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
854 (1ULL << FEAT_VHOST_F_LOG_ALL) |
855 (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
856 (1ULL << FEAT_VIRTIO_NET_F_MQ) |
857 (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
858 (1ULL << FEAT_VIRTIO_F_VERSION_1);
859 msg.u64 &= vui->feature_mask;
860 msg.size = sizeof (msg.u64);
861 DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
862 vui->hw_if_index, msg.u64);
865 case VHOST_USER_SET_FEATURES:
866 DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
867 vui->hw_if_index, msg.u64);
869 vui->features = msg.u64;
872 ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
873 (1ULL << FEAT_VIRTIO_F_VERSION_1)))
874 vui->virtio_net_hdr_sz = 12;
876 vui->virtio_net_hdr_sz = 10;
879 (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
881 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
882 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
885 /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
886 vhost_user_vring_close(&vui->vrings[q]); */
890 case VHOST_USER_SET_MEM_TABLE:
891 DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
892 vui->hw_if_index, msg.memory.nregions);
894 if ((msg.memory.nregions < 1) ||
895 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
898 DBG_SOCK ("number of mem regions must be between 1 and %i",
899 VHOST_MEMORY_MAX_NREGIONS);
904 if (msg.memory.nregions != number_of_fds)
906 DBG_SOCK ("each memory region must have FD");
909 unmap_all_mem_regions (vui);
910 for (i = 0; i < msg.memory.nregions; i++)
912 clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
913 sizeof (vhost_user_memory_region_t));
915 long page_sz = get_huge_page_size (fds[i]);
917 /* align size to 2M page */
918 ssize_t map_sz = (vui->regions[i].memory_size +
919 vui->regions[i].mmap_offset +
920 page_sz - 1) & ~(page_sz - 1);
922 vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
923 MAP_SHARED, fds[i], 0);
924 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
925 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
926 vui->regions[i].memory_size;
929 ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
930 "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
933 if (vui->region_mmap_addr[i] == MAP_FAILED)
935 clib_warning ("failed to map memory. errno is %d", errno);
938 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
939 vui->region_mmap_fd[i] = fds[i];
941 vui->nregions = msg.memory.nregions;
944 case VHOST_USER_SET_VRING_NUM:
945 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
946 vui->hw_if_index, msg.state.index, msg.state.num);
948 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
949 (msg.state.num == 0) || /* it cannot be zero */
950 ((msg.state.num - 1) & msg.state.num)) /* must be power of 2 */
952 vui->vrings[msg.state.index].qsz = msg.state.num;
955 case VHOST_USER_SET_VRING_ADDR:
956 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
957 vui->hw_if_index, msg.state.index);
959 if (msg.state.index >= VHOST_VRING_MAX_N)
961 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
962 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
966 if (msg.size < sizeof (msg.addr))
968 DBG_SOCK ("vhost message is too short (%d < %d)",
969 msg.size, sizeof (msg.addr));
973 vui->vrings[msg.state.index].desc = (vring_desc_t *)
974 map_user_mem (vui, msg.addr.desc_user_addr);
975 vui->vrings[msg.state.index].used = (vring_used_t *)
976 map_user_mem (vui, msg.addr.used_user_addr);
977 vui->vrings[msg.state.index].avail = (vring_avail_t *)
978 map_user_mem (vui, msg.addr.avail_user_addr);
980 if ((vui->vrings[msg.state.index].desc == NULL) ||
981 (vui->vrings[msg.state.index].used == NULL) ||
982 (vui->vrings[msg.state.index].avail == NULL))
984 DBG_SOCK ("failed to map user memory for hw_if_index %d",
989 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
990 vui->vrings[msg.state.index].log_used =
991 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
993 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
994 the ring is initialized in an enabled state. */
995 if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
997 vui->vrings[msg.state.index].enabled = 1;
1000 vui->vrings[msg.state.index].last_used_idx =
1001 vui->vrings[msg.state.index].last_avail_idx =
1002 vui->vrings[msg.state.index].used->idx;
1004 if (vui->operation_mode == VHOST_USER_POLLING_MODE)
1005 /* tell driver that we don't want interrupts */
1006 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
1008 /* tell driver that we want interrupts */
1009 vui->vrings[msg.state.index].used->flags = 0;
1012 case VHOST_USER_SET_OWNER:
1013 DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
1016 case VHOST_USER_RESET_OWNER:
1017 DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
1020 case VHOST_USER_SET_VRING_CALL:
1021 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL u64 %d",
1022 vui->hw_if_index, msg.u64);
1024 q = (u8) (msg.u64 & 0xFF);
1026 /* if there is old fd, delete and close it */
1027 if (vui->vrings[q].callfd_idx != ~0)
1029 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
1030 vui->vrings[q].callfd_idx);
1031 unix_file_del (&unix_main, uf);
1032 vui->vrings[q].callfd_idx = ~0;
1035 if (!(msg.u64 & 0x100))
1037 if (number_of_fds != 1)
1039 DBG_SOCK ("More than one fd received !");
1043 template.read_function = vhost_user_callfd_read_ready;
1044 template.file_descriptor = fds[0];
1045 template.private_data =
1046 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
1047 vui->vrings[q].callfd_idx = unix_file_add (&unix_main, &template);
1050 vui->vrings[q].callfd_idx = ~0;
1053 case VHOST_USER_SET_VRING_KICK:
1054 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK u64 %d",
1055 vui->hw_if_index, msg.u64);
1057 q = (u8) (msg.u64 & 0xFF);
1059 if (vui->vrings[q].kickfd_idx != ~0)
1061 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
1062 vui->vrings[q].kickfd_idx);
1063 unix_file_del (&unix_main, uf);
1064 vui->vrings[q].kickfd_idx = ~0;
1067 if (!(msg.u64 & 0x100))
1069 if (number_of_fds != 1)
1071 DBG_SOCK ("More than one fd received !");
1075 template.read_function = vhost_user_kickfd_read_ready;
1076 template.file_descriptor = fds[0];
1077 template.private_data =
1078 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
1080 vui->vrings[q].kickfd_idx = unix_file_add (&unix_main, &template);
1084 //When no kickfd is set, the queue is initialized as started
1085 vui->vrings[q].kickfd_idx = ~0;
1086 vui->vrings[q].started = 1;
1091 case VHOST_USER_SET_VRING_ERR:
1092 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR u64 %d",
1093 vui->hw_if_index, msg.u64);
1095 q = (u8) (msg.u64 & 0xFF);
1097 if (vui->vrings[q].errfd != -1)
1098 close (vui->vrings[q].errfd);
1100 if (!(msg.u64 & 0x100))
1102 if (number_of_fds != 1)
1105 vui->vrings[q].errfd = fds[0];
1108 vui->vrings[q].errfd = -1;
1112 case VHOST_USER_SET_VRING_BASE:
1113 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1114 vui->hw_if_index, msg.state.index, msg.state.num);
1116 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
1119 case VHOST_USER_GET_VRING_BASE:
1120 DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1121 vui->hw_if_index, msg.state.index, msg.state.num);
1123 if (msg.state.index >= VHOST_VRING_MAX_N)
1125 DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
1126 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1131 * Copy last_avail_idx from the vring before closing it because
1132 * closing the vring also initializes the vring last_avail_idx
1134 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
1136 msg.size = sizeof (msg.state);
1138 /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
1139 vhost_user_vring_close (vui, msg.state.index);
1142 case VHOST_USER_NONE:
1143 DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
1147 case VHOST_USER_SET_LOG_BASE:
1149 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
1151 if (msg.size != sizeof (msg.log))
1154 ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
1155 msg.size, sizeof (msg.log));
1160 (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
1163 ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
1168 /* align size to 2M page */
1169 long page_sz = get_huge_page_size (fd);
1171 (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
1173 vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
1177 ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
1178 map_sz, msg.log.offset, fd, vui->log_base_addr);
1180 if (vui->log_base_addr == MAP_FAILED)
1182 clib_warning ("failed to map memory. errno is %d", errno);
1186 vui->log_base_addr += msg.log.offset;
1187 vui->log_size = msg.log.size;
1190 msg.size = sizeof (msg.u64);
1195 case VHOST_USER_SET_LOG_FD:
1196 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
1200 case VHOST_USER_GET_PROTOCOL_FEATURES:
1201 DBG_SOCK ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
1205 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
1206 (1 << VHOST_USER_PROTOCOL_F_MQ);
1207 msg.size = sizeof (msg.u64);
1210 case VHOST_USER_SET_PROTOCOL_FEATURES:
1211 DBG_SOCK ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%lx",
1212 vui->hw_if_index, msg.u64);
1214 vui->protocol_features = msg.u64;
1218 case VHOST_USER_GET_QUEUE_NUM:
1219 DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM", vui->hw_if_index);
1221 msg.u64 = VHOST_VRING_MAX_N;
1222 msg.size = sizeof (msg.u64);
1225 case VHOST_USER_SET_VRING_ENABLE:
1226 DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
1227 vui->hw_if_index, msg.state.num ? "enable" : "disable",
1229 if (msg.state.index >= VHOST_VRING_MAX_N)
1231 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
1232 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1236 vui->vrings[msg.state.index].enabled = msg.state.num;
1240 DBG_SOCK ("unknown vhost-user message %d received. closing socket",
1245 /* if we need to reply */
1249 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1250 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1252 DBG_SOCK ("could not send message response");
1257 vhost_user_update_iface_state (vui);
1258 vlib_worker_thread_barrier_release (vlib_get_main ());
1262 vhost_user_if_disconnect (vui);
1263 vhost_user_update_iface_state (vui);
1264 vlib_worker_thread_barrier_release (vlib_get_main ());
1268 static clib_error_t *
1269 vhost_user_socket_error (unix_file_t * uf)
1271 vlib_main_t *vm = vlib_get_main ();
1272 vhost_user_main_t *vum = &vhost_user_main;
1273 vhost_user_intf_t *vui =
1274 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1276 DBG_SOCK ("socket error on if %d", vui->sw_if_index);
1277 vlib_worker_thread_barrier_sync (vm);
1278 vhost_user_if_disconnect (vui);
1279 vhost_user_rx_thread_placement ();
1280 vlib_worker_thread_barrier_release (vm);
1284 static clib_error_t *
1285 vhost_user_socksvr_accept_ready (unix_file_t * uf)
1287 int client_fd, client_len;
1288 struct sockaddr_un client;
1289 unix_file_t template = { 0 };
1290 vhost_user_main_t *vum = &vhost_user_main;
1291 vhost_user_intf_t *vui;
1293 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1295 client_len = sizeof (client);
1296 client_fd = accept (uf->file_descriptor,
1297 (struct sockaddr *) &client,
1298 (socklen_t *) & client_len);
1301 return clib_error_return_unix (0, "accept");
1303 DBG_SOCK ("New client socket for vhost interface %d", vui->sw_if_index);
1304 template.read_function = vhost_user_socket_read;
1305 template.error_function = vhost_user_socket_error;
1306 template.file_descriptor = client_fd;
1307 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1308 vui->unix_file_index = unix_file_add (&unix_main, &template);
1312 static clib_error_t *
1313 vhost_user_init (vlib_main_t * vm)
1315 clib_error_t *error;
1316 vhost_user_main_t *vum = &vhost_user_main;
1317 vlib_thread_main_t *tm = vlib_get_thread_main ();
1318 vlib_thread_registration_t *tr;
1321 error = vlib_call_init_function (vm, ip4_init);
1325 vum->coalesce_frames = 32;
1326 vum->coalesce_time = 1e-3;
1328 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1331 vec_foreach (cpu, vum->cpus)
1333 /* This is actually not necessary as validate already zeroes it
1334 * Just keeping the loop here for later because I am lazy. */
1335 cpu->rx_buffers_len = 0;
1338 /* find out which cpus will be used for input */
1339 vum->input_cpu_first_index = 0;
1340 vum->input_cpu_count = 1;
1341 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1342 tr = p ? (vlib_thread_registration_t *) p[0] : 0;
1344 if (tr && tr->count > 0)
1346 vum->input_cpu_first_index = tr->first_index;
1347 vum->input_cpu_count = tr->count;
1350 vum->random = random_default_seed ();
1352 mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
1357 VLIB_INIT_FUNCTION (vhost_user_init);
1360 format_vhost_trace (u8 * s, va_list * va)
1362 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
1363 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
1364 CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
1365 vhost_user_main_t *vum = &vhost_user_main;
1366 vhost_trace_t *t = va_arg (*va, vhost_trace_t *);
1367 vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
1370 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
1372 uword indent = format_get_indent (s);
1374 s = format (s, "%U %U queue %d\n", format_white_space, indent,
1375 format_vnet_sw_interface_name, vnm, sw, t->qid);
1377 s = format (s, "%U virtio flags:\n", format_white_space, indent);
1379 if (t->virtio_ring_flags & (1 << VIRTIO_TRACE_F_##n)) \
1380 s = format (s, "%U %s %s\n", format_white_space, indent, #n, st);
1381 foreach_virtio_trace_flags
1383 s = format (s, "%U virtio_net_hdr first_desc_len %u\n",
1384 format_white_space, indent, t->first_desc_len);
1386 s = format (s, "%U flags 0x%02x gso_type %u\n",
1387 format_white_space, indent,
1388 t->hdr.hdr.flags, t->hdr.hdr.gso_type);
1390 if (vui->virtio_net_hdr_sz == 12)
1391 s = format (s, "%U num_buff %u",
1392 format_white_space, indent, t->hdr.num_buffers);
1398 vhost_user_rx_trace (vhost_trace_t * t,
1399 vhost_user_intf_t * vui, u16 qid,
1400 vlib_buffer_t * b, vhost_user_vring_t * txvq)
1402 vhost_user_main_t *vum = &vhost_user_main;
1403 u32 qsz_mask = txvq->qsz - 1;
1404 u32 last_avail_idx = txvq->last_avail_idx;
1405 u32 desc_current = txvq->avail->ring[last_avail_idx & qsz_mask];
1406 vring_desc_t *hdr_desc = 0;
1407 virtio_net_hdr_mrg_rxbuf_t *hdr;
1410 memset (t, 0, sizeof (*t));
1411 t->device_index = vui - vum->vhost_user_interfaces;
1414 hdr_desc = &txvq->desc[desc_current];
1415 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1417 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1418 /* Header is the first here */
1419 hdr_desc = map_guest_mem (vui, txvq->desc[desc_current].addr, &hint);
1421 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1423 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1425 if (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1426 !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1428 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1431 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1433 if (!hdr_desc || !(hdr = map_guest_mem (vui, hdr_desc->addr, &hint)))
1435 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_MAP_ERROR;
1439 u32 len = vui->virtio_net_hdr_sz;
1440 memcpy (&t->hdr, hdr, len > hdr_desc->len ? hdr_desc->len : len);
1445 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1447 vhost_user_main_t *vum = &vhost_user_main;
1449 int fd = UNIX_GET_FD (vq->callfd_idx);
1450 int rv __attribute__ ((unused));
1451 /* TODO: pay attention to rv */
1452 rv = write (fd, &x, sizeof (x));
1453 vq->n_since_last_int = 0;
1454 vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1457 static_always_inline u32
1458 vhost_user_input_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1459 u16 copy_len, u32 * map_hint)
1461 void *src0, *src1, *src2, *src3;
1462 if (PREDICT_TRUE (copy_len >= 4))
1464 if (PREDICT_FALSE (!(src2 = map_guest_mem (vui, cpy[0].src, map_hint))))
1466 if (PREDICT_FALSE (!(src3 = map_guest_mem (vui, cpy[1].src, map_hint))))
1469 while (PREDICT_TRUE (copy_len >= 4))
1475 (!(src2 = map_guest_mem (vui, cpy[2].src, map_hint))))
1478 (!(src3 = map_guest_mem (vui, cpy[3].src, map_hint))))
1481 CLIB_PREFETCH (src2, 64, LOAD);
1482 CLIB_PREFETCH (src3, 64, LOAD);
1484 clib_memcpy ((void *) cpy[0].dst, src0, cpy[0].len);
1485 clib_memcpy ((void *) cpy[1].dst, src1, cpy[1].len);
1492 if (PREDICT_FALSE (!(src0 = map_guest_mem (vui, cpy->src, map_hint))))
1494 clib_memcpy ((void *) cpy->dst, src0, cpy->len);
1502 * Try to discard packets from the tx ring (VPP RX path).
1503 * Returns the number of discarded packets.
1506 vhost_user_rx_discard_packet (vlib_main_t * vm,
1507 vhost_user_intf_t * vui,
1508 vhost_user_vring_t * txvq, u32 discard_max)
1511 * On the RX side, each packet corresponds to one descriptor
1512 * (it is the same whether it is a shallow descriptor, chained, or indirect).
1513 * Therefore, discarding a packet is like discarding a descriptor.
1515 u32 discarded_packets = 0;
1516 u32 avail_idx = txvq->avail->idx;
1517 u16 qsz_mask = txvq->qsz - 1;
1518 while (discarded_packets != discard_max)
1520 if (avail_idx == txvq->last_avail_idx)
1523 u16 desc_chain_head =
1524 txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1525 txvq->last_avail_idx++;
1526 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_chain_head;
1527 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1528 vhost_user_log_dirty_ring (vui, txvq,
1529 ring[txvq->last_used_idx & qsz_mask]);
1530 txvq->last_used_idx++;
1531 discarded_packets++;
1535 CLIB_MEMORY_BARRIER ();
1536 txvq->used->idx = txvq->last_used_idx;
1537 vhost_user_log_dirty_ring (vui, txvq, idx);
1538 return discarded_packets;
1542 * In case of overflow, we need to rewind the array of allocated buffers.
1545 vhost_user_input_rewind_buffers (vlib_main_t * vm,
1546 vhost_cpu_t * cpu, vlib_buffer_t * b_head)
1548 u32 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1549 vlib_buffer_t *b_current = vlib_get_buffer (vm, bi_current);
1550 b_current->current_length = 0;
1551 b_current->flags = 0;
1552 while (b_current != b_head)
1554 cpu->rx_buffers_len++;
1555 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1556 b_current = vlib_get_buffer (vm, bi_current);
1557 b_current->current_length = 0;
1558 b_current->flags = 0;
1560 cpu->rx_buffers_len++;
1564 vhost_user_if_input (vlib_main_t * vm,
1565 vhost_user_main_t * vum,
1566 vhost_user_intf_t * vui,
1567 u16 qid, vlib_node_runtime_t * node)
1569 vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
1570 u16 n_rx_packets = 0;
1573 u32 n_left_to_next, *to_next;
1574 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1575 u32 n_trace = vlib_get_trace_count (vm, node);
1578 u16 thread_index = vlib_get_thread_index ();
1582 /* do we have pending interrupts ? */
1583 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
1584 f64 now = vlib_time_now (vm);
1586 if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1587 vhost_user_send_call (vm, txvq);
1589 if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1590 vhost_user_send_call (vm, rxvq);
1593 if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1596 n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1599 if (PREDICT_FALSE (n_left == 0))
1602 if (PREDICT_FALSE (!vui->admin_up || !(txvq->enabled)))
1605 * Discard input packet if interface is admin down or vring is not
1607 * "For example, for a networking device, in the disabled state
1608 * client must not supply any new RX packets, but must process
1609 * and discard any TX packets."
1611 vhost_user_rx_discard_packet (vm, vui, txvq,
1612 VHOST_USER_DOWN_DISCARD_COUNT);
1616 if (PREDICT_FALSE (n_left == txvq->qsz))
1619 * Informational error logging when VPP is not
1620 * receiving packets fast enough.
1622 vlib_error_count (vm, node->node_index,
1623 VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1626 qsz_mask = txvq->qsz - 1;
1628 if (n_left > VLIB_FRAME_SIZE)
1629 n_left = VLIB_FRAME_SIZE;
1632 * For small packets (<2kB), we will not need more than one vlib buffer
1633 * per packet. In case packets are bigger, we will just yeld at some point
1634 * in the loop and come back later. This is not an issue as for big packet,
1635 * processing cost really comes from the memory copy.
1637 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len < n_left + 1))
1639 u32 curr_len = vum->cpus[thread_index].rx_buffers_len;
1640 vum->cpus[thread_index].rx_buffers_len +=
1641 vlib_buffer_alloc_from_free_list (vm,
1642 vum->cpus[thread_index].rx_buffers +
1644 VHOST_USER_RX_BUFFERS_N - curr_len,
1645 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1648 (vum->cpus[thread_index].rx_buffers_len <
1649 VHOST_USER_RX_BUFFER_STARVATION))
1651 /* In case of buffer starvation, discard some packets from the queue
1652 * and log the event.
1653 * We keep doing best effort for the remaining packets. */
1654 u32 flush = (n_left + 1 > vum->cpus[thread_index].rx_buffers_len) ?
1655 n_left + 1 - vum->cpus[thread_index].rx_buffers_len : 1;
1656 flush = vhost_user_rx_discard_packet (vm, vui, txvq, flush);
1659 vlib_increment_simple_counter (vnet_main.
1660 interface_main.sw_if_counters +
1661 VNET_INTERFACE_COUNTER_DROP,
1662 vlib_get_thread_index (),
1663 vui->sw_if_index, flush);
1665 vlib_error_count (vm, vhost_user_input_node.index,
1666 VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1672 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1674 while (n_left > 0 && n_left_to_next > 0)
1676 vlib_buffer_t *b_head, *b_current;
1679 u32 desc_data_offset;
1680 vring_desc_t *desc_table = txvq->desc;
1682 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len <= 1))
1684 /* Not enough rx_buffers
1685 * Note: We yeld on 1 so we don't need to do an additional
1686 * check for the next buffer prefetch.
1692 desc_current = txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1693 vum->cpus[thread_index].rx_buffers_len--;
1694 bi_current = (vum->cpus[thread_index].rx_buffers)
1695 [vum->cpus[thread_index].rx_buffers_len];
1696 b_head = b_current = vlib_get_buffer (vm, bi_current);
1697 to_next[0] = bi_current; //We do that now so we can forget about bi_current
1701 vlib_prefetch_buffer_with_index (vm,
1703 cpus[thread_index].rx_buffers)
1704 [vum->cpus[thread_index].
1705 rx_buffers_len - 1], LOAD);
1707 /* Just preset the used descriptor id and length for later */
1708 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_current;
1709 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1710 vhost_user_log_dirty_ring (vui, txvq,
1711 ring[txvq->last_used_idx & qsz_mask]);
1713 /* The buffer should already be initialized */
1714 b_head->total_length_not_including_first_buffer = 0;
1715 b_head->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1717 if (PREDICT_FALSE (n_trace))
1719 //TODO: next_index is not exactly known at that point
1720 vlib_trace_buffer (vm, node, next_index, b_head,
1721 /* follow_chain */ 0);
1723 vlib_add_trace (vm, node, b_head, sizeof (t0[0]));
1724 vhost_user_rx_trace (t0, vui, qid, b_head, txvq);
1726 vlib_set_trace_count (vm, node, n_trace);
1729 /* This depends on the setup but is very consistent
1730 * So I think the CPU branch predictor will make a pretty good job
1731 * at optimizing the decision. */
1732 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1734 desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1737 if (PREDICT_FALSE (desc_table == 0))
1739 vlib_error_count (vm, node->node_index,
1740 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1745 if (PREDICT_TRUE (vui->is_any_layout) ||
1746 (!(desc_table[desc_current].flags & VIRTQ_DESC_F_NEXT)))
1748 /* ANYLAYOUT or single buffer */
1749 desc_data_offset = vui->virtio_net_hdr_sz;
1753 /* CSR case without ANYLAYOUT, skip 1st buffer */
1754 desc_data_offset = desc_table[desc_current].len;
1759 /* Get more input if necessary. Or end of packet. */
1760 if (desc_data_offset == desc_table[desc_current].len)
1762 if (PREDICT_FALSE (desc_table[desc_current].flags &
1765 desc_current = desc_table[desc_current].next;
1766 desc_data_offset = 0;
1774 /* Get more output if necessary. Or end of packet. */
1776 (b_current->current_length == VLIB_BUFFER_DATA_SIZE))
1779 (vum->cpus[thread_index].rx_buffers_len == 0))
1781 /* Cancel speculation */
1786 * Checking if there are some left buffers.
1787 * If not, just rewind the used buffers and stop.
1788 * Note: Scheduled copies are not cancelled. This is
1789 * not an issue as they would still be valid. Useless,
1792 vhost_user_input_rewind_buffers (vm,
1800 /* Get next output */
1801 vum->cpus[thread_index].rx_buffers_len--;
1803 (vum->cpus[thread_index].rx_buffers)[vum->cpus
1804 [thread_index].rx_buffers_len];
1805 b_current->next_buffer = bi_next;
1806 b_current->flags |= VLIB_BUFFER_NEXT_PRESENT;
1807 bi_current = bi_next;
1808 b_current = vlib_get_buffer (vm, bi_current);
1811 /* Prepare a copy order executed later for the data */
1812 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
1815 desc_table[desc_current].len - desc_data_offset;
1816 cpy->len = VLIB_BUFFER_DATA_SIZE - b_current->current_length;
1817 cpy->len = (cpy->len > desc_data_l) ? desc_data_l : cpy->len;
1818 cpy->dst = (uword) (vlib_buffer_get_current (b_current) +
1819 b_current->current_length);
1820 cpy->src = desc_table[desc_current].addr + desc_data_offset;
1822 desc_data_offset += cpy->len;
1824 b_current->current_length += cpy->len;
1825 b_head->total_length_not_including_first_buffer += cpy->len;
1829 CLIB_PREFETCH (&n_left, sizeof (n_left), LOAD);
1831 n_rx_bytes += b_head->total_length_not_including_first_buffer;
1834 b_head->total_length_not_including_first_buffer -=
1835 b_head->current_length;
1837 /* consume the descriptor and return it as used */
1838 txvq->last_avail_idx++;
1839 txvq->last_used_idx++;
1841 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1843 vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1844 vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1848 u32 next0 = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1850 /* redirect if feature path enabled */
1851 vnet_feature_start_device_input_x1 (vui->sw_if_index, &next0,
1854 u32 bi = to_next[-1]; //Cannot use to_next[-1] in the macro
1855 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1856 to_next, n_left_to_next,
1863 * Although separating memory copies from virtio ring parsing
1864 * is beneficial, we can offer to perform the copies from time
1865 * to time in order to free some space in the ring.
1867 if (PREDICT_FALSE (copy_len >= VHOST_USER_RX_COPY_THRESHOLD))
1870 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1871 copy_len, &map_hint)))
1873 vlib_error_count (vm, node->node_index,
1874 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1878 /* give buffers back to driver */
1879 CLIB_MEMORY_BARRIER ();
1880 txvq->used->idx = txvq->last_used_idx;
1881 vhost_user_log_dirty_ring (vui, txvq, idx);
1885 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1888 /* Do the memory copies */
1890 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1891 copy_len, &map_hint)))
1893 vlib_error_count (vm, node->node_index,
1894 VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1897 /* give buffers back to driver */
1898 CLIB_MEMORY_BARRIER ();
1899 txvq->used->idx = txvq->last_used_idx;
1900 vhost_user_log_dirty_ring (vui, txvq, idx);
1902 /* interrupt (call) handling */
1903 if ((txvq->callfd_idx != ~0) &&
1904 !(txvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
1906 txvq->n_since_last_int += n_rx_packets;
1908 if (txvq->n_since_last_int > vum->coalesce_frames)
1909 vhost_user_send_call (vm, txvq);
1912 /* increase rx counters */
1913 vlib_increment_combined_counter
1914 (vnet_main.interface_main.combined_sw_if_counters
1915 + VNET_INTERFACE_COUNTER_RX,
1916 vlib_get_thread_index (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1918 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
1920 return n_rx_packets;
1924 vhost_user_input (vlib_main_t * vm,
1925 vlib_node_runtime_t * node, vlib_frame_t * f)
1927 vhost_user_main_t *vum = &vhost_user_main;
1928 uword n_rx_packets = 0;
1929 u32 thread_index = vlib_get_thread_index ();
1930 vhost_iface_and_queue_t *vhiq;
1931 vhost_user_intf_t *vui;
1934 vhc = &vum->cpus[thread_index];
1935 if (PREDICT_TRUE (vhc->operation_mode == VHOST_USER_POLLING_MODE))
1937 vec_foreach (vhiq, vum->cpus[thread_index].rx_queues)
1939 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
1940 n_rx_packets += vhost_user_if_input (vm, vum, vui, vhiq->qid, node);
1948 clib_bitmap_foreach (i, vhc->pending_input_bitmap, ({
1951 clib_bitmap_set (vhc->pending_input_bitmap, i, 0);
1952 vui = pool_elt_at_index (vum->vhost_user_interfaces, i >> 8);
1953 n_rx_packets += vhost_user_if_input (vm, vum, vui, qid, node);
1957 return n_rx_packets;
1961 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1962 .function = vhost_user_input,
1963 .type = VLIB_NODE_TYPE_INPUT,
1964 .name = "vhost-user-input",
1965 .sibling_of = "device-input",
1967 /* Will be enabled if/when hardware is detected. */
1968 .state = VLIB_NODE_STATE_DISABLED,
1970 .format_buffer = format_ethernet_header_with_length,
1971 .format_trace = format_vhost_trace,
1973 .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1974 .error_strings = vhost_user_input_func_error_strings,
1977 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
1982 vhost_user_tx_trace (vhost_trace_t * t,
1983 vhost_user_intf_t * vui, u16 qid,
1984 vlib_buffer_t * b, vhost_user_vring_t * rxvq)
1986 vhost_user_main_t *vum = &vhost_user_main;
1987 u32 qsz_mask = rxvq->qsz - 1;
1988 u32 last_avail_idx = rxvq->last_avail_idx;
1989 u32 desc_current = rxvq->avail->ring[last_avail_idx & qsz_mask];
1990 vring_desc_t *hdr_desc = 0;
1993 memset (t, 0, sizeof (*t));
1994 t->device_index = vui - vum->vhost_user_interfaces;
1997 hdr_desc = &rxvq->desc[desc_current];
1998 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
2000 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
2001 /* Header is the first here */
2002 hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
2004 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
2006 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
2008 if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
2009 !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
2011 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
2014 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
2017 static_always_inline u32
2018 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
2019 u16 copy_len, u32 * map_hint)
2021 void *dst0, *dst1, *dst2, *dst3;
2022 if (PREDICT_TRUE (copy_len >= 4))
2024 if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
2026 if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
2028 while (PREDICT_TRUE (copy_len >= 4))
2034 (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
2037 (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
2040 CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
2041 CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
2043 clib_memcpy (dst0, (void *) cpy[0].src, cpy[0].len);
2044 clib_memcpy (dst1, (void *) cpy[1].src, cpy[1].len);
2046 vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
2047 vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
2054 if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
2056 clib_memcpy (dst0, (void *) cpy->src, cpy->len);
2057 vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
2066 vhost_user_tx (vlib_main_t * vm,
2067 vlib_node_runtime_t * node, vlib_frame_t * frame)
2069 u32 *buffers = vlib_frame_args (frame);
2070 u32 n_left = frame->n_vectors;
2071 vhost_user_main_t *vum = &vhost_user_main;
2072 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
2073 vhost_user_intf_t *vui =
2074 pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
2076 vhost_user_vring_t *rxvq;
2079 u32 thread_index = vlib_get_thread_index ();
2085 if (PREDICT_FALSE (!vui->admin_up))
2087 error = VHOST_USER_TX_FUNC_ERROR_DOWN;
2091 if (PREDICT_FALSE (!vui->is_up))
2093 error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
2098 VHOST_VRING_IDX_RX (*vec_elt_at_index
2099 (vui->per_cpu_tx_qid, vlib_get_thread_index ()));
2100 rxvq = &vui->vrings[qid];
2101 if (PREDICT_FALSE (vui->use_tx_spinlock))
2102 vhost_user_vring_lock (vui, qid);
2104 qsz_mask = rxvq->qsz - 1; /* qsz is always power of 2 */
2107 error = VHOST_USER_TX_FUNC_ERROR_NONE;
2112 vlib_buffer_t *b0, *current_b0;
2113 u16 desc_head, desc_index, desc_len;
2114 vring_desc_t *desc_table;
2115 uword buffer_map_addr;
2119 if (PREDICT_TRUE (n_left > 1))
2120 vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
2122 b0 = vlib_get_buffer (vm, buffers[0]);
2124 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2126 vum->cpus[thread_index].current_trace =
2127 vlib_add_trace (vm, node, b0,
2128 sizeof (*vum->cpus[thread_index].current_trace));
2129 vhost_user_tx_trace (vum->cpus[thread_index].current_trace,
2130 vui, qid / 2, b0, rxvq);
2133 if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
2135 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2139 desc_table = rxvq->desc;
2140 desc_head = desc_index =
2141 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2143 /* Go deeper in case of indirect descriptor
2144 * I don't know of any driver providing indirect for RX. */
2145 if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2148 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2150 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2155 map_guest_mem (vui, rxvq->desc[desc_index].addr,
2158 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2164 desc_len = vui->virtio_net_hdr_sz;
2165 buffer_map_addr = desc_table[desc_index].addr;
2166 buffer_len = desc_table[desc_index].len;
2169 // Get a header from the header array
2170 virtio_net_hdr_mrg_rxbuf_t *hdr =
2171 &vum->cpus[thread_index].tx_headers[tx_headers_len];
2174 hdr->hdr.gso_type = 0;
2175 hdr->num_buffers = 1; //This is local, no need to check
2177 // Prepare a copy order executed later for the header
2178 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2180 cpy->len = vui->virtio_net_hdr_sz;
2181 cpy->dst = buffer_map_addr;
2182 cpy->src = (uword) hdr;
2185 buffer_map_addr += vui->virtio_net_hdr_sz;
2186 buffer_len -= vui->virtio_net_hdr_sz;
2187 bytes_left = b0->current_length;
2191 if (buffer_len == 0)
2193 if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
2195 //Next one is chained
2196 desc_index = desc_table[desc_index].next;
2197 buffer_map_addr = desc_table[desc_index].addr;
2198 buffer_len = desc_table[desc_index].len;
2200 else if (vui->virtio_net_hdr_sz == 12) //MRG is available
2202 virtio_net_hdr_mrg_rxbuf_t *hdr =
2203 &vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2205 //Move from available to used buffer
2206 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id =
2208 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len =
2210 vhost_user_log_dirty_ring (vui, rxvq,
2211 ring[rxvq->last_used_idx &
2214 rxvq->last_avail_idx++;
2215 rxvq->last_used_idx++;
2220 (rxvq->last_avail_idx == rxvq->avail->idx))
2222 //Dequeue queued descriptors for this packet
2223 rxvq->last_used_idx -= hdr->num_buffers - 1;
2224 rxvq->last_avail_idx -= hdr->num_buffers - 1;
2225 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2229 desc_table = rxvq->desc;
2230 desc_head = desc_index =
2231 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2233 (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2235 //It is seriously unlikely that a driver will put indirect descriptor
2236 //after non-indirect descriptor.
2238 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2240 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2246 rxvq->desc[desc_index].addr,
2249 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2254 buffer_map_addr = desc_table[desc_index].addr;
2255 buffer_len = desc_table[desc_index].len;
2259 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
2265 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2267 cpy->len = bytes_left;
2268 cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
2269 cpy->dst = buffer_map_addr;
2270 cpy->src = (uword) vlib_buffer_get_current (current_b0) +
2271 current_b0->current_length - bytes_left;
2273 bytes_left -= cpy->len;
2274 buffer_len -= cpy->len;
2275 buffer_map_addr += cpy->len;
2276 desc_len += cpy->len;
2278 CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
2281 // Check if vlib buffer has more data. If not, get more or break.
2282 if (PREDICT_TRUE (!bytes_left))
2285 (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
2287 current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
2288 bytes_left = current_b0->current_length;
2298 //Move from available to used ring
2299 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id = desc_head;
2300 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len = desc_len;
2301 vhost_user_log_dirty_ring (vui, rxvq,
2302 ring[rxvq->last_used_idx & qsz_mask]);
2303 rxvq->last_avail_idx++;
2304 rxvq->last_used_idx++;
2306 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2308 vum->cpus[thread_index].current_trace->hdr =
2309 vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2312 n_left--; //At the end for error counting when 'goto done' is invoked
2317 //Do the memory copies
2319 (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2320 copy_len, &map_hint)))
2322 vlib_error_count (vm, node->node_index,
2323 VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
2326 CLIB_MEMORY_BARRIER ();
2327 rxvq->used->idx = rxvq->last_used_idx;
2328 vhost_user_log_dirty_ring (vui, rxvq, idx);
2331 * When n_left is set, error is always set to something too.
2332 * In case error is due to lack of remaining buffers, we go back up and
2334 * The idea is that it is better to waste some time on packets
2335 * that have been processed already than dropping them and get
2336 * more fresh packets with a good likelyhood that they will be dropped too.
2337 * This technique also gives more time to VM driver to pick-up packets.
2338 * In case the traffic flows from physical to virtual interfaces, this
2339 * technique will end-up leveraging the physical NIC buffer in order to
2340 * absorb the VM's CPU jitter.
2342 if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
2348 /* interrupt (call) handling */
2349 if ((rxvq->callfd_idx != ~0) &&
2350 !(rxvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
2352 rxvq->n_since_last_int += frame->n_vectors - n_left;
2354 if (rxvq->n_since_last_int > vum->coalesce_frames)
2355 vhost_user_send_call (vm, rxvq);
2358 vhost_user_vring_unlock (vui, qid);
2361 if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
2363 vlib_error_count (vm, node->node_index, error, n_left);
2364 vlib_increment_simple_counter
2365 (vnet_main.interface_main.sw_if_counters
2366 + VNET_INTERFACE_COUNTER_DROP,
2367 vlib_get_thread_index (), vui->sw_if_index, n_left);
2370 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
2371 return frame->n_vectors;
2374 static clib_error_t *
2375 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
2378 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2379 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
2380 vhost_user_main_t *vum = &vhost_user_main;
2381 vhost_user_intf_t *vui =
2382 pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2384 vui->admin_up = is_up;
2387 vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
2388 VNET_HW_INTERFACE_FLAG_LINK_UP);
2390 return /* no error */ 0;
2394 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
2395 .name = "vhost-user",
2396 .tx_function = vhost_user_tx,
2397 .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
2398 .tx_function_error_strings = vhost_user_tx_func_error_strings,
2399 .format_device_name = format_vhost_user_interface_name,
2400 .name_renumber = vhost_user_name_renumber,
2401 .admin_up_down_function = vhost_user_interface_admin_up_down,
2402 .format_tx_trace = format_vhost_trace,
2405 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
2410 vhost_user_process (vlib_main_t * vm,
2411 vlib_node_runtime_t * rt, vlib_frame_t * f)
2413 vhost_user_main_t *vum = &vhost_user_main;
2414 vhost_user_intf_t *vui;
2415 struct sockaddr_un sun;
2417 unix_file_t template = { 0 };
2418 f64 timeout = 3153600000.0 /* 100 years */ ;
2419 uword *event_data = 0;
2422 sun.sun_family = AF_UNIX;
2423 template.read_function = vhost_user_socket_read;
2424 template.error_function = vhost_user_socket_error;
2428 vlib_process_wait_for_event_or_clock (vm, timeout);
2429 vlib_process_get_events (vm, &event_data);
2430 vec_reset_length (event_data);
2435 pool_foreach (vui, vum->vhost_user_interfaces, {
2437 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
2438 if (vui->unix_file_index == ~0)
2441 ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
2444 * 1st time error or new error for this interface,
2445 * spit out the message and record the error
2447 if (!vui->sock_errno || (vui->sock_errno != errno))
2450 ("Error: Could not open unix socket for %s",
2451 vui->sock_filename);
2452 vui->sock_errno = errno;
2457 /* try to connect */
2458 strncpy (sun.sun_path, (char *) vui->sock_filename,
2459 sizeof (sun.sun_path) - 1);
2461 /* Avoid hanging VPP if the other end does not accept */
2462 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
2463 clib_unix_warning ("fcntl");
2465 if (connect (sockfd, (struct sockaddr *) &sun,
2466 sizeof (struct sockaddr_un)) == 0)
2468 /* Set the socket to blocking as it was before */
2469 if (fcntl(sockfd, F_SETFL, 0) < 0)
2470 clib_unix_warning ("fcntl2");
2472 vui->sock_errno = 0;
2473 template.file_descriptor = sockfd;
2474 template.private_data =
2475 vui - vhost_user_main.vhost_user_interfaces;
2476 vui->unix_file_index = unix_file_add (&unix_main, &template);
2478 /* This sockfd is considered consumed */
2483 vui->sock_errno = errno;
2488 /* check if socket is alive */
2490 socklen_t len = sizeof (error);
2491 int fd = UNIX_GET_FD(vui->unix_file_index);
2493 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
2497 DBG_SOCK ("getsockopt returned %d", retval);
2498 vhost_user_if_disconnect (vui);
2509 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
2510 .function = vhost_user_process,
2511 .type = VLIB_NODE_TYPE_PROCESS,
2512 .name = "vhost-user-process",
2517 * Disables and reset interface structure.
2518 * It can then be either init again, or removed from used interfaces.
2521 vhost_user_term_if (vhost_user_intf_t * vui)
2524 vhost_user_main_t *vum = &vhost_user_main;
2526 // Delete configured thread pinning
2527 vec_reset_length (vui->workers);
2528 // disconnect interface sockets
2529 vhost_user_if_disconnect (vui);
2530 vhost_user_update_iface_state (vui);
2532 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2534 clib_mem_free ((void *) vui->vring_locks[q]);
2537 if (vui->unix_server_index != ~0)
2539 //Close server socket
2540 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
2541 vui->unix_server_index);
2542 unix_file_del (&unix_main, uf);
2543 vui->unix_server_index = ~0;
2544 unlink (vui->sock_filename);
2547 mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
2552 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
2554 vhost_user_main_t *vum = &vhost_user_main;
2555 vhost_user_intf_t *vui;
2557 vnet_hw_interface_t *hwif;
2559 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2560 hwif->dev_class_index != vhost_user_dev_class.index)
2561 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2563 DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
2564 hwif->name, hwif->dev_instance);
2566 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2568 // Disable and reset interface
2569 vhost_user_term_if (vui);
2571 // Reset renumbered iface
2572 if (hwif->dev_instance <
2573 vec_len (vum->show_dev_instance_by_real_dev_instance))
2574 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
2576 // Delete ethernet interface
2577 ethernet_delete_interface (vnm, vui->hw_if_index);
2580 pool_put (vum->vhost_user_interfaces, vui);
2585 static clib_error_t *
2586 vhost_user_exit (vlib_main_t * vm)
2588 vnet_main_t *vnm = vnet_get_main ();
2589 vhost_user_main_t *vum = &vhost_user_main;
2590 vhost_user_intf_t *vui;
2592 vlib_worker_thread_barrier_sync (vlib_get_main ());
2594 pool_foreach (vui, vum->vhost_user_interfaces, {
2595 vhost_user_delete_if (vnm, vm, vui->sw_if_index);
2598 vlib_worker_thread_barrier_release (vlib_get_main ());
2602 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
2605 * Open server unix socket on specified sock_filename.
2608 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
2611 struct sockaddr_un un = { };
2613 /* create listening socket */
2614 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
2615 return VNET_API_ERROR_SYSCALL_ERROR_1;
2617 un.sun_family = AF_UNIX;
2618 strncpy ((char *) un.sun_path, (char *) sock_filename,
2619 sizeof (un.sun_path) - 1);
2621 /* remove if exists */
2622 unlink ((char *) sock_filename);
2624 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
2626 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
2630 if (listen (fd, 1) == -1)
2632 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
2645 * Create ethernet interface for vhost user interface.
2648 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
2649 vhost_user_intf_t * vui, u8 * hwaddress)
2651 vhost_user_main_t *vum = &vhost_user_main;
2653 clib_error_t *error;
2655 /* create hw and sw interface */
2658 clib_memcpy (hwaddr, hwaddress, 6);
2662 random_u32 (&vum->random);
2663 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
2668 error = ethernet_register_interface
2670 vhost_user_dev_class.index,
2671 vui - vum->vhost_user_interfaces /* device instance */ ,
2672 hwaddr /* ethernet address */ ,
2673 &vui->hw_if_index, 0 /* flag change */ );
2676 clib_error_report (error);
2678 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, vui->hw_if_index);
2679 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
2683 * Initialize vui with specified attributes
2686 vhost_user_vui_init (vnet_main_t * vnm,
2687 vhost_user_intf_t * vui,
2689 const char *sock_filename,
2690 u64 feature_mask, u32 * sw_if_index, u8 operation_mode)
2692 vnet_sw_interface_t *sw;
2693 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
2695 vhost_user_main_t *vum = &vhost_user_main;
2697 if (server_sock_fd != -1)
2699 unix_file_t template = { 0 };
2700 template.read_function = vhost_user_socksvr_accept_ready;
2701 template.file_descriptor = server_sock_fd;
2702 template.private_data = vui - vum->vhost_user_interfaces; //hw index
2703 vui->unix_server_index = unix_file_add (&unix_main, &template);
2707 vui->unix_server_index = ~0;
2710 vui->sw_if_index = sw->sw_if_index;
2711 strncpy (vui->sock_filename, sock_filename,
2712 ARRAY_LEN (vui->sock_filename) - 1);
2713 vui->sock_errno = 0;
2715 vui->feature_mask = feature_mask;
2716 vui->unix_file_index = ~0;
2717 vui->log_base_addr = 0;
2718 vui->operation_mode = operation_mode;
2719 vui->if_index = vui - vum->vhost_user_interfaces;
2720 mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
2723 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2724 vhost_user_vring_init (vui, q);
2726 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
2729 *sw_if_index = vui->sw_if_index;
2731 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2733 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
2734 CLIB_CACHE_LINE_BYTES);
2735 memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
2738 vec_validate (vui->per_cpu_tx_qid,
2739 vlib_get_thread_main ()->n_vlib_mains - 1);
2740 vhost_user_tx_thread_placement (vui);
2744 vhost_user_send_interrupt_process (vlib_main_t * vm,
2745 vlib_node_runtime_t * rt, vlib_frame_t * f)
2747 vhost_user_intf_t *vui;
2748 f64 timeout = 3153600000.0 /* 100 years */ ;
2749 uword event_type, *event_data = 0;
2750 vhost_user_main_t *vum = &vhost_user_main;
2751 vhost_iface_and_queue_t *vhiq;
2753 f64 now, poll_time_remaining;
2757 poll_time_remaining =
2758 vlib_process_wait_for_event_or_clock (vm, timeout);
2759 event_type = vlib_process_get_events (vm, &event_data);
2760 vec_reset_length (event_data);
2763 * Use the remaining timeout if it is less than coalesce time to avoid
2764 * resetting the existing timer in the middle of expiration
2766 timeout = poll_time_remaining;
2767 if (vlib_process_suspend_time_is_zero (timeout) ||
2768 (timeout > vum->coalesce_time))
2769 timeout = vum->coalesce_time;
2771 now = vlib_time_now (vm);
2774 case VHOST_USER_EVENT_START_TIMER:
2775 if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
2780 vec_foreach (vhc, vum->cpus)
2782 u32 thread_index = vhc - vum->cpus;
2785 next_timeout = timeout;
2786 vec_foreach (vhiq, vum->cpus[thread_index].rx_queues)
2788 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
2789 vhost_user_vring_t *rxvq =
2790 &vui->vrings[VHOST_VRING_IDX_RX (vhiq->qid)];
2791 vhost_user_vring_t *txvq =
2792 &vui->vrings[VHOST_VRING_IDX_TX (vhiq->qid)];
2794 if (txvq->n_since_last_int)
2796 if (now >= txvq->int_deadline)
2797 vhost_user_send_call (vm, txvq);
2799 next_timeout = txvq->int_deadline - now;
2802 if (rxvq->n_since_last_int)
2804 if (now >= rxvq->int_deadline)
2805 vhost_user_send_call (vm, rxvq);
2807 next_timeout = rxvq->int_deadline - now;
2810 if ((next_timeout < timeout) && (next_timeout > 0.0))
2811 timeout = next_timeout;
2817 clib_warning ("BUG: unhandled event type %d", event_type);
2820 /* No less than 1 millisecond */
2828 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node,static) = {
2829 .function = vhost_user_send_interrupt_process,
2830 .type = VLIB_NODE_TYPE_PROCESS,
2831 .name = "vhost-user-send-interrupt-process",
2836 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2837 const char *sock_filename,
2841 u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
2844 vhost_user_intf_t *vui = NULL;
2847 int server_sock_fd = -1;
2848 vhost_user_main_t *vum = &vhost_user_main;
2851 if ((operation_mode != VHOST_USER_POLLING_MODE) &&
2852 (operation_mode != VHOST_USER_INTERRUPT_MODE))
2853 return VNET_API_ERROR_UNIMPLEMENTED;
2855 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2857 return VNET_API_ERROR_INVALID_ARGUMENT;
2860 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
2865 vui = &vum->vhost_user_interfaces[*if_index];
2866 *sw_if_index = vui->sw_if_index;
2868 return VNET_API_ERROR_IF_ALREADY_EXISTS;
2874 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
2880 pool_get (vhost_user_main.vhost_user_interfaces, vui);
2882 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2883 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
2884 feature_mask, &sw_if_idx, operation_mode);
2887 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2890 *sw_if_index = sw_if_idx;
2892 // Process node must connect
2893 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2895 if ((operation_mode == VHOST_USER_INTERRUPT_MODE) &&
2896 !vum->interrupt_mode && (vum->coalesce_time > 0.0) &&
2897 (vum->coalesce_frames > 0))
2899 vum->interrupt_mode = 1;
2900 vlib_process_signal_event (vm, vhost_user_send_interrupt_node.index,
2901 VHOST_USER_EVENT_START_TIMER, 0);
2907 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2908 const char *sock_filename,
2911 u64 feature_mask, u8 renumber, u32 custom_dev_instance,
2914 vhost_user_main_t *vum = &vhost_user_main;
2915 vhost_user_intf_t *vui = NULL;
2917 int server_sock_fd = -1;
2919 vnet_hw_interface_t *hwif;
2922 if ((operation_mode != VHOST_USER_POLLING_MODE) &&
2923 (operation_mode != VHOST_USER_INTERRUPT_MODE))
2924 return VNET_API_ERROR_UNIMPLEMENTED;
2925 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2926 hwif->dev_class_index != vhost_user_dev_class.index)
2927 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2929 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2930 return VNET_API_ERROR_INVALID_ARGUMENT;
2932 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2935 * Disallow changing the interface to have the same path name
2936 * as other interface
2938 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
2939 if (if_index && (*if_index != vui->if_index))
2940 return VNET_API_ERROR_IF_ALREADY_EXISTS;
2942 // First try to open server socket
2944 if ((rv = vhost_user_init_server_sock (sock_filename,
2945 &server_sock_fd)) != 0)
2948 vhost_user_term_if (vui);
2949 vhost_user_vui_init (vnm, vui, server_sock_fd,
2950 sock_filename, feature_mask, &sw_if_idx,
2954 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2956 // Process node must connect
2957 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2959 if ((operation_mode == VHOST_USER_INTERRUPT_MODE) &&
2960 !vum->interrupt_mode && (vum->coalesce_time > 0.0) &&
2961 (vum->coalesce_frames > 0))
2963 vum->interrupt_mode = 1;
2964 vlib_process_signal_event (vm, vhost_user_send_interrupt_node.index,
2965 VHOST_USER_EVENT_START_TIMER, 0);
2971 unformat_vhost_user_operation_mode (unformat_input_t * input, va_list * args)
2973 u8 *operation_mode = va_arg (*args, u8 *);
2976 if (unformat (input, "interrupt"))
2977 *operation_mode = VHOST_USER_INTERRUPT_MODE;
2978 else if (unformat (input, "polling"))
2979 *operation_mode = VHOST_USER_POLLING_MODE;
2987 vhost_user_connect_command_fn (vlib_main_t * vm,
2988 unformat_input_t * input,
2989 vlib_cli_command_t * cmd)
2991 unformat_input_t _line_input, *line_input = &_line_input;
2992 u8 *sock_filename = NULL;
2995 u64 feature_mask = (u64) ~ (0ULL);
2997 u32 custom_dev_instance = ~0;
3000 clib_error_t *error = NULL;
3001 u8 operation_mode = VHOST_USER_POLLING_MODE;
3003 /* Get a line of input. */
3004 if (!unformat_user (input, unformat_line_input, line_input))
3007 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3009 if (unformat (line_input, "socket %s", &sock_filename))
3011 else if (unformat (line_input, "server"))
3013 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
3017 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
3019 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
3023 else if (unformat (line_input, "mode %U",
3024 unformat_vhost_user_operation_mode, &operation_mode))
3028 error = clib_error_return (0, "unknown input `%U'",
3029 format_unformat_error, line_input);
3034 vnet_main_t *vnm = vnet_get_main ();
3037 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
3038 is_server, &sw_if_index, feature_mask,
3039 renumber, custom_dev_instance, hw,
3042 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
3046 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
3050 vec_free (sock_filename);
3051 unformat_free (line_input);
3057 vhost_user_delete_command_fn (vlib_main_t * vm,
3058 unformat_input_t * input,
3059 vlib_cli_command_t * cmd)
3061 unformat_input_t _line_input, *line_input = &_line_input;
3062 u32 sw_if_index = ~0;
3063 vnet_main_t *vnm = vnet_get_main ();
3064 clib_error_t *error = NULL;
3066 /* Get a line of input. */
3067 if (!unformat_user (input, unformat_line_input, line_input))
3070 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3072 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
3075 (line_input, "%U", unformat_vnet_sw_interface, vnm,
3078 vnet_hw_interface_t *hwif =
3079 vnet_get_sup_hw_interface (vnm, sw_if_index);
3081 vhost_user_dev_class.index != hwif->dev_class_index)
3083 error = clib_error_return (0, "Not a vhost interface");
3089 error = clib_error_return (0, "unknown input `%U'",
3090 format_unformat_error, line_input);
3095 vhost_user_delete_if (vnm, vm, sw_if_index);
3098 unformat_free (line_input);
3104 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
3105 vhost_user_intf_details_t ** out_vuids)
3108 vhost_user_main_t *vum = &vhost_user_main;
3109 vhost_user_intf_t *vui;
3110 vhost_user_intf_details_t *r_vuids = NULL;
3111 vhost_user_intf_details_t *vuid = NULL;
3112 u32 *hw_if_indices = 0;
3113 vnet_hw_interface_t *hi;
3120 pool_foreach (vui, vum->vhost_user_interfaces,
3121 vec_add1 (hw_if_indices, vui->hw_if_index);
3124 for (i = 0; i < vec_len (hw_if_indices); i++)
3126 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3127 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3129 vec_add2 (r_vuids, vuid, 1);
3130 vuid->operation_mode = vui->operation_mode;
3131 vuid->sw_if_index = vui->sw_if_index;
3132 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
3133 vuid->features = vui->features;
3134 vuid->num_regions = vui->nregions;
3135 vuid->is_server = vui->unix_server_index != ~0;
3136 vuid->sock_errno = vui->sock_errno;
3137 strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
3138 ARRAY_LEN (vuid->sock_filename) - 1);
3140 s = format (s, "%v%c", hi->name, 0);
3142 strncpy ((char *) vuid->if_name, (char *) s,
3143 ARRAY_LEN (vuid->if_name) - 1);
3148 vec_free (hw_if_indices);
3150 *out_vuids = r_vuids;
3156 format_vhost_user_operation_mode (u8 * s, va_list * va)
3158 int operation_mode = va_arg (*va, int);
3160 switch (operation_mode)
3162 case VHOST_USER_POLLING_MODE:
3163 s = format (s, "%s", "polling");
3165 case VHOST_USER_INTERRUPT_MODE:
3166 s = format (s, "%s", "interrupt");
3169 s = format (s, "%s", "invalid");
3175 show_vhost_user_command_fn (vlib_main_t * vm,
3176 unformat_input_t * input,
3177 vlib_cli_command_t * cmd)
3179 clib_error_t *error = 0;
3180 vnet_main_t *vnm = vnet_get_main ();
3181 vhost_user_main_t *vum = &vhost_user_main;
3182 vhost_user_intf_t *vui;
3183 u32 hw_if_index, *hw_if_indices = 0;
3184 vnet_hw_interface_t *hi;
3186 vhost_iface_and_queue_t *vhiq;
3196 struct feat_struct *feat_entry;
3198 static struct feat_struct feat_array[] = {
3199 #define _(s,b) { .str = #s, .bit = b, },
3200 foreach_virtio_net_feature
3205 #define foreach_protocol_feature \
3206 _(VHOST_USER_PROTOCOL_F_MQ) \
3207 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
3209 static struct feat_struct proto_feat_array[] = {
3210 #define _(s) { .str = #s, .bit = s},
3211 foreach_protocol_feature
3216 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3219 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
3221 vec_add1 (hw_if_indices, hw_if_index);
3223 else if (unformat (input, "descriptors") || unformat (input, "desc"))
3227 error = clib_error_return (0, "unknown input `%U'",
3228 format_unformat_error, input);
3232 if (vec_len (hw_if_indices) == 0)
3234 pool_foreach (vui, vum->vhost_user_interfaces,
3235 vec_add1 (hw_if_indices, vui->hw_if_index);
3238 vlib_cli_output (vm, "Virtio vhost-user interfaces");
3239 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
3240 vum->coalesce_frames, vum->coalesce_time);
3242 for (i = 0; i < vec_len (hw_if_indices); i++)
3244 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3245 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3246 vlib_cli_output (vm, "Interface: %s (ifindex %d)",
3247 hi->name, hw_if_indices[i]);
3249 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
3250 " features mask (0x%llx): \n"
3251 " features (0x%llx): \n",
3252 vui->virtio_net_hdr_sz, vui->feature_mask,
3255 feat_entry = (struct feat_struct *) &feat_array;
3256 while (feat_entry->str)
3258 if (vui->features & (1ULL << feat_entry->bit))
3259 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3264 vlib_cli_output (vm, " protocol features (0x%llx)",
3265 vui->protocol_features);
3266 feat_entry = (struct feat_struct *) &proto_feat_array;
3267 while (feat_entry->str)
3269 if (vui->protocol_features & (1ULL << feat_entry->bit))
3270 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3275 vlib_cli_output (vm, "\n");
3277 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
3279 (vui->unix_server_index != ~0) ? "server" : "client",
3280 strerror (vui->sock_errno));
3282 vlib_cli_output (vm, " configured mode: %U\n",
3283 format_vhost_user_operation_mode, vui->operation_mode);
3284 vlib_cli_output (vm, " rx placement: ");
3285 vec_foreach (vhc, vum->cpus)
3287 vec_foreach (vhiq, vhc->rx_queues)
3289 if (vhiq->vhost_iface_index == vui - vum->vhost_user_interfaces)
3291 vlib_cli_output (vm, " thread %d on vring %d\n",
3293 VHOST_VRING_IDX_TX (vhiq->qid));
3294 vlib_cli_output (vm, " mode: %U\n",
3295 format_vhost_user_operation_mode,
3296 vhc->operation_mode);
3301 vlib_cli_output (vm, " tx placement: %s\n",
3302 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
3304 vec_foreach_index (ci, vui->per_cpu_tx_qid)
3306 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
3307 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
3310 vlib_cli_output (vm, "\n");
3312 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
3316 vlib_cli_output (vm,
3317 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
3318 vlib_cli_output (vm,
3319 " ====== ===== ================== ================== ================== ================== ==================\n");
3321 for (j = 0; j < vui->nregions; j++)
3323 vlib_cli_output (vm,
3324 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
3325 j, vui->region_mmap_fd[j],
3326 vui->regions[j].guest_phys_addr,
3327 vui->regions[j].memory_size,
3328 vui->regions[j].userspace_addr,
3329 vui->regions[j].mmap_offset,
3330 pointer_to_uword (vui->region_mmap_addr[j]));
3332 for (q = 0; q < VHOST_VRING_MAX_N; q++)
3334 if (!vui->vrings[q].started)
3337 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
3338 (q & 1) ? "RX" : "TX",
3339 vui->vrings[q].enabled ? "" : " disabled");
3341 vlib_cli_output (vm,
3342 " qsz %d last_avail_idx %d last_used_idx %d\n",
3343 vui->vrings[q].qsz, vui->vrings[q].last_avail_idx,
3344 vui->vrings[q].last_used_idx);
3346 if (vui->vrings[q].avail && vui->vrings[q].used)
3347 vlib_cli_output (vm,
3348 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
3349 vui->vrings[q].avail->flags,
3350 vui->vrings[q].avail->idx,
3351 vui->vrings[q].used->flags,
3352 vui->vrings[q].used->idx);
3354 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
3355 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
3356 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n",
3357 kickfd, callfd, vui->vrings[q].errfd);
3361 vlib_cli_output (vm, "\n descriptor table:\n");
3362 vlib_cli_output (vm,
3363 " id addr len flags next user_addr\n");
3364 vlib_cli_output (vm,
3365 " ===== ================== ===== ====== ===== ==================\n");
3366 for (j = 0; j < vui->vrings[q].qsz; j++)
3369 vlib_cli_output (vm,
3370 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
3371 j, vui->vrings[q].desc[j].addr,
3372 vui->vrings[q].desc[j].len,
3373 vui->vrings[q].desc[j].flags,
3374 vui->vrings[q].desc[j].next,
3375 pointer_to_uword (map_guest_mem
3377 vui->vrings[q].desc[j].
3382 vlib_cli_output (vm, "\n");
3385 vec_free (hw_if_indices);
3394 * Create a vHost User interface. Once created, a new virtual interface
3395 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
3396 * is the next free index.
3398 * There are several parameters associated with a vHost interface:
3400 * - <b>socket <socket-filename></b> - Name of the linux socket used by QEMU/VM and
3401 * VPP to manage the vHost interface. If socket does not already exist, VPP will
3402 * create the socket.
3404 * - <b>server</b> - Optional flag to indicate that VPP should be the server for the
3405 * linux socket. If not provided, VPP will be the client.
3407 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
3408 * startup. By default, all supported features will be advertised. Otherwise,
3409 * provide the set of features desired.
3410 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
3411 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
3412 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
3413 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
3414 * - 0x004000000 (26) - VHOST_F_LOG_ALL
3415 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
3416 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
3417 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
3418 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
3420 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
3421 * X:X:X:X:X:X unix or X.X.X cisco format.
3423 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
3424 * in the name to be specified. If instance already exists, name will be used
3425 * anyway and multiple instances will have the same name. Use with caution.
3427 * - <b>mode [interrupt | polling]</b> - Optional parameter specifying
3428 * the input thread polling policy.
3431 * Example of how to create a vhost interface with VPP as the client and all features enabled:
3432 * @cliexstart{create vhost-user socket /tmp/vhost1.sock}
3433 * VirtualEthernet0/0/0
3435 * Example of how to create a vhost interface with VPP as the server and with just
3436 * multiple queues enabled:
3437 * @cliexstart{create vhost-user socket /tmp/vhost2.sock server feature-mask 0x40400000}
3438 * VirtualEthernet0/0/1
3440 * Once the vHost interface is created, enable the interface using:
3441 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
3444 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
3445 .path = "create vhost-user",
3446 .short_help = "create vhost-user socket <socket-filename> [server] "
3447 "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] "
3448 "[mode {interrupt | polling}]",
3449 .function = vhost_user_connect_command_fn,
3454 * Delete a vHost User interface using the interface name or the
3455 * software interface index. Use the '<em>show interface</em>'
3456 * command to determine the software interface index. On deletion,
3457 * the linux socket will not be deleted.
3460 * Example of how to delete a vhost interface by name:
3461 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
3462 * Example of how to delete a vhost interface by software interface index:
3463 * @cliexcmd{delete vhost-user sw_if_index 1}
3466 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
3467 .path = "delete vhost-user",
3468 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
3469 .function = vhost_user_delete_command_fn,
3473 * Display the attributes of a single vHost User interface (provide interface
3474 * name), multiple vHost User interfaces (provide a list of interface names seperated
3475 * by spaces) or all Vhost User interfaces (omit an interface name to display all
3476 * vHost interfaces).
3480 * Example of how to display a vhost interface:
3481 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
3482 * Virtio vhost-user interfaces
3484 * coalesce frames 32 time 1e-3
3485 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3486 * virtio_net_hdr_sz 12
3487 * features mask (0xffffffffffffffff):
3488 * features (0x50408000):
3489 * VIRTIO_NET_F_MRG_RXBUF (15)
3490 * VIRTIO_NET_F_MQ (22)
3491 * VIRTIO_F_INDIRECT_DESC (28)
3492 * VHOST_USER_F_PROTOCOL_FEATURES (30)
3493 * protocol features (0x3)
3494 * VHOST_USER_PROTOCOL_F_MQ (0)
3495 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
3497 * socket filename /tmp/vhost1.sock type client errno "Success"
3500 * thread 1 on vring 1
3501 * thread 1 on vring 5
3502 * thread 2 on vring 3
3503 * thread 2 on vring 7
3504 * tx placement: spin-lock
3505 * thread 0 on vring 0
3506 * thread 1 on vring 2
3507 * thread 2 on vring 0
3509 * Memory regions (total 2)
3510 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
3511 * ====== ===== ================== ================== ================== ================== ==================
3512 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
3513 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
3516 * qsz 256 last_avail_idx 0 last_used_idx 0
3517 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3518 * kickfd 62 callfd 64 errfd -1
3521 * qsz 256 last_avail_idx 0 last_used_idx 0
3522 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3523 * kickfd 65 callfd 66 errfd -1
3526 * qsz 256 last_avail_idx 0 last_used_idx 0
3527 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3528 * kickfd 63 callfd 70 errfd -1
3531 * qsz 256 last_avail_idx 0 last_used_idx 0
3532 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3533 * kickfd 72 callfd 74 errfd -1
3535 * Virtqueue 4 (TX disabled)
3536 * qsz 256 last_avail_idx 0 last_used_idx 0
3537 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3538 * kickfd 76 callfd 78 errfd -1
3540 * Virtqueue 5 (RX disabled)
3541 * qsz 256 last_avail_idx 0 last_used_idx 0
3542 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3543 * kickfd 80 callfd 82 errfd -1
3545 * Virtqueue 6 (TX disabled)
3546 * qsz 256 last_avail_idx 0 last_used_idx 0
3547 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3548 * kickfd 84 callfd 86 errfd -1
3550 * Virtqueue 7 (RX disabled)
3551 * qsz 256 last_avail_idx 0 last_used_idx 0
3552 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3553 * kickfd 88 callfd 90 errfd -1
3557 * The optional '<em>descriptors</em>' parameter will display the same output as
3558 * the previous example but will include the descriptor table for each queue.
3559 * The output is truncated below:
3560 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
3561 * Virtio vhost-user interfaces
3563 * coalesce frames 32 time 1e-3
3564 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3565 * virtio_net_hdr_sz 12
3566 * features mask (0xffffffffffffffff):
3567 * features (0x50408000):
3568 * VIRTIO_NET_F_MRG_RXBUF (15)
3569 * VIRTIO_NET_F_MQ (22)
3572 * qsz 256 last_avail_idx 0 last_used_idx 0
3573 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3574 * kickfd 62 callfd 64 errfd -1
3577 * id addr len flags next user_addr
3578 * ===== ================== ===== ====== ===== ==================
3579 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
3580 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
3581 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
3582 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
3583 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
3584 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
3585 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
3586 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
3587 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
3588 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
3589 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
3591 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
3592 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
3593 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
3594 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
3595 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
3596 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
3597 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
3600 * qsz 256 last_avail_idx 0 last_used_idx 0
3606 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
3607 .path = "show vhost-user",
3608 .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
3609 .function = show_vhost_user_command_fn,
3613 static clib_error_t *
3614 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
3616 vhost_user_main_t *vum = &vhost_user_main;
3618 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3620 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
3622 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
3624 else if (unformat (input, "dont-dump-memory"))
3625 vum->dont_dump_vhost_user_memory = 1;
3627 return clib_error_return (0, "unknown input `%U'",
3628 format_unformat_error, input);
3634 /* vhost-user { ... } configuration. */
3635 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
3638 vhost_user_unmap_all (void)
3640 vhost_user_main_t *vum = &vhost_user_main;
3641 vhost_user_intf_t *vui;
3643 if (vum->dont_dump_vhost_user_memory)
3645 pool_foreach (vui, vum->vhost_user_interfaces,
3646 unmap_all_mem_regions (vui);
3651 static clib_error_t *
3652 vhost_thread_command_fn (vlib_main_t * vm,
3653 unformat_input_t * input, vlib_cli_command_t * cmd)
3655 unformat_input_t _line_input, *line_input = &_line_input;
3656 u32 worker_thread_index;
3660 clib_error_t *error = NULL;
3662 /* Get a line of input. */
3663 if (!unformat_user (input, unformat_line_input, line_input))
3667 (line_input, "%U %d", unformat_vnet_sw_interface, vnet_get_main (),
3668 &sw_if_index, &worker_thread_index))
3670 error = clib_error_return (0, "unknown input `%U'",
3671 format_unformat_error, line_input);
3675 if (unformat (line_input, "del"))
3679 vhost_user_thread_placement (sw_if_index, worker_thread_index, del)))
3681 error = clib_error_return (0, "vhost_user_thread_placement returned %d",
3687 unformat_free (line_input);
3694 * This command is used to move the RX processing for the given
3695 * interfaces to the provided thread. If the '<em>del</em>' option is used,
3696 * the forced thread assignment is removed and the thread assigment is
3697 * reassigned automatically. Use '<em>show vhost-user <interface></em>'
3698 * to see the thread assignment.
3701 * Example of how to move the RX processing for a given interface to a given thread:
3702 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1}
3703 * Example of how to remove the forced thread assignment for a given interface:
3704 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1 del}
3707 VLIB_CLI_COMMAND (vhost_user_thread_command, static) = {
3708 .path = "vhost thread",
3709 .short_help = "vhost thread <iface> <worker-index> [del]",
3710 .function = vhost_thread_command_fn,
3715 * fd.io coding-style-patch-verification: ON
3718 * eval: (c-set-style "gnu")