2 *------------------------------------------------------------------
5 * Copyright (c) 2014 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <fcntl.h> /* for open */
21 #include <sys/ioctl.h>
22 #include <sys/socket.h>
25 #include <sys/types.h>
26 #include <sys/uio.h> /* for iovec */
27 #include <netinet/in.h>
30 #include <linux/if_arp.h>
31 #include <linux/if_tun.h>
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
36 #include <vnet/ip/ip.h>
38 #include <vnet/ethernet/ethernet.h>
39 #include <vnet/devices/devices.h>
40 #include <vnet/feature/feature.h>
42 #include <vnet/devices/virtio/vhost-user.h>
46 * @brief vHost User Device Driver.
48 * This file contains the source code for vHost User interface.
52 #define VHOST_USER_DEBUG_SOCKET 0
53 #define VHOST_DEBUG_VQ 0
55 #if VHOST_USER_DEBUG_SOCKET == 1
56 #define DBG_SOCK(args...) clib_warning(args);
58 #define DBG_SOCK(args...)
61 #if VHOST_DEBUG_VQ == 1
62 #define DBG_VQ(args...) clib_warning(args);
64 #define DBG_VQ(args...)
68 * When an RX queue is down but active, received packets
69 * must be discarded. This value controls up to how many
70 * packets will be discarded during each round.
72 #define VHOST_USER_DOWN_DISCARD_COUNT 256
75 * When the number of available buffers gets under this threshold,
76 * RX node will start discarding packets.
78 #define VHOST_USER_RX_BUFFER_STARVATION 32
81 * On the receive side, the host should free descriptors as soon
82 * as possible in order to avoid TX drop in the VM.
83 * This value controls the number of copy operations that are stacked
84 * before copy is done for all and descriptors are given back to
86 * The value 64 was obtained by testing (48 and 128 were not as good).
88 #define VHOST_USER_RX_COPY_THRESHOLD 64
90 #define UNIX_GET_FD(unixfd_idx) \
91 (unixfd_idx != ~0) ? \
92 pool_elt_at_index (unix_main.file_pool, \
93 unixfd_idx)->file_descriptor : -1;
95 #define foreach_virtio_trace_flags \
96 _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
97 _ (SINGLE_DESC, 1, "Single descriptor packet") \
98 _ (INDIRECT, 2, "Indirect descriptor") \
99 _ (MAP_ERROR, 4, "Memory mapping error")
103 #define _(n,i,s) VIRTIO_TRACE_F_##n,
104 foreach_virtio_trace_flags
106 } virtio_trace_flag_t;
108 vlib_node_registration_t vhost_user_input_node;
110 #define foreach_vhost_user_tx_func_error \
111 _(NONE, "no error") \
112 _(NOT_READY, "vhost vring not ready") \
113 _(DOWN, "vhost interface is down") \
114 _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)") \
115 _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)") \
116 _(MMAP_FAIL, "mmap failure") \
117 _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
121 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
122 foreach_vhost_user_tx_func_error
124 VHOST_USER_TX_FUNC_N_ERROR,
125 } vhost_user_tx_func_error_t;
127 static char *vhost_user_tx_func_error_strings[] = {
129 foreach_vhost_user_tx_func_error
133 #define foreach_vhost_user_input_func_error \
134 _(NO_ERROR, "no error") \
135 _(NO_BUFFER, "no available buffer") \
136 _(MMAP_FAIL, "mmap failure") \
137 _(INDIRECT_OVERFLOW, "indirect descriptor overflows table") \
138 _(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
139 _(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")
143 #define _(f,s) VHOST_USER_INPUT_FUNC_ERROR_##f,
144 foreach_vhost_user_input_func_error
146 VHOST_USER_INPUT_FUNC_N_ERROR,
147 } vhost_user_input_func_error_t;
149 static char *vhost_user_input_func_error_strings[] = {
151 foreach_vhost_user_input_func_error
156 static vhost_user_main_t vhost_user_main = {
160 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
161 .name = "vhost-user",
166 format_vhost_user_interface_name (u8 * s, va_list * args)
168 u32 i = va_arg (*args, u32);
169 u32 show_dev_instance = ~0;
170 vhost_user_main_t *vum = &vhost_user_main;
172 if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
173 show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
175 if (show_dev_instance != ~0)
176 i = show_dev_instance;
178 s = format (s, "VirtualEthernet0/0/%d", i);
183 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
185 // FIXME: check if the new dev instance is already used
186 vhost_user_main_t *vum = &vhost_user_main;
187 vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
188 hi->dev_instance, ~0);
190 vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
193 DBG_SOCK ("renumbered vhost-user interface dev_instance %d to %d",
194 hi->dev_instance, new_dev_instance);
199 static_always_inline void *
200 map_guest_mem (vhost_user_intf_t * vui, uword addr, u32 * hint)
203 if (PREDICT_TRUE ((vui->regions[i].guest_phys_addr <= addr) &&
204 ((vui->regions[i].guest_phys_addr +
205 vui->regions[i].memory_size) > addr)))
207 return (void *) (vui->region_mmap_addr[i] + addr -
208 vui->regions[i].guest_phys_addr);
211 __m128i rl, rh, al, ah, r;
212 al = _mm_set1_epi64x (addr + 1);
213 ah = _mm_set1_epi64x (addr);
215 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[0]);
216 rl = _mm_cmpgt_epi64 (al, rl);
217 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[0]);
218 rh = _mm_cmpgt_epi64 (rh, ah);
219 r = _mm_and_si128 (rl, rh);
221 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[2]);
222 rl = _mm_cmpgt_epi64 (al, rl);
223 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[2]);
224 rh = _mm_cmpgt_epi64 (rh, ah);
225 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x22);
227 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[4]);
228 rl = _mm_cmpgt_epi64 (al, rl);
229 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[4]);
230 rh = _mm_cmpgt_epi64 (rh, ah);
231 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x44);
233 rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[6]);
234 rl = _mm_cmpgt_epi64 (al, rl);
235 rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[6]);
236 rh = _mm_cmpgt_epi64 (rh, ah);
237 r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x88);
239 r = _mm_shuffle_epi8 (r, _mm_set_epi64x (0, 0x0e060c040a020800));
240 i = __builtin_ctzll (_mm_movemask_epi8 (r) |
241 (1 << VHOST_MEMORY_MAX_NREGIONS));
243 if (i < vui->nregions)
246 return (void *) (vui->region_mmap_addr[i] + addr -
247 vui->regions[i].guest_phys_addr);
251 for (i = 0; i < vui->nregions; i++)
253 if ((vui->regions[i].guest_phys_addr <= addr) &&
254 ((vui->regions[i].guest_phys_addr + vui->regions[i].memory_size) >
258 return (void *) (vui->region_mmap_addr[i] + addr -
259 vui->regions[i].guest_phys_addr);
263 DBG_VQ ("failed to map guest mem addr %llx", addr);
269 map_user_mem (vhost_user_intf_t * vui, uword addr)
272 for (i = 0; i < vui->nregions; i++)
274 if ((vui->regions[i].userspace_addr <= addr) &&
275 ((vui->regions[i].userspace_addr + vui->regions[i].memory_size) >
278 return (void *) (vui->region_mmap_addr[i] + addr -
279 vui->regions[i].userspace_addr);
286 get_huge_page_size (int fd)
294 unmap_all_mem_regions (vhost_user_intf_t * vui)
297 for (i = 0; i < vui->nregions; i++)
299 if (vui->region_mmap_addr[i] != (void *) -1)
302 long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
304 ssize_t map_sz = (vui->regions[i].memory_size +
305 vui->regions[i].mmap_offset +
306 page_sz) & ~(page_sz - 1);
309 munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
313 ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
314 vui->region_mmap_addr[i], map_sz, page_sz);
316 vui->region_mmap_addr[i] = (void *) -1;
320 clib_warning ("failed to unmap memory region (errno %d)",
323 close (vui->region_mmap_fd[i]);
330 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
332 //Let's try to assign one queue to each thread
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];
409 iaq.vhost_iface_index = vui - vum->vhost_user_interfaces;
410 vec_add1 (vhc->rx_queues, iaq);
415 vec_foreach (vhc, vum->cpus)
417 vhost_iface_and_queue_t *vhiq;
418 u8 mode = VHOST_USER_INTERRUPT_MODE;
420 vec_foreach (vhiq, vhc->rx_queues)
422 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
423 if (vui->operation_mode == VHOST_USER_POLLING_MODE)
425 /* At least one interface is polling, cpu is set to polling */
426 mode = VHOST_USER_POLLING_MODE;
430 vhc->operation_mode = mode;
433 for (thread_index = vum->input_cpu_first_index;
434 thread_index < vum->input_cpu_first_index + vum->input_cpu_count;
437 vlib_node_state_t state = VLIB_NODE_STATE_POLLING;
439 vhc = &vum->cpus[thread_index];
440 vm = vlib_mains ? vlib_mains[thread_index] : &vlib_global_main;
441 switch (vhc->operation_mode)
443 case VHOST_USER_INTERRUPT_MODE:
444 state = VLIB_NODE_STATE_INTERRUPT;
446 case VHOST_USER_POLLING_MODE:
447 state = VLIB_NODE_STATE_POLLING;
450 clib_warning ("BUG: bad operation mode %d", vhc->operation_mode);
453 vlib_node_set_state (vm, vhost_user_input_node.index, state);
460 vhost_user_thread_placement (u32 sw_if_index, u32 worker_thread_index, u8 del)
462 vhost_user_main_t *vum = &vhost_user_main;
463 vhost_user_intf_t *vui;
464 vnet_hw_interface_t *hw;
466 if (worker_thread_index < vum->input_cpu_first_index ||
467 worker_thread_index >=
468 vum->input_cpu_first_index + vum->input_cpu_count)
471 if (!(hw = vnet_get_sup_hw_interface (vnet_get_main (), sw_if_index)))
474 vui = pool_elt_at_index (vum->vhost_user_interfaces, hw->dev_instance);
476 vec_foreach (w, vui->workers)
478 if (*w == worker_thread_index)
480 found = w - vui->workers;
489 vec_del1 (vui->workers, found);
491 else if (found == ~0)
493 vec_add1 (vui->workers, worker_thread_index);
496 vhost_user_rx_thread_placement ();
500 /** @brief Returns whether at least one TX and one RX vring are enabled */
502 vhost_user_intf_ready (vhost_user_intf_t * vui)
504 int i, found[2] = { }; //RX + TX
506 for (i = 0; i < VHOST_VRING_MAX_N; i++)
507 if (vui->vrings[i].started && vui->vrings[i].enabled)
510 return found[0] && found[1];
514 vhost_user_update_iface_state (vhost_user_intf_t * vui)
516 /* if we have pointers to descriptor table, go up */
517 int is_up = vhost_user_intf_ready (vui);
518 if (is_up != vui->is_up)
520 DBG_SOCK ("interface %d %s", vui->sw_if_index,
521 is_up ? "ready" : "down");
522 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
523 is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
527 vhost_user_rx_thread_placement ();
528 vhost_user_tx_thread_placement (vui);
532 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
534 vhost_user_main_t *vum = &vhost_user_main;
537 vhost_iface_and_queue_t *vhiq;
542 if (vhost_user_intf_ready (vui))
544 vec_foreach (vhc, vum->cpus)
546 if (vhc->operation_mode == VHOST_USER_POLLING_MODE)
549 vec_foreach (vhiq, vhc->rx_queues)
552 * Match the interface and the virtqueue number
554 if ((vhiq->vhost_iface_index == (ifq >> 8)) &&
555 (VHOST_VRING_IDX_TX (vhiq->qid) == (ifq & 0xff)))
557 thread_index = vhc - vum->cpus;
558 vm = vlib_mains ? vlib_mains[thread_index] : &vlib_global_main;
560 * Convert RX virtqueue number in the lower byte to vring
561 * queue index for the input node process. Top bytes contain
562 * the interface, lower byte contains the queue index.
564 ifq2 = ((ifq >> 8) << 8) | vhiq->qid;
565 vhc->pending_input_bitmap =
566 clib_bitmap_set (vhc->pending_input_bitmap, ifq2, 1);
567 vlib_node_set_interrupt_pending (vm,
568 vhost_user_input_node.index);
579 static clib_error_t *
580 vhost_user_callfd_read_ready (unix_file_t * uf)
582 __attribute__ ((unused)) int n;
584 vhost_user_intf_t *vui =
585 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
586 uf->private_data >> 8);
588 n = read (uf->file_descriptor, ((char *) &buff), 8);
589 DBG_SOCK ("if %d CALL queue %d", uf->private_data >> 8,
590 uf->private_data & 0xff);
591 vhost_user_set_interrupt_pending (vui, uf->private_data);
596 static clib_error_t *
597 vhost_user_kickfd_read_ready (unix_file_t * uf)
599 __attribute__ ((unused)) int n;
601 vhost_user_intf_t *vui =
602 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
603 uf->private_data >> 8);
604 u32 qid = uf->private_data & 0xff;
606 n = read (uf->file_descriptor, ((char *) &buff), 8);
607 DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
609 vlib_worker_thread_barrier_sync (vlib_get_main ());
610 if (!vui->vrings[qid].started ||
611 (vhost_user_intf_ready (vui) != vui->is_up))
613 vui->vrings[qid].started = 1;
614 vhost_user_update_iface_state (vui);
616 vlib_worker_thread_barrier_release (vlib_get_main ());
618 vhost_user_set_interrupt_pending (vui, uf->private_data);
623 * @brief Try once to lock the vring
624 * @return 0 on success, non-zero on failure.
627 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
629 return __sync_lock_test_and_set (vui->vring_locks[qid], 1);
633 * @brief Spin until the vring is successfully locked
636 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
638 while (vhost_user_vring_try_lock (vui, qid))
643 * @brief Unlock the vring lock
646 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
648 *vui->vring_locks[qid] = 0;
652 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
654 vhost_user_vring_t *vring = &vui->vrings[qid];
655 memset (vring, 0, sizeof (*vring));
656 vring->kickfd_idx = ~0;
657 vring->callfd_idx = ~0;
661 * We have a bug with some qemu 2.5, and this may be a fix.
662 * Feel like interpretation holy text, but this is from vhost-user.txt.
664 * One queue pair is enabled initially. More queues are enabled
665 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
667 * Don't know who's right, but this is what DPDK does.
669 if (qid == 0 || qid == 1)
674 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
676 vhost_user_vring_t *vring = &vui->vrings[qid];
677 if (vring->kickfd_idx != ~0)
679 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
681 unix_file_del (&unix_main, uf);
682 vring->kickfd_idx = ~0;
684 if (vring->callfd_idx != ~0)
686 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
688 unix_file_del (&unix_main, uf);
689 vring->callfd_idx = ~0;
691 if (vring->errfd != -1)
693 close (vring->errfd);
696 vhost_user_vring_init (vui, qid);
700 vhost_user_if_disconnect (vhost_user_intf_t * vui)
702 vnet_main_t *vnm = vnet_get_main ();
705 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
707 if (vui->unix_file_index != ~0)
709 unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
710 vui->unix_file_index = ~0;
715 for (q = 0; q < VHOST_VRING_MAX_N; q++)
716 vhost_user_vring_close (vui, q);
718 unmap_all_mem_regions (vui);
719 DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
722 #define VHOST_LOG_PAGE 0x1000
723 static_always_inline void
724 vhost_user_log_dirty_pages_2 (vhost_user_intf_t * vui,
725 u64 addr, u64 len, u8 is_host_address)
727 if (PREDICT_TRUE (vui->log_base_addr == 0
728 || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
734 addr = (u64) map_user_mem (vui, (uword) addr);
736 if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
738 DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
742 CLIB_MEMORY_BARRIER ();
743 u64 page = addr / VHOST_LOG_PAGE;
744 while (page * VHOST_LOG_PAGE < addr + len)
746 ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
751 static_always_inline void
752 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
754 vhost_user_log_dirty_pages_2 (vui, addr, len, 0);
757 #define vhost_user_log_dirty_ring(vui, vq, member) \
758 if (PREDICT_FALSE(vq->log_used)) { \
759 vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
760 sizeof(vq->used->member)); \
763 static clib_error_t *
764 vhost_user_socket_read (unix_file_t * uf)
767 int fd, number_of_fds = 0;
768 int fds[VHOST_MEMORY_MAX_NREGIONS];
769 vhost_user_msg_t msg;
772 vhost_user_main_t *vum = &vhost_user_main;
773 vhost_user_intf_t *vui;
774 struct cmsghdr *cmsg;
776 unix_file_t template = { 0 };
777 vnet_main_t *vnm = vnet_get_main ();
779 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
781 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
783 memset (&mh, 0, sizeof (mh));
784 memset (control, 0, sizeof (control));
786 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
789 /* set the payload */
790 iov[0].iov_base = (void *) &msg;
791 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
795 mh.msg_control = control;
796 mh.msg_controllen = sizeof (control);
798 n = recvmsg (uf->file_descriptor, &mh, 0);
800 /* Stop workers to avoid end of the world */
801 vlib_worker_thread_barrier_sync (vlib_get_main ());
803 if (n != VHOST_USER_MSG_HDR_SZ)
807 DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
811 DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
812 n, VHOST_USER_MSG_HDR_SZ);
817 if (mh.msg_flags & MSG_CTRUNC)
819 DBG_SOCK ("MSG_CTRUNC is set");
823 cmsg = CMSG_FIRSTHDR (&mh);
825 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
826 (cmsg->cmsg_type == SCM_RIGHTS) &&
827 (cmsg->cmsg_len - CMSG_LEN (0) <=
828 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
830 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
831 clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
834 /* version 1, no reply bit set */
835 if ((msg.flags & 7) != 1)
837 DBG_SOCK ("malformed message received. closing socket");
844 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
848 DBG_SOCK ("read failed %s", strerror (errno));
851 else if (rv != msg.size)
853 DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
860 case VHOST_USER_GET_FEATURES:
862 msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
863 (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
864 (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
865 (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
866 (1ULL << FEAT_VHOST_F_LOG_ALL) |
867 (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
868 (1ULL << FEAT_VIRTIO_NET_F_MQ) |
869 (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
870 (1ULL << FEAT_VIRTIO_F_VERSION_1);
871 msg.u64 &= vui->feature_mask;
872 msg.size = sizeof (msg.u64);
873 DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
874 vui->hw_if_index, msg.u64);
877 case VHOST_USER_SET_FEATURES:
878 DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
879 vui->hw_if_index, msg.u64);
881 vui->features = msg.u64;
884 ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
885 (1ULL << FEAT_VIRTIO_F_VERSION_1)))
886 vui->virtio_net_hdr_sz = 12;
888 vui->virtio_net_hdr_sz = 10;
891 (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
893 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
894 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
897 /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
898 vhost_user_vring_close(&vui->vrings[q]); */
902 case VHOST_USER_SET_MEM_TABLE:
903 DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
904 vui->hw_if_index, msg.memory.nregions);
906 if ((msg.memory.nregions < 1) ||
907 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
910 DBG_SOCK ("number of mem regions must be between 1 and %i",
911 VHOST_MEMORY_MAX_NREGIONS);
916 if (msg.memory.nregions != number_of_fds)
918 DBG_SOCK ("each memory region must have FD");
921 unmap_all_mem_regions (vui);
922 for (i = 0; i < msg.memory.nregions; i++)
924 clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
925 sizeof (vhost_user_memory_region_t));
927 long page_sz = get_huge_page_size (fds[i]);
929 /* align size to 2M page */
930 ssize_t map_sz = (vui->regions[i].memory_size +
931 vui->regions[i].mmap_offset +
932 page_sz) & ~(page_sz - 1);
934 vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
935 MAP_SHARED, fds[i], 0);
936 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
937 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
938 vui->regions[i].memory_size;
941 ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
942 "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
945 if (vui->region_mmap_addr[i] == MAP_FAILED)
947 clib_warning ("failed to map memory. errno is %d", errno);
950 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
951 vui->region_mmap_fd[i] = fds[i];
953 vui->nregions = msg.memory.nregions;
956 case VHOST_USER_SET_VRING_NUM:
957 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
958 vui->hw_if_index, msg.state.index, msg.state.num);
960 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
961 (msg.state.num == 0) || /* it cannot be zero */
962 ((msg.state.num - 1) & msg.state.num)) /* must be power of 2 */
964 vui->vrings[msg.state.index].qsz = msg.state.num;
967 case VHOST_USER_SET_VRING_ADDR:
968 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
969 vui->hw_if_index, msg.state.index);
971 if (msg.state.index >= VHOST_VRING_MAX_N)
973 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
974 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
978 if (msg.size < sizeof (msg.addr))
980 DBG_SOCK ("vhost message is too short (%d < %d)",
981 msg.size, sizeof (msg.addr));
985 vui->vrings[msg.state.index].desc = (vring_desc_t *)
986 map_user_mem (vui, msg.addr.desc_user_addr);
987 vui->vrings[msg.state.index].used = (vring_used_t *)
988 map_user_mem (vui, msg.addr.used_user_addr);
989 vui->vrings[msg.state.index].avail = (vring_avail_t *)
990 map_user_mem (vui, msg.addr.avail_user_addr);
992 if ((vui->vrings[msg.state.index].desc == NULL) ||
993 (vui->vrings[msg.state.index].used == NULL) ||
994 (vui->vrings[msg.state.index].avail == NULL))
996 DBG_SOCK ("failed to map user memory for hw_if_index %d",
1001 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
1002 vui->vrings[msg.state.index].log_used =
1003 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
1005 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
1006 the ring is initialized in an enabled state. */
1007 if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
1009 vui->vrings[msg.state.index].enabled = 1;
1012 vui->vrings[msg.state.index].last_used_idx =
1013 vui->vrings[msg.state.index].last_avail_idx =
1014 vui->vrings[msg.state.index].used->idx;
1016 if (vui->operation_mode == VHOST_USER_POLLING_MODE)
1017 /* tell driver that we don't want interrupts */
1018 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
1020 /* tell driver that we want interrupts */
1021 vui->vrings[msg.state.index].used->flags = 0;
1024 case VHOST_USER_SET_OWNER:
1025 DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
1028 case VHOST_USER_RESET_OWNER:
1029 DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
1032 case VHOST_USER_SET_VRING_CALL:
1033 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL u64 %d",
1034 vui->hw_if_index, msg.u64);
1036 q = (u8) (msg.u64 & 0xFF);
1038 /* if there is old fd, delete and close it */
1039 if (vui->vrings[q].callfd_idx != ~0)
1041 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
1042 vui->vrings[q].callfd_idx);
1043 unix_file_del (&unix_main, uf);
1044 vui->vrings[q].callfd_idx = ~0;
1047 if (!(msg.u64 & 0x100))
1049 if (number_of_fds != 1)
1051 DBG_SOCK ("More than one fd received !");
1055 template.read_function = vhost_user_callfd_read_ready;
1056 template.file_descriptor = fds[0];
1057 template.private_data =
1058 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
1059 vui->vrings[q].callfd_idx = unix_file_add (&unix_main, &template);
1062 vui->vrings[q].callfd_idx = ~0;
1065 case VHOST_USER_SET_VRING_KICK:
1066 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK u64 %d",
1067 vui->hw_if_index, msg.u64);
1069 q = (u8) (msg.u64 & 0xFF);
1071 if (vui->vrings[q].kickfd_idx != ~0)
1073 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
1074 vui->vrings[q].kickfd_idx);
1075 unix_file_del (&unix_main, uf);
1076 vui->vrings[q].kickfd_idx = ~0;
1079 if (!(msg.u64 & 0x100))
1081 if (number_of_fds != 1)
1083 DBG_SOCK ("More than one fd received !");
1087 template.read_function = vhost_user_kickfd_read_ready;
1088 template.file_descriptor = fds[0];
1089 template.private_data =
1090 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
1092 vui->vrings[q].kickfd_idx = unix_file_add (&unix_main, &template);
1096 //When no kickfd is set, the queue is initialized as started
1097 vui->vrings[q].kickfd_idx = ~0;
1098 vui->vrings[q].started = 1;
1103 case VHOST_USER_SET_VRING_ERR:
1104 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR u64 %d",
1105 vui->hw_if_index, msg.u64);
1107 q = (u8) (msg.u64 & 0xFF);
1109 if (vui->vrings[q].errfd != -1)
1110 close (vui->vrings[q].errfd);
1112 if (!(msg.u64 & 0x100))
1114 if (number_of_fds != 1)
1117 vui->vrings[q].errfd = fds[0];
1120 vui->vrings[q].errfd = -1;
1124 case VHOST_USER_SET_VRING_BASE:
1125 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1126 vui->hw_if_index, msg.state.index, msg.state.num);
1128 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
1131 case VHOST_USER_GET_VRING_BASE:
1132 DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1133 vui->hw_if_index, msg.state.index, msg.state.num);
1135 if (msg.state.index >= VHOST_VRING_MAX_N)
1137 DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
1138 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1143 * Copy last_avail_idx from the vring before closing it because
1144 * closing the vring also initializes the vring last_avail_idx
1146 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
1148 msg.size = sizeof (msg.state);
1150 /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
1151 vhost_user_vring_close (vui, msg.state.index);
1154 case VHOST_USER_NONE:
1155 DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
1159 case VHOST_USER_SET_LOG_BASE:
1161 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
1163 if (msg.size != sizeof (msg.log))
1166 ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
1167 msg.size, sizeof (msg.log));
1172 (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
1175 ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
1180 /* align size to 2M page */
1181 long page_sz = get_huge_page_size (fd);
1183 (msg.log.size + msg.log.offset + page_sz) & ~(page_sz - 1);
1185 vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
1189 ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
1190 map_sz, msg.log.offset, fd, vui->log_base_addr);
1192 if (vui->log_base_addr == MAP_FAILED)
1194 clib_warning ("failed to map memory. errno is %d", errno);
1198 vui->log_base_addr += msg.log.offset;
1199 vui->log_size = msg.log.size;
1202 msg.size = sizeof (msg.u64);
1207 case VHOST_USER_SET_LOG_FD:
1208 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
1212 case VHOST_USER_GET_PROTOCOL_FEATURES:
1213 DBG_SOCK ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
1217 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
1218 (1 << VHOST_USER_PROTOCOL_F_MQ);
1219 msg.size = sizeof (msg.u64);
1222 case VHOST_USER_SET_PROTOCOL_FEATURES:
1223 DBG_SOCK ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%lx",
1224 vui->hw_if_index, msg.u64);
1226 vui->protocol_features = msg.u64;
1230 case VHOST_USER_GET_QUEUE_NUM:
1231 DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM", vui->hw_if_index);
1233 msg.u64 = VHOST_VRING_MAX_N;
1234 msg.size = sizeof (msg.u64);
1237 case VHOST_USER_SET_VRING_ENABLE:
1238 DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
1239 vui->hw_if_index, msg.state.num ? "enable" : "disable",
1241 if (msg.state.index >= VHOST_VRING_MAX_N)
1243 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
1244 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1248 vui->vrings[msg.state.index].enabled = msg.state.num;
1252 DBG_SOCK ("unknown vhost-user message %d received. closing socket",
1257 /* if we need to reply */
1261 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1262 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1264 DBG_SOCK ("could not send message response");
1269 vhost_user_update_iface_state (vui);
1270 vlib_worker_thread_barrier_release (vlib_get_main ());
1274 vhost_user_if_disconnect (vui);
1275 vhost_user_update_iface_state (vui);
1276 vlib_worker_thread_barrier_release (vlib_get_main ());
1280 static clib_error_t *
1281 vhost_user_socket_error (unix_file_t * uf)
1283 vlib_main_t *vm = vlib_get_main ();
1284 vhost_user_main_t *vum = &vhost_user_main;
1285 vhost_user_intf_t *vui =
1286 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1288 DBG_SOCK ("socket error on if %d", vui->sw_if_index);
1289 vlib_worker_thread_barrier_sync (vm);
1290 vhost_user_if_disconnect (vui);
1291 vhost_user_rx_thread_placement ();
1292 vlib_worker_thread_barrier_release (vm);
1296 static clib_error_t *
1297 vhost_user_socksvr_accept_ready (unix_file_t * uf)
1299 int client_fd, client_len;
1300 struct sockaddr_un client;
1301 unix_file_t template = { 0 };
1302 vhost_user_main_t *vum = &vhost_user_main;
1303 vhost_user_intf_t *vui;
1305 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1307 client_len = sizeof (client);
1308 client_fd = accept (uf->file_descriptor,
1309 (struct sockaddr *) &client,
1310 (socklen_t *) & client_len);
1313 return clib_error_return_unix (0, "accept");
1315 DBG_SOCK ("New client socket for vhost interface %d", vui->sw_if_index);
1316 template.read_function = vhost_user_socket_read;
1317 template.error_function = vhost_user_socket_error;
1318 template.file_descriptor = client_fd;
1319 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1320 vui->unix_file_index = unix_file_add (&unix_main, &template);
1324 static clib_error_t *
1325 vhost_user_init (vlib_main_t * vm)
1327 clib_error_t *error;
1328 vhost_user_main_t *vum = &vhost_user_main;
1329 vlib_thread_main_t *tm = vlib_get_thread_main ();
1330 vlib_thread_registration_t *tr;
1333 error = vlib_call_init_function (vm, ip4_init);
1337 vum->coalesce_frames = 32;
1338 vum->coalesce_time = 1e-3;
1340 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1343 vec_foreach (cpu, vum->cpus)
1345 /* This is actually not necessary as validate already zeroes it
1346 * Just keeping the loop here for later because I am lazy. */
1347 cpu->rx_buffers_len = 0;
1350 /* find out which cpus will be used for input */
1351 vum->input_cpu_first_index = 0;
1352 vum->input_cpu_count = 1;
1353 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1354 tr = p ? (vlib_thread_registration_t *) p[0] : 0;
1356 if (tr && tr->count > 0)
1358 vum->input_cpu_first_index = tr->first_index;
1359 vum->input_cpu_count = tr->count;
1362 vum->random = random_default_seed ();
1367 VLIB_INIT_FUNCTION (vhost_user_init);
1369 static clib_error_t *
1370 vhost_user_exit (vlib_main_t * vm)
1376 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
1379 format_vhost_trace (u8 * s, va_list * va)
1381 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
1382 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
1383 CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
1384 vhost_user_main_t *vum = &vhost_user_main;
1385 vhost_trace_t *t = va_arg (*va, vhost_trace_t *);
1386 vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
1389 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
1391 uword indent = format_get_indent (s);
1393 s = format (s, "%U %U queue %d\n", format_white_space, indent,
1394 format_vnet_sw_interface_name, vnm, sw, t->qid);
1396 s = format (s, "%U virtio flags:\n", format_white_space, indent);
1398 if (t->virtio_ring_flags & (1 << VIRTIO_TRACE_F_##n)) \
1399 s = format (s, "%U %s %s\n", format_white_space, indent, #n, st);
1400 foreach_virtio_trace_flags
1402 s = format (s, "%U virtio_net_hdr first_desc_len %u\n",
1403 format_white_space, indent, t->first_desc_len);
1405 s = format (s, "%U flags 0x%02x gso_type %u\n",
1406 format_white_space, indent,
1407 t->hdr.hdr.flags, t->hdr.hdr.gso_type);
1409 if (vui->virtio_net_hdr_sz == 12)
1410 s = format (s, "%U num_buff %u",
1411 format_white_space, indent, t->hdr.num_buffers);
1417 vhost_user_rx_trace (vhost_trace_t * t,
1418 vhost_user_intf_t * vui, u16 qid,
1419 vlib_buffer_t * b, vhost_user_vring_t * txvq)
1421 vhost_user_main_t *vum = &vhost_user_main;
1422 u32 qsz_mask = txvq->qsz - 1;
1423 u32 last_avail_idx = txvq->last_avail_idx;
1424 u32 desc_current = txvq->avail->ring[last_avail_idx & qsz_mask];
1425 vring_desc_t *hdr_desc = 0;
1426 virtio_net_hdr_mrg_rxbuf_t *hdr;
1429 memset (t, 0, sizeof (*t));
1430 t->device_index = vui - vum->vhost_user_interfaces;
1433 hdr_desc = &txvq->desc[desc_current];
1434 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1436 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1437 /* Header is the first here */
1438 hdr_desc = map_guest_mem (vui, txvq->desc[desc_current].addr, &hint);
1440 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1442 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1444 if (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1445 !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1447 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1450 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1452 if (!hdr_desc || !(hdr = map_guest_mem (vui, hdr_desc->addr, &hint)))
1454 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_MAP_ERROR;
1458 u32 len = vui->virtio_net_hdr_sz;
1459 memcpy (&t->hdr, hdr, len > hdr_desc->len ? hdr_desc->len : len);
1464 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1466 vhost_user_main_t *vum = &vhost_user_main;
1468 int fd = UNIX_GET_FD (vq->callfd_idx);
1469 int rv __attribute__ ((unused));
1470 /* TODO: pay attention to rv */
1471 rv = write (fd, &x, sizeof (x));
1472 vq->n_since_last_int = 0;
1473 vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1476 static_always_inline u32
1477 vhost_user_input_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1478 u16 copy_len, u32 * map_hint)
1480 void *src0, *src1, *src2, *src3;
1481 if (PREDICT_TRUE (copy_len >= 4))
1483 if (PREDICT_FALSE (!(src2 = map_guest_mem (vui, cpy[0].src, map_hint))))
1485 if (PREDICT_FALSE (!(src3 = map_guest_mem (vui, cpy[1].src, map_hint))))
1488 while (PREDICT_TRUE (copy_len >= 4))
1494 (!(src2 = map_guest_mem (vui, cpy[2].src, map_hint))))
1497 (!(src3 = map_guest_mem (vui, cpy[3].src, map_hint))))
1500 CLIB_PREFETCH (src2, 64, LOAD);
1501 CLIB_PREFETCH (src3, 64, LOAD);
1503 clib_memcpy ((void *) cpy[0].dst, src0, cpy[0].len);
1504 clib_memcpy ((void *) cpy[1].dst, src1, cpy[1].len);
1511 if (PREDICT_FALSE (!(src0 = map_guest_mem (vui, cpy->src, map_hint))))
1513 clib_memcpy ((void *) cpy->dst, src0, cpy->len);
1521 * Try to discard packets from the tx ring (VPP RX path).
1522 * Returns the number of discarded packets.
1525 vhost_user_rx_discard_packet (vlib_main_t * vm,
1526 vhost_user_intf_t * vui,
1527 vhost_user_vring_t * txvq, u32 discard_max)
1530 * On the RX side, each packet corresponds to one descriptor
1531 * (it is the same whether it is a shallow descriptor, chained, or indirect).
1532 * Therefore, discarding a packet is like discarding a descriptor.
1534 u32 discarded_packets = 0;
1535 u32 avail_idx = txvq->avail->idx;
1536 u16 qsz_mask = txvq->qsz - 1;
1537 while (discarded_packets != discard_max)
1539 if (avail_idx == txvq->last_avail_idx)
1542 u16 desc_chain_head =
1543 txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1544 txvq->last_avail_idx++;
1545 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_chain_head;
1546 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1547 vhost_user_log_dirty_ring (vui, txvq,
1548 ring[txvq->last_used_idx & qsz_mask]);
1549 txvq->last_used_idx++;
1550 discarded_packets++;
1554 CLIB_MEMORY_BARRIER ();
1555 txvq->used->idx = txvq->last_used_idx;
1556 vhost_user_log_dirty_ring (vui, txvq, idx);
1557 return discarded_packets;
1561 * In case of overflow, we need to rewind the array of allocated buffers.
1564 vhost_user_input_rewind_buffers (vlib_main_t * vm,
1565 vhost_cpu_t * cpu, vlib_buffer_t * b_head)
1567 u32 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1568 vlib_buffer_t *b_current = vlib_get_buffer (vm, bi_current);
1569 b_current->current_length = 0;
1570 b_current->flags = 0;
1571 while (b_current != b_head)
1573 cpu->rx_buffers_len++;
1574 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1575 b_current = vlib_get_buffer (vm, bi_current);
1576 b_current->current_length = 0;
1577 b_current->flags = 0;
1582 vhost_user_if_input (vlib_main_t * vm,
1583 vhost_user_main_t * vum,
1584 vhost_user_intf_t * vui,
1585 u16 qid, vlib_node_runtime_t * node)
1587 vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
1588 u16 n_rx_packets = 0;
1591 u32 n_left_to_next, *to_next;
1592 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1593 u32 n_trace = vlib_get_trace_count (vm, node);
1596 u16 thread_index = vlib_get_thread_index ();
1600 /* do we have pending interrupts ? */
1601 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
1602 f64 now = vlib_time_now (vm);
1604 if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1605 vhost_user_send_call (vm, txvq);
1607 if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1608 vhost_user_send_call (vm, rxvq);
1611 if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1614 n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1617 if (PREDICT_FALSE (n_left == 0))
1620 if (PREDICT_FALSE (!vui->admin_up || !(txvq->enabled)))
1623 * Discard input packet if interface is admin down or vring is not
1625 * "For example, for a networking device, in the disabled state
1626 * client must not supply any new RX packets, but must process
1627 * and discard any TX packets."
1629 vhost_user_rx_discard_packet (vm, vui, txvq,
1630 VHOST_USER_DOWN_DISCARD_COUNT);
1634 if (PREDICT_FALSE (n_left == txvq->qsz))
1637 * Informational error logging when VPP is not
1638 * receiving packets fast enough.
1640 vlib_error_count (vm, node->node_index,
1641 VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1644 qsz_mask = txvq->qsz - 1;
1646 if (n_left > VLIB_FRAME_SIZE)
1647 n_left = VLIB_FRAME_SIZE;
1650 * For small packets (<2kB), we will not need more than one vlib buffer
1651 * per packet. In case packets are bigger, we will just yeld at some point
1652 * in the loop and come back later. This is not an issue as for big packet,
1653 * processing cost really comes from the memory copy.
1655 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len < n_left + 1))
1657 u32 curr_len = vum->cpus[thread_index].rx_buffers_len;
1658 vum->cpus[thread_index].rx_buffers_len +=
1659 vlib_buffer_alloc_from_free_list (vm,
1660 vum->cpus[thread_index].rx_buffers +
1662 VHOST_USER_RX_BUFFERS_N - curr_len,
1663 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1666 (vum->cpus[thread_index].rx_buffers_len <
1667 VHOST_USER_RX_BUFFER_STARVATION))
1669 /* In case of buffer starvation, discard some packets from the queue
1670 * and log the event.
1671 * We keep doing best effort for the remaining packets. */
1672 u32 flush = (n_left + 1 > vum->cpus[thread_index].rx_buffers_len) ?
1673 n_left + 1 - vum->cpus[thread_index].rx_buffers_len : 1;
1674 flush = vhost_user_rx_discard_packet (vm, vui, txvq, flush);
1677 vlib_increment_simple_counter (vnet_main.
1678 interface_main.sw_if_counters +
1679 VNET_INTERFACE_COUNTER_DROP,
1680 vlib_get_thread_index (),
1681 vui->sw_if_index, flush);
1683 vlib_error_count (vm, vhost_user_input_node.index,
1684 VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1690 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1692 while (n_left > 0 && n_left_to_next > 0)
1694 vlib_buffer_t *b_head, *b_current;
1697 u32 desc_data_offset;
1698 vring_desc_t *desc_table = txvq->desc;
1700 if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len <= 1))
1702 /* Not enough rx_buffers
1703 * Note: We yeld on 1 so we don't need to do an additional
1704 * check for the next buffer prefetch.
1710 desc_current = txvq->avail->ring[txvq->last_avail_idx & qsz_mask];
1711 vum->cpus[thread_index].rx_buffers_len--;
1712 bi_current = (vum->cpus[thread_index].rx_buffers)
1713 [vum->cpus[thread_index].rx_buffers_len];
1714 b_head = b_current = vlib_get_buffer (vm, bi_current);
1715 to_next[0] = bi_current; //We do that now so we can forget about bi_current
1719 vlib_prefetch_buffer_with_index (vm,
1721 cpus[thread_index].rx_buffers)
1722 [vum->cpus[thread_index].
1723 rx_buffers_len - 1], LOAD);
1725 /* Just preset the used descriptor id and length for later */
1726 txvq->used->ring[txvq->last_used_idx & qsz_mask].id = desc_current;
1727 txvq->used->ring[txvq->last_used_idx & qsz_mask].len = 0;
1728 vhost_user_log_dirty_ring (vui, txvq,
1729 ring[txvq->last_used_idx & qsz_mask]);
1731 /* The buffer should already be initialized */
1732 b_head->total_length_not_including_first_buffer = 0;
1733 b_head->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1735 if (PREDICT_FALSE (n_trace))
1737 //TODO: next_index is not exactly known at that point
1738 vlib_trace_buffer (vm, node, next_index, b_head,
1739 /* follow_chain */ 0);
1741 vlib_add_trace (vm, node, b_head, sizeof (t0[0]));
1742 vhost_user_rx_trace (t0, vui, qid, b_head, txvq);
1744 vlib_set_trace_count (vm, node, n_trace);
1747 /* This depends on the setup but is very consistent
1748 * So I think the CPU branch predictor will make a pretty good job
1749 * at optimizing the decision. */
1750 if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1752 desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1755 if (PREDICT_FALSE (desc_table == 0))
1757 //FIXME: Handle error by shutdown the queue
1762 if (PREDICT_TRUE (vui->is_any_layout) ||
1763 (!(desc_table[desc_current].flags & VIRTQ_DESC_F_NEXT)))
1765 /* ANYLAYOUT or single buffer */
1766 desc_data_offset = vui->virtio_net_hdr_sz;
1770 /* CSR case without ANYLAYOUT, skip 1st buffer */
1771 desc_data_offset = desc_table[desc_current].len;
1776 /* Get more input if necessary. Or end of packet. */
1777 if (desc_data_offset == desc_table[desc_current].len)
1779 if (PREDICT_FALSE (desc_table[desc_current].flags &
1782 desc_current = desc_table[desc_current].next;
1783 desc_data_offset = 0;
1791 /* Get more output if necessary. Or end of packet. */
1793 (b_current->current_length == VLIB_BUFFER_DATA_SIZE))
1796 (vum->cpus[thread_index].rx_buffers_len == 0))
1798 /* Cancel speculation */
1803 * Checking if there are some left buffers.
1804 * If not, just rewind the used buffers and stop.
1805 * Note: Scheduled copies are not cancelled. This is
1806 * not an issue as they would still be valid. Useless,
1809 vhost_user_input_rewind_buffers (vm,
1817 /* Get next output */
1818 vum->cpus[thread_index].rx_buffers_len--;
1820 (vum->cpus[thread_index].rx_buffers)[vum->cpus
1821 [thread_index].rx_buffers_len];
1822 b_current->next_buffer = bi_next;
1823 b_current->flags |= VLIB_BUFFER_NEXT_PRESENT;
1824 bi_current = bi_next;
1825 b_current = vlib_get_buffer (vm, bi_current);
1828 /* Prepare a copy order executed later for the data */
1829 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
1832 desc_table[desc_current].len - desc_data_offset;
1833 cpy->len = VLIB_BUFFER_DATA_SIZE - b_current->current_length;
1834 cpy->len = (cpy->len > desc_data_l) ? desc_data_l : cpy->len;
1835 cpy->dst = (uword) vlib_buffer_get_current (b_current);
1836 cpy->src = desc_table[desc_current].addr + desc_data_offset;
1838 desc_data_offset += cpy->len;
1840 b_current->current_length += cpy->len;
1841 b_head->total_length_not_including_first_buffer += cpy->len;
1845 CLIB_PREFETCH (&n_left, sizeof (n_left), LOAD);
1847 n_rx_bytes += b_head->total_length_not_including_first_buffer;
1850 b_head->total_length_not_including_first_buffer -=
1851 b_head->current_length;
1853 /* consume the descriptor and return it as used */
1854 txvq->last_avail_idx++;
1855 txvq->last_used_idx++;
1857 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1859 vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1860 vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1864 u32 next0 = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1866 /* redirect if feature path enabled */
1867 vnet_feature_start_device_input_x1 (vui->sw_if_index, &next0,
1870 u32 bi = to_next[-1]; //Cannot use to_next[-1] in the macro
1871 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1872 to_next, n_left_to_next,
1879 * Although separating memory copies from virtio ring parsing
1880 * is beneficial, we can offer to perform the copies from time
1881 * to time in order to free some space in the ring.
1883 if (PREDICT_FALSE (copy_len >= VHOST_USER_RX_COPY_THRESHOLD))
1886 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1887 copy_len, &map_hint)))
1890 ("Memory mapping error on interface hw_if_index=%d "
1891 "(Shutting down - Switch interface down and up to restart)",
1899 /* give buffers back to driver */
1900 CLIB_MEMORY_BARRIER ();
1901 txvq->used->idx = txvq->last_used_idx;
1902 vhost_user_log_dirty_ring (vui, txvq, idx);
1906 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1909 /* Do the memory copies */
1911 (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1912 copy_len, &map_hint)))
1914 clib_warning ("Memory mapping error on interface hw_if_index=%d "
1915 "(Shutting down - Switch interface down and up to restart)",
1920 /* give buffers back to driver */
1921 CLIB_MEMORY_BARRIER ();
1922 txvq->used->idx = txvq->last_used_idx;
1923 vhost_user_log_dirty_ring (vui, txvq, idx);
1925 /* interrupt (call) handling */
1926 if ((txvq->callfd_idx != ~0) &&
1927 !(txvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
1929 txvq->n_since_last_int += n_rx_packets;
1931 if (txvq->n_since_last_int > vum->coalesce_frames)
1932 vhost_user_send_call (vm, txvq);
1935 /* increase rx counters */
1936 vlib_increment_combined_counter
1937 (vnet_main.interface_main.combined_sw_if_counters
1938 + VNET_INTERFACE_COUNTER_RX,
1939 vlib_get_thread_index (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1941 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
1943 return n_rx_packets;
1947 vhost_user_input (vlib_main_t * vm,
1948 vlib_node_runtime_t * node, vlib_frame_t * f)
1950 vhost_user_main_t *vum = &vhost_user_main;
1951 uword n_rx_packets = 0;
1952 u32 thread_index = vlib_get_thread_index ();
1953 vhost_iface_and_queue_t *vhiq;
1954 vhost_user_intf_t *vui;
1957 vhc = &vum->cpus[thread_index];
1958 if (PREDICT_TRUE (vhc->operation_mode == VHOST_USER_POLLING_MODE))
1960 vec_foreach (vhiq, vum->cpus[thread_index].rx_queues)
1962 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
1963 n_rx_packets += vhost_user_if_input (vm, vum, vui, vhiq->qid, node);
1971 clib_bitmap_foreach (i, vhc->pending_input_bitmap, ({
1974 clib_bitmap_set (vhc->pending_input_bitmap, i, 0);
1975 vui = pool_elt_at_index (vum->vhost_user_interfaces, i >> 8);
1976 n_rx_packets += vhost_user_if_input (vm, vum, vui, qid, node);
1980 return n_rx_packets;
1984 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1985 .function = vhost_user_input,
1986 .type = VLIB_NODE_TYPE_INPUT,
1987 .name = "vhost-user-input",
1988 .sibling_of = "device-input",
1990 /* Will be enabled if/when hardware is detected. */
1991 .state = VLIB_NODE_STATE_DISABLED,
1993 .format_buffer = format_ethernet_header_with_length,
1994 .format_trace = format_vhost_trace,
1996 .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1997 .error_strings = vhost_user_input_func_error_strings,
2000 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
2005 vhost_user_tx_trace (vhost_trace_t * t,
2006 vhost_user_intf_t * vui, u16 qid,
2007 vlib_buffer_t * b, vhost_user_vring_t * rxvq)
2009 vhost_user_main_t *vum = &vhost_user_main;
2010 u32 qsz_mask = rxvq->qsz - 1;
2011 u32 last_avail_idx = rxvq->last_avail_idx;
2012 u32 desc_current = rxvq->avail->ring[last_avail_idx & qsz_mask];
2013 vring_desc_t *hdr_desc = 0;
2016 memset (t, 0, sizeof (*t));
2017 t->device_index = vui - vum->vhost_user_interfaces;
2020 hdr_desc = &rxvq->desc[desc_current];
2021 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
2023 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
2024 /* Header is the first here */
2025 hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
2027 if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
2029 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
2031 if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
2032 !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
2034 t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
2037 t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
2040 static_always_inline u32
2041 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
2042 u16 copy_len, u32 * map_hint)
2044 void *dst0, *dst1, *dst2, *dst3;
2045 if (PREDICT_TRUE (copy_len >= 4))
2047 if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
2049 if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
2051 while (PREDICT_TRUE (copy_len >= 4))
2057 (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
2060 (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
2063 CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
2064 CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
2066 clib_memcpy (dst0, (void *) cpy[0].src, cpy[0].len);
2067 clib_memcpy (dst1, (void *) cpy[1].src, cpy[1].len);
2069 vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
2070 vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
2077 if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
2079 clib_memcpy (dst0, (void *) cpy->src, cpy->len);
2080 vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
2089 vhost_user_tx (vlib_main_t * vm,
2090 vlib_node_runtime_t * node, vlib_frame_t * frame)
2092 u32 *buffers = vlib_frame_args (frame);
2093 u32 n_left = frame->n_vectors;
2094 vhost_user_main_t *vum = &vhost_user_main;
2095 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
2096 vhost_user_intf_t *vui =
2097 pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
2099 vhost_user_vring_t *rxvq;
2102 u32 thread_index = vlib_get_thread_index ();
2108 if (PREDICT_FALSE (!vui->admin_up))
2110 error = VHOST_USER_TX_FUNC_ERROR_DOWN;
2114 if (PREDICT_FALSE (!vui->is_up))
2116 error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
2121 VHOST_VRING_IDX_RX (*vec_elt_at_index
2122 (vui->per_cpu_tx_qid, vlib_get_thread_index ()));
2123 rxvq = &vui->vrings[qid];
2124 if (PREDICT_FALSE (vui->use_tx_spinlock))
2125 vhost_user_vring_lock (vui, qid);
2127 qsz_mask = rxvq->qsz - 1; /* qsz is always power of 2 */
2130 error = VHOST_USER_TX_FUNC_ERROR_NONE;
2135 vlib_buffer_t *b0, *current_b0;
2136 u16 desc_head, desc_index, desc_len;
2137 vring_desc_t *desc_table;
2138 uword buffer_map_addr;
2142 if (PREDICT_TRUE (n_left > 1))
2143 vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
2145 b0 = vlib_get_buffer (vm, buffers[0]);
2147 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2149 vum->cpus[thread_index].current_trace =
2150 vlib_add_trace (vm, node, b0,
2151 sizeof (*vum->cpus[thread_index].current_trace));
2152 vhost_user_tx_trace (vum->cpus[thread_index].current_trace,
2153 vui, qid / 2, b0, rxvq);
2156 if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
2158 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2162 desc_table = rxvq->desc;
2163 desc_head = desc_index =
2164 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2166 /* Go deeper in case of indirect descriptor
2167 * I don't know of any driver providing indirect for RX. */
2168 if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2171 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2173 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2178 map_guest_mem (vui, rxvq->desc[desc_index].addr,
2181 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2187 desc_len = vui->virtio_net_hdr_sz;
2188 buffer_map_addr = desc_table[desc_index].addr;
2189 buffer_len = desc_table[desc_index].len;
2192 // Get a header from the header array
2193 virtio_net_hdr_mrg_rxbuf_t *hdr =
2194 &vum->cpus[thread_index].tx_headers[tx_headers_len];
2197 hdr->hdr.gso_type = 0;
2198 hdr->num_buffers = 1; //This is local, no need to check
2200 // Prepare a copy order executed later for the header
2201 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2203 cpy->len = vui->virtio_net_hdr_sz;
2204 cpy->dst = buffer_map_addr;
2205 cpy->src = (uword) hdr;
2208 buffer_map_addr += vui->virtio_net_hdr_sz;
2209 buffer_len -= vui->virtio_net_hdr_sz;
2210 bytes_left = b0->current_length;
2214 if (buffer_len == 0)
2216 if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
2218 //Next one is chained
2219 desc_index = desc_table[desc_index].next;
2220 buffer_map_addr = desc_table[desc_index].addr;
2221 buffer_len = desc_table[desc_index].len;
2223 else if (vui->virtio_net_hdr_sz == 12) //MRG is available
2225 virtio_net_hdr_mrg_rxbuf_t *hdr =
2226 &vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2228 //Move from available to used buffer
2229 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id =
2231 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len =
2233 vhost_user_log_dirty_ring (vui, rxvq,
2234 ring[rxvq->last_used_idx &
2237 rxvq->last_avail_idx++;
2238 rxvq->last_used_idx++;
2243 (rxvq->last_avail_idx == rxvq->avail->idx))
2245 //Dequeue queued descriptors for this packet
2246 rxvq->last_used_idx -= hdr->num_buffers - 1;
2247 rxvq->last_avail_idx -= hdr->num_buffers - 1;
2248 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2252 desc_table = rxvq->desc;
2253 desc_head = desc_index =
2254 rxvq->avail->ring[rxvq->last_avail_idx & qsz_mask];
2256 (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2258 //It is seriously unlikely that a driver will put indirect descriptor
2259 //after non-indirect descriptor.
2261 (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2263 error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2269 rxvq->desc[desc_index].addr,
2272 error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2277 buffer_map_addr = desc_table[desc_index].addr;
2278 buffer_len = desc_table[desc_index].len;
2282 error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
2288 vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2290 cpy->len = bytes_left;
2291 cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
2292 cpy->dst = buffer_map_addr;
2293 cpy->src = (uword) vlib_buffer_get_current (current_b0) +
2294 current_b0->current_length - bytes_left;
2296 bytes_left -= cpy->len;
2297 buffer_len -= cpy->len;
2298 buffer_map_addr += cpy->len;
2299 desc_len += cpy->len;
2301 CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
2304 // Check if vlib buffer has more data. If not, get more or break.
2305 if (PREDICT_TRUE (!bytes_left))
2308 (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
2310 current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
2311 bytes_left = current_b0->current_length;
2321 //Move from available to used ring
2322 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].id = desc_head;
2323 rxvq->used->ring[rxvq->last_used_idx & qsz_mask].len = desc_len;
2324 vhost_user_log_dirty_ring (vui, rxvq,
2325 ring[rxvq->last_used_idx & qsz_mask]);
2326 rxvq->last_avail_idx++;
2327 rxvq->last_used_idx++;
2329 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2331 vum->cpus[thread_index].current_trace->hdr =
2332 vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2335 n_left--; //At the end for error counting when 'goto done' is invoked
2340 //Do the memory copies
2342 (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2343 copy_len, &map_hint)))
2345 clib_warning ("Memory mapping error on interface hw_if_index=%d "
2346 "(Shutting down - Switch interface down and up to restart)",
2351 CLIB_MEMORY_BARRIER ();
2352 rxvq->used->idx = rxvq->last_used_idx;
2353 vhost_user_log_dirty_ring (vui, rxvq, idx);
2356 * When n_left is set, error is always set to something too.
2357 * In case error is due to lack of remaining buffers, we go back up and
2359 * The idea is that it is better to waste some time on packets
2360 * that have been processed already than dropping them and get
2361 * more fresh packets with a good likelyhood that they will be dropped too.
2362 * This technique also gives more time to VM driver to pick-up packets.
2363 * In case the traffic flows from physical to virtual interfaces, this
2364 * technique will end-up leveraging the physical NIC buffer in order to
2365 * absorb the VM's CPU jitter.
2367 if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
2373 /* interrupt (call) handling */
2374 if ((rxvq->callfd_idx != ~0) &&
2375 !(rxvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
2377 rxvq->n_since_last_int += frame->n_vectors - n_left;
2379 if (rxvq->n_since_last_int > vum->coalesce_frames)
2380 vhost_user_send_call (vm, rxvq);
2383 vhost_user_vring_unlock (vui, qid);
2386 if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
2388 vlib_error_count (vm, node->node_index, error, n_left);
2389 vlib_increment_simple_counter
2390 (vnet_main.interface_main.sw_if_counters
2391 + VNET_INTERFACE_COUNTER_DROP,
2392 vlib_get_thread_index (), vui->sw_if_index, n_left);
2395 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
2396 return frame->n_vectors;
2399 static clib_error_t *
2400 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
2403 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2404 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
2405 vhost_user_main_t *vum = &vhost_user_main;
2406 vhost_user_intf_t *vui =
2407 pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2409 vui->admin_up = is_up;
2412 vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
2413 VNET_HW_INTERFACE_FLAG_LINK_UP);
2415 return /* no error */ 0;
2419 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
2420 .name = "vhost-user",
2421 .tx_function = vhost_user_tx,
2422 .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
2423 .tx_function_error_strings = vhost_user_tx_func_error_strings,
2424 .format_device_name = format_vhost_user_interface_name,
2425 .name_renumber = vhost_user_name_renumber,
2426 .admin_up_down_function = vhost_user_interface_admin_up_down,
2427 .format_tx_trace = format_vhost_trace,
2430 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
2435 vhost_user_process (vlib_main_t * vm,
2436 vlib_node_runtime_t * rt, vlib_frame_t * f)
2438 vhost_user_main_t *vum = &vhost_user_main;
2439 vhost_user_intf_t *vui;
2440 struct sockaddr_un sun;
2442 unix_file_t template = { 0 };
2443 f64 timeout = 3153600000.0 /* 100 years */ ;
2444 uword *event_data = 0;
2447 sun.sun_family = AF_UNIX;
2448 template.read_function = vhost_user_socket_read;
2449 template.error_function = vhost_user_socket_error;
2453 vlib_process_wait_for_event_or_clock (vm, timeout);
2454 vlib_process_get_events (vm, &event_data);
2455 vec_reset_length (event_data);
2460 pool_foreach (vui, vum->vhost_user_interfaces, {
2462 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
2463 if (vui->unix_file_index == ~0)
2466 ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
2469 * 1st time error or new error for this interface,
2470 * spit out the message and record the error
2472 if (!vui->sock_errno || (vui->sock_errno != errno))
2475 ("Error: Could not open unix socket for %s",
2476 vui->sock_filename);
2477 vui->sock_errno = errno;
2482 /* try to connect */
2483 strncpy (sun.sun_path, (char *) vui->sock_filename,
2484 sizeof (sun.sun_path) - 1);
2486 /* Avoid hanging VPP if the other end does not accept */
2487 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
2488 clib_unix_warning ("fcntl");
2490 if (connect (sockfd, (struct sockaddr *) &sun,
2491 sizeof (struct sockaddr_un)) == 0)
2493 /* Set the socket to blocking as it was before */
2494 if (fcntl(sockfd, F_SETFL, 0) < 0)
2495 clib_unix_warning ("fcntl2");
2497 vui->sock_errno = 0;
2498 template.file_descriptor = sockfd;
2499 template.private_data =
2500 vui - vhost_user_main.vhost_user_interfaces;
2501 vui->unix_file_index = unix_file_add (&unix_main, &template);
2503 /* This sockfd is considered consumed */
2508 vui->sock_errno = errno;
2513 /* check if socket is alive */
2515 socklen_t len = sizeof (error);
2516 int fd = UNIX_GET_FD(vui->unix_file_index);
2518 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
2522 DBG_SOCK ("getsockopt returned %d", retval);
2523 vhost_user_if_disconnect (vui);
2534 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
2535 .function = vhost_user_process,
2536 .type = VLIB_NODE_TYPE_PROCESS,
2537 .name = "vhost-user-process",
2542 * Disables and reset interface structure.
2543 * It can then be either init again, or removed from used interfaces.
2546 vhost_user_term_if (vhost_user_intf_t * vui)
2550 // Delete configured thread pinning
2551 vec_reset_length (vui->workers);
2552 // disconnect interface sockets
2553 vhost_user_if_disconnect (vui);
2554 vhost_user_update_iface_state (vui);
2556 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2558 clib_mem_free ((void *) vui->vring_locks[q]);
2561 if (vui->unix_server_index != ~0)
2563 //Close server socket
2564 unix_file_t *uf = pool_elt_at_index (unix_main.file_pool,
2565 vui->unix_server_index);
2566 unix_file_del (&unix_main, uf);
2567 vui->unix_server_index = ~0;
2572 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
2574 vhost_user_main_t *vum = &vhost_user_main;
2575 vhost_user_intf_t *vui;
2577 vnet_hw_interface_t *hwif;
2579 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2580 hwif->dev_class_index != vhost_user_dev_class.index)
2581 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2583 DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
2584 hwif->name, hwif->dev_instance);
2586 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2588 // Disable and reset interface
2589 vhost_user_term_if (vui);
2591 // Reset renumbered iface
2592 if (hwif->dev_instance <
2593 vec_len (vum->show_dev_instance_by_real_dev_instance))
2594 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
2596 // Delete ethernet interface
2597 ethernet_delete_interface (vnm, vui->hw_if_index);
2600 pool_put (vum->vhost_user_interfaces, vui);
2606 * Open server unix socket on specified sock_filename.
2609 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
2612 struct sockaddr_un un = { };
2614 /* create listening socket */
2615 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
2616 return VNET_API_ERROR_SYSCALL_ERROR_1;
2618 un.sun_family = AF_UNIX;
2619 strncpy ((char *) un.sun_path, (char *) sock_filename,
2620 sizeof (un.sun_path) - 1);
2622 /* remove if exists */
2623 unlink ((char *) sock_filename);
2625 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
2627 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
2631 if (listen (fd, 1) == -1)
2633 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
2646 * Create ethernet interface for vhost user interface.
2649 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
2650 vhost_user_intf_t * vui, u8 * hwaddress)
2652 vhost_user_main_t *vum = &vhost_user_main;
2654 clib_error_t *error;
2656 /* create hw and sw interface */
2659 clib_memcpy (hwaddr, hwaddress, 6);
2663 random_u32 (&vum->random);
2664 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
2669 error = ethernet_register_interface
2671 vhost_user_dev_class.index,
2672 vui - vum->vhost_user_interfaces /* device instance */ ,
2673 hwaddr /* ethernet address */ ,
2674 &vui->hw_if_index, 0 /* flag change */ );
2677 clib_error_report (error);
2679 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, vui->hw_if_index);
2680 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
2684 * Initialize vui with specified attributes
2687 vhost_user_vui_init (vnet_main_t * vnm,
2688 vhost_user_intf_t * vui,
2690 const char *sock_filename,
2691 u64 feature_mask, u32 * sw_if_index, u8 operation_mode)
2693 vnet_sw_interface_t *sw;
2694 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
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 - vhost_user_main.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;
2720 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2721 vhost_user_vring_init (vui, q);
2723 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
2726 *sw_if_index = vui->sw_if_index;
2728 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2730 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
2731 CLIB_CACHE_LINE_BYTES);
2732 memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
2735 vec_validate (vui->per_cpu_tx_qid,
2736 vlib_get_thread_main ()->n_vlib_mains - 1);
2737 vhost_user_tx_thread_placement (vui);
2741 vhost_user_send_interrupt_process (vlib_main_t * vm,
2742 vlib_node_runtime_t * rt, vlib_frame_t * f)
2744 vhost_user_intf_t *vui;
2745 f64 timeout = 3153600000.0 /* 100 years */ ;
2746 uword event_type, *event_data = 0;
2747 vhost_user_main_t *vum = &vhost_user_main;
2748 vhost_iface_and_queue_t *vhiq;
2750 f64 now, poll_time_remaining;
2754 poll_time_remaining =
2755 vlib_process_wait_for_event_or_clock (vm, timeout);
2756 event_type = vlib_process_get_events (vm, &event_data);
2757 vec_reset_length (event_data);
2760 * Use the remaining timeout if it is less than coalesce time to avoid
2761 * resetting the existing timer in the middle of expiration
2763 timeout = poll_time_remaining;
2764 if (vlib_process_suspend_time_is_zero (timeout) ||
2765 (timeout > vum->coalesce_time))
2766 timeout = vum->coalesce_time;
2768 now = vlib_time_now (vm);
2771 case VHOST_USER_EVENT_START_TIMER:
2772 if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
2777 vec_foreach (vhc, vum->cpus)
2779 u32 thread_index = vhc - vum->cpus;
2782 next_timeout = timeout;
2783 vec_foreach (vhiq, vum->cpus[thread_index].rx_queues)
2785 vui = &vum->vhost_user_interfaces[vhiq->vhost_iface_index];
2786 vhost_user_vring_t *rxvq =
2787 &vui->vrings[VHOST_VRING_IDX_RX (vhiq->qid)];
2788 vhost_user_vring_t *txvq =
2789 &vui->vrings[VHOST_VRING_IDX_TX (vhiq->qid)];
2791 if (txvq->n_since_last_int)
2793 if (now >= txvq->int_deadline)
2794 vhost_user_send_call (vm, txvq);
2796 next_timeout = txvq->int_deadline - now;
2799 if (rxvq->n_since_last_int)
2801 if (now >= rxvq->int_deadline)
2802 vhost_user_send_call (vm, rxvq);
2804 next_timeout = rxvq->int_deadline - now;
2807 if ((next_timeout < timeout) && (next_timeout > 0.0))
2808 timeout = next_timeout;
2814 clib_warning ("BUG: unhandled event type %d", event_type);
2822 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node,static) = {
2823 .function = vhost_user_send_interrupt_process,
2824 .type = VLIB_NODE_TYPE_PROCESS,
2825 .name = "vhost-user-send-interrupt-process",
2830 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2831 const char *sock_filename,
2835 u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
2838 vhost_user_intf_t *vui = NULL;
2841 int server_sock_fd = -1;
2842 vhost_user_main_t *vum = &vhost_user_main;
2844 if ((operation_mode != VHOST_USER_POLLING_MODE) &&
2845 (operation_mode != VHOST_USER_INTERRUPT_MODE))
2846 return VNET_API_ERROR_UNIMPLEMENTED;
2848 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2850 return VNET_API_ERROR_INVALID_ARGUMENT;
2856 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
2862 pool_get (vhost_user_main.vhost_user_interfaces, vui);
2864 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2865 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
2866 feature_mask, &sw_if_idx, operation_mode);
2869 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2872 *sw_if_index = sw_if_idx;
2874 // Process node must connect
2875 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2877 if ((operation_mode == VHOST_USER_INTERRUPT_MODE) &&
2878 !vum->interrupt_mode && (vum->coalesce_time > 0.0) &&
2879 (vum->coalesce_frames > 0))
2881 vum->interrupt_mode = 1;
2882 vlib_process_signal_event (vm, vhost_user_send_interrupt_node.index,
2883 VHOST_USER_EVENT_START_TIMER, 0);
2889 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2890 const char *sock_filename,
2893 u64 feature_mask, u8 renumber, u32 custom_dev_instance,
2896 vhost_user_main_t *vum = &vhost_user_main;
2897 vhost_user_intf_t *vui = NULL;
2899 int server_sock_fd = -1;
2901 vnet_hw_interface_t *hwif;
2903 if ((operation_mode != VHOST_USER_POLLING_MODE) &&
2904 (operation_mode != VHOST_USER_INTERRUPT_MODE))
2905 return VNET_API_ERROR_UNIMPLEMENTED;
2906 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2907 hwif->dev_class_index != vhost_user_dev_class.index)
2908 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2910 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2912 // First try to open server socket
2914 if ((rv = vhost_user_init_server_sock (sock_filename,
2915 &server_sock_fd)) != 0)
2918 vhost_user_term_if (vui);
2919 vhost_user_vui_init (vnm, vui, server_sock_fd,
2920 sock_filename, feature_mask, &sw_if_idx,
2924 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2926 // Process node must connect
2927 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2929 if ((operation_mode == VHOST_USER_INTERRUPT_MODE) &&
2930 !vum->interrupt_mode && (vum->coalesce_time > 0.0) &&
2931 (vum->coalesce_frames > 0))
2933 vum->interrupt_mode = 1;
2934 vlib_process_signal_event (vm, vhost_user_send_interrupt_node.index,
2935 VHOST_USER_EVENT_START_TIMER, 0);
2941 unformat_vhost_user_operation_mode (unformat_input_t * input, va_list * args)
2943 u8 *operation_mode = va_arg (*args, u8 *);
2946 if (unformat (input, "interrupt"))
2947 *operation_mode = VHOST_USER_INTERRUPT_MODE;
2948 else if (unformat (input, "polling"))
2949 *operation_mode = VHOST_USER_POLLING_MODE;
2957 vhost_user_connect_command_fn (vlib_main_t * vm,
2958 unformat_input_t * input,
2959 vlib_cli_command_t * cmd)
2961 unformat_input_t _line_input, *line_input = &_line_input;
2962 u8 *sock_filename = NULL;
2965 u64 feature_mask = (u64) ~ (0ULL);
2967 u32 custom_dev_instance = ~0;
2970 clib_error_t *error = NULL;
2971 u8 operation_mode = VHOST_USER_POLLING_MODE;
2973 /* Get a line of input. */
2974 if (!unformat_user (input, unformat_line_input, line_input))
2977 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2979 if (unformat (line_input, "socket %s", &sock_filename))
2981 else if (unformat (line_input, "server"))
2983 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
2987 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
2989 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
2993 else if (unformat (line_input, "mode %U",
2994 unformat_vhost_user_operation_mode, &operation_mode))
2998 error = clib_error_return (0, "unknown input `%U'",
2999 format_unformat_error, line_input);
3004 vnet_main_t *vnm = vnet_get_main ();
3007 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
3008 is_server, &sw_if_index, feature_mask,
3009 renumber, custom_dev_instance, hw,
3012 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
3016 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
3020 vec_free (sock_filename);
3021 unformat_free (line_input);
3027 vhost_user_delete_command_fn (vlib_main_t * vm,
3028 unformat_input_t * input,
3029 vlib_cli_command_t * cmd)
3031 unformat_input_t _line_input, *line_input = &_line_input;
3032 u32 sw_if_index = ~0;
3033 vnet_main_t *vnm = vnet_get_main ();
3034 clib_error_t *error = NULL;
3036 /* Get a line of input. */
3037 if (!unformat_user (input, unformat_line_input, line_input))
3040 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3042 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
3045 (line_input, "%U", unformat_vnet_sw_interface, vnm,
3048 vnet_hw_interface_t *hwif =
3049 vnet_get_sup_hw_interface (vnm, sw_if_index);
3051 vhost_user_dev_class.index != hwif->dev_class_index)
3053 error = clib_error_return (0, "Not a vhost interface");
3059 error = clib_error_return (0, "unknown input `%U'",
3060 format_unformat_error, line_input);
3065 vhost_user_delete_if (vnm, vm, sw_if_index);
3068 unformat_free (line_input);
3074 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
3075 vhost_user_intf_details_t ** out_vuids)
3078 vhost_user_main_t *vum = &vhost_user_main;
3079 vhost_user_intf_t *vui;
3080 vhost_user_intf_details_t *r_vuids = NULL;
3081 vhost_user_intf_details_t *vuid = NULL;
3082 u32 *hw_if_indices = 0;
3083 vnet_hw_interface_t *hi;
3090 pool_foreach (vui, vum->vhost_user_interfaces,
3091 vec_add1 (hw_if_indices, vui->hw_if_index);
3094 for (i = 0; i < vec_len (hw_if_indices); i++)
3096 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3097 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3099 vec_add2 (r_vuids, vuid, 1);
3100 vuid->operation_mode = vui->operation_mode;
3101 vuid->sw_if_index = vui->sw_if_index;
3102 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
3103 vuid->features = vui->features;
3104 vuid->num_regions = vui->nregions;
3105 vuid->is_server = vui->unix_server_index != ~0;
3106 vuid->sock_errno = vui->sock_errno;
3107 strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
3108 ARRAY_LEN (vuid->sock_filename) - 1);
3110 s = format (s, "%v%c", hi->name, 0);
3112 strncpy ((char *) vuid->if_name, (char *) s,
3113 ARRAY_LEN (vuid->if_name) - 1);
3118 vec_free (hw_if_indices);
3120 *out_vuids = r_vuids;
3126 format_vhost_user_operation_mode (u8 * s, va_list * va)
3128 int operation_mode = va_arg (*va, int);
3130 switch (operation_mode)
3132 case VHOST_USER_POLLING_MODE:
3133 s = format (s, "%s", "polling");
3135 case VHOST_USER_INTERRUPT_MODE:
3136 s = format (s, "%s", "interrupt");
3139 s = format (s, "%s", "invalid");
3145 show_vhost_user_command_fn (vlib_main_t * vm,
3146 unformat_input_t * input,
3147 vlib_cli_command_t * cmd)
3149 clib_error_t *error = 0;
3150 vnet_main_t *vnm = vnet_get_main ();
3151 vhost_user_main_t *vum = &vhost_user_main;
3152 vhost_user_intf_t *vui;
3153 u32 hw_if_index, *hw_if_indices = 0;
3154 vnet_hw_interface_t *hi;
3156 vhost_iface_and_queue_t *vhiq;
3166 struct feat_struct *feat_entry;
3168 static struct feat_struct feat_array[] = {
3169 #define _(s,b) { .str = #s, .bit = b, },
3170 foreach_virtio_net_feature
3175 #define foreach_protocol_feature \
3176 _(VHOST_USER_PROTOCOL_F_MQ) \
3177 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
3179 static struct feat_struct proto_feat_array[] = {
3180 #define _(s) { .str = #s, .bit = s},
3181 foreach_protocol_feature
3186 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3189 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
3191 vec_add1 (hw_if_indices, hw_if_index);
3193 else if (unformat (input, "descriptors") || unformat (input, "desc"))
3197 error = clib_error_return (0, "unknown input `%U'",
3198 format_unformat_error, input);
3202 if (vec_len (hw_if_indices) == 0)
3204 pool_foreach (vui, vum->vhost_user_interfaces,
3205 vec_add1 (hw_if_indices, vui->hw_if_index);
3208 vlib_cli_output (vm, "Virtio vhost-user interfaces");
3209 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
3210 vum->coalesce_frames, vum->coalesce_time);
3212 for (i = 0; i < vec_len (hw_if_indices); i++)
3214 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3215 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3216 vlib_cli_output (vm, "Interface: %s (ifindex %d)",
3217 hi->name, hw_if_indices[i]);
3219 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
3220 " features mask (0x%llx): \n"
3221 " features (0x%llx): \n",
3222 vui->virtio_net_hdr_sz, vui->feature_mask,
3225 feat_entry = (struct feat_struct *) &feat_array;
3226 while (feat_entry->str)
3228 if (vui->features & (1ULL << feat_entry->bit))
3229 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3234 vlib_cli_output (vm, " protocol features (0x%llx)",
3235 vui->protocol_features);
3236 feat_entry = (struct feat_struct *) &proto_feat_array;
3237 while (feat_entry->str)
3239 if (vui->protocol_features & (1ULL << feat_entry->bit))
3240 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
3245 vlib_cli_output (vm, "\n");
3247 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
3249 (vui->unix_server_index != ~0) ? "server" : "client",
3250 strerror (vui->sock_errno));
3252 vlib_cli_output (vm, " configured mode: %U\n",
3253 format_vhost_user_operation_mode, vui->operation_mode);
3254 vlib_cli_output (vm, " rx placement: ");
3255 vec_foreach (vhc, vum->cpus)
3257 vec_foreach (vhiq, vhc->rx_queues)
3259 if (vhiq->vhost_iface_index == vui - vum->vhost_user_interfaces)
3261 vlib_cli_output (vm, " thread %d on vring %d\n",
3263 VHOST_VRING_IDX_TX (vhiq->qid));
3264 vlib_cli_output (vm, " mode: %U\n",
3265 format_vhost_user_operation_mode,
3266 vhc->operation_mode);
3271 vlib_cli_output (vm, " tx placement: %s\n",
3272 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
3274 vec_foreach_index (ci, vui->per_cpu_tx_qid)
3276 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
3277 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
3280 vlib_cli_output (vm, "\n");
3282 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
3286 vlib_cli_output (vm,
3287 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
3288 vlib_cli_output (vm,
3289 " ====== ===== ================== ================== ================== ================== ==================\n");
3291 for (j = 0; j < vui->nregions; j++)
3293 vlib_cli_output (vm,
3294 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
3295 j, vui->region_mmap_fd[j],
3296 vui->regions[j].guest_phys_addr,
3297 vui->regions[j].memory_size,
3298 vui->regions[j].userspace_addr,
3299 vui->regions[j].mmap_offset,
3300 pointer_to_uword (vui->region_mmap_addr[j]));
3302 for (q = 0; q < VHOST_VRING_MAX_N; q++)
3304 if (!vui->vrings[q].started)
3307 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
3308 (q & 1) ? "RX" : "TX",
3309 vui->vrings[q].enabled ? "" : " disabled");
3311 vlib_cli_output (vm,
3312 " qsz %d last_avail_idx %d last_used_idx %d\n",
3313 vui->vrings[q].qsz, vui->vrings[q].last_avail_idx,
3314 vui->vrings[q].last_used_idx);
3316 if (vui->vrings[q].avail && vui->vrings[q].used)
3317 vlib_cli_output (vm,
3318 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
3319 vui->vrings[q].avail->flags,
3320 vui->vrings[q].avail->idx,
3321 vui->vrings[q].used->flags,
3322 vui->vrings[q].used->idx);
3324 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
3325 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
3326 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n",
3327 kickfd, callfd, vui->vrings[q].errfd);
3331 vlib_cli_output (vm, "\n descriptor table:\n");
3332 vlib_cli_output (vm,
3333 " id addr len flags next user_addr\n");
3334 vlib_cli_output (vm,
3335 " ===== ================== ===== ====== ===== ==================\n");
3336 for (j = 0; j < vui->vrings[q].qsz; j++)
3339 vlib_cli_output (vm,
3340 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
3341 j, vui->vrings[q].desc[j].addr,
3342 vui->vrings[q].desc[j].len,
3343 vui->vrings[q].desc[j].flags,
3344 vui->vrings[q].desc[j].next,
3345 pointer_to_uword (map_guest_mem
3347 vui->vrings[q].desc[j].
3352 vlib_cli_output (vm, "\n");
3355 vec_free (hw_if_indices);
3364 * Create a vHost User interface. Once created, a new virtual interface
3365 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
3366 * is the next free index.
3368 * There are several parameters associated with a vHost interface:
3370 * - <b>socket <socket-filename></b> - Name of the linux socket used by QEMU/VM and
3371 * VPP to manage the vHost interface. If socket does not already exist, VPP will
3372 * create the socket.
3374 * - <b>server</b> - Optional flag to indicate that VPP should be the server for the
3375 * linux socket. If not provided, VPP will be the client.
3377 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
3378 * startup. By default, all supported features will be advertised. Otherwise,
3379 * provide the set of features desired.
3380 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
3381 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
3382 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
3383 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
3384 * - 0x004000000 (26) - VHOST_F_LOG_ALL
3385 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
3386 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
3387 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
3388 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
3390 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
3391 * X:X:X:X:X:X unix or X.X.X cisco format.
3393 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
3394 * in the name to be specified. If instance already exists, name will be used
3395 * anyway and multiple instances will have the same name. Use with caution.
3397 * - <b>mode [interrupt | polling]</b> - Optional parameter specifying
3398 * the input thread polling policy.
3401 * Example of how to create a vhost interface with VPP as the client and all features enabled:
3402 * @cliexstart{create vhost-user socket /tmp/vhost1.sock}
3403 * VirtualEthernet0/0/0
3405 * Example of how to create a vhost interface with VPP as the server and with just
3406 * multiple queues enabled:
3407 * @cliexstart{create vhost-user socket /tmp/vhost2.sock server feature-mask 0x40400000}
3408 * VirtualEthernet0/0/1
3410 * Once the vHost interface is created, enable the interface using:
3411 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
3414 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
3415 .path = "create vhost-user",
3416 .short_help = "create vhost-user socket <socket-filename> [server] "
3417 "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] "
3418 "[mode {interrupt | polling}]",
3419 .function = vhost_user_connect_command_fn,
3424 * Delete a vHost User interface using the interface name or the
3425 * software interface index. Use the '<em>show interface</em>'
3426 * command to determine the software interface index. On deletion,
3427 * the linux socket will not be deleted.
3430 * Example of how to delete a vhost interface by name:
3431 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
3432 * Example of how to delete a vhost interface by software interface index:
3433 * @cliexcmd{delete vhost-user sw_if_index 1}
3436 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
3437 .path = "delete vhost-user",
3438 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
3439 .function = vhost_user_delete_command_fn,
3443 * Display the attributes of a single vHost User interface (provide interface
3444 * name), multiple vHost User interfaces (provide a list of interface names seperated
3445 * by spaces) or all Vhost User interfaces (omit an interface name to display all
3446 * vHost interfaces).
3450 * Example of how to display a vhost interface:
3451 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
3452 * Virtio vhost-user interfaces
3454 * coalesce frames 32 time 1e-3
3455 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3456 * virtio_net_hdr_sz 12
3457 * features mask (0xffffffffffffffff):
3458 * features (0x50408000):
3459 * VIRTIO_NET_F_MRG_RXBUF (15)
3460 * VIRTIO_NET_F_MQ (22)
3461 * VIRTIO_F_INDIRECT_DESC (28)
3462 * VHOST_USER_F_PROTOCOL_FEATURES (30)
3463 * protocol features (0x3)
3464 * VHOST_USER_PROTOCOL_F_MQ (0)
3465 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
3467 * socket filename /tmp/vhost1.sock type client errno "Success"
3470 * thread 1 on vring 1
3471 * thread 1 on vring 5
3472 * thread 2 on vring 3
3473 * thread 2 on vring 7
3474 * tx placement: spin-lock
3475 * thread 0 on vring 0
3476 * thread 1 on vring 2
3477 * thread 2 on vring 0
3479 * Memory regions (total 2)
3480 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
3481 * ====== ===== ================== ================== ================== ================== ==================
3482 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
3483 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
3486 * qsz 256 last_avail_idx 0 last_used_idx 0
3487 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3488 * kickfd 62 callfd 64 errfd -1
3491 * qsz 256 last_avail_idx 0 last_used_idx 0
3492 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3493 * kickfd 65 callfd 66 errfd -1
3496 * qsz 256 last_avail_idx 0 last_used_idx 0
3497 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3498 * kickfd 63 callfd 70 errfd -1
3501 * qsz 256 last_avail_idx 0 last_used_idx 0
3502 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3503 * kickfd 72 callfd 74 errfd -1
3505 * Virtqueue 4 (TX disabled)
3506 * qsz 256 last_avail_idx 0 last_used_idx 0
3507 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3508 * kickfd 76 callfd 78 errfd -1
3510 * Virtqueue 5 (RX disabled)
3511 * qsz 256 last_avail_idx 0 last_used_idx 0
3512 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3513 * kickfd 80 callfd 82 errfd -1
3515 * Virtqueue 6 (TX disabled)
3516 * qsz 256 last_avail_idx 0 last_used_idx 0
3517 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3518 * kickfd 84 callfd 86 errfd -1
3520 * Virtqueue 7 (RX disabled)
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 88 callfd 90 errfd -1
3527 * The optional '<em>descriptors</em>' parameter will display the same output as
3528 * the previous example but will include the descriptor table for each queue.
3529 * The output is truncated below:
3530 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
3531 * Virtio vhost-user interfaces
3533 * coalesce frames 32 time 1e-3
3534 * Interface: VirtualEthernet0/0/0 (ifindex 1)
3535 * virtio_net_hdr_sz 12
3536 * features mask (0xffffffffffffffff):
3537 * features (0x50408000):
3538 * VIRTIO_NET_F_MRG_RXBUF (15)
3539 * VIRTIO_NET_F_MQ (22)
3542 * qsz 256 last_avail_idx 0 last_used_idx 0
3543 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3544 * kickfd 62 callfd 64 errfd -1
3547 * id addr len flags next user_addr
3548 * ===== ================== ===== ====== ===== ==================
3549 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
3550 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
3551 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
3552 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
3553 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
3554 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
3555 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
3556 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
3557 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
3558 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
3559 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
3561 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
3562 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
3563 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
3564 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
3565 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
3566 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
3567 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
3570 * qsz 256 last_avail_idx 0 last_used_idx 0
3576 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
3577 .path = "show vhost-user",
3578 .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
3579 .function = show_vhost_user_command_fn,
3583 static clib_error_t *
3584 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
3586 vhost_user_main_t *vum = &vhost_user_main;
3588 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3590 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
3592 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
3594 else if (unformat (input, "dont-dump-memory"))
3595 vum->dont_dump_vhost_user_memory = 1;
3597 return clib_error_return (0, "unknown input `%U'",
3598 format_unformat_error, input);
3604 /* vhost-user { ... } configuration. */
3605 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
3608 vhost_user_unmap_all (void)
3610 vhost_user_main_t *vum = &vhost_user_main;
3611 vhost_user_intf_t *vui;
3613 if (vum->dont_dump_vhost_user_memory)
3615 pool_foreach (vui, vum->vhost_user_interfaces,
3616 unmap_all_mem_regions (vui);
3621 static clib_error_t *
3622 vhost_thread_command_fn (vlib_main_t * vm,
3623 unformat_input_t * input, vlib_cli_command_t * cmd)
3625 unformat_input_t _line_input, *line_input = &_line_input;
3626 u32 worker_thread_index;
3630 clib_error_t *error = NULL;
3632 /* Get a line of input. */
3633 if (!unformat_user (input, unformat_line_input, line_input))
3637 (line_input, "%U %d", unformat_vnet_sw_interface, vnet_get_main (),
3638 &sw_if_index, &worker_thread_index))
3640 error = clib_error_return (0, "unknown input `%U'",
3641 format_unformat_error, line_input);
3645 if (unformat (line_input, "del"))
3649 vhost_user_thread_placement (sw_if_index, worker_thread_index, del)))
3651 error = clib_error_return (0, "vhost_user_thread_placement returned %d",
3657 unformat_free (line_input);
3664 * This command is used to move the RX processing for the given
3665 * interfaces to the provided thread. If the '<em>del</em>' option is used,
3666 * the forced thread assignment is removed and the thread assigment is
3667 * reassigned automatically. Use '<em>show vhost-user <interface></em>'
3668 * to see the thread assignment.
3671 * Example of how to move the RX processing for a given interface to a given thread:
3672 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1}
3673 * Example of how to remove the forced thread assignment for a given interface:
3674 * @cliexcmd{vhost thread VirtualEthernet0/0/0 1 del}
3677 VLIB_CLI_COMMAND (vhost_user_thread_command, static) = {
3678 .path = "vhost thread",
3679 .short_help = "vhost thread <iface> <worker-index> [del]",
3680 .function = vhost_thread_command_fn,
3685 * fd.io coding-style-patch-verification: ON
3688 * eval: (c-set-style "gnu")