2 *------------------------------------------------------------------
5 * Copyright (c) 2014-2018 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/ethernet/ethernet.h>
37 #include <vnet/devices/devices.h>
38 #include <vnet/feature/feature.h>
40 #include <vnet/devices/virtio/vhost_user.h>
41 #include <vnet/devices/virtio/vhost_user_inline.h>
45 * @brief vHost User Device Driver.
47 * This file contains the source code for vHost User interface.
51 vlib_node_registration_t vhost_user_send_interrupt_node;
54 vhost_user_main_t vhost_user_main = {
58 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
64 get_huge_page_size (int fd)
72 unmap_all_mem_regions (vhost_user_intf_t * vui)
75 vhost_user_vring_t *vq;
77 for (i = 0; i < vui->nregions; i++)
79 if (vui->region_mmap_addr[i] != MAP_FAILED)
82 long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
84 ssize_t map_sz = (vui->regions[i].memory_size +
85 vui->regions[i].mmap_offset +
86 page_sz - 1) & ~(page_sz - 1);
89 munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
92 vu_log_debug (vui, "unmap memory region %d addr 0x%lx len 0x%lx "
93 "page_sz 0x%x", i, vui->region_mmap_addr[i], map_sz,
96 vui->region_mmap_addr[i] = MAP_FAILED;
100 vu_log_err (vui, "failed to unmap memory region (errno %d)",
103 close (vui->region_mmap_fd[i]);
108 for (q = 0; q < VHOST_VRING_MAX_N; q++)
110 vq = &vui->vrings[q];
117 static_always_inline void
118 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
120 //Let's try to assign one queue to each thread
122 u32 thread_index = 0;
124 vui->use_tx_spinlock = 0;
127 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
129 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
130 if (!rxvq->started || !rxvq->enabled)
133 vui->per_cpu_tx_qid[thread_index] = qid;
135 if (thread_index == vlib_get_thread_main ()->n_vlib_mains)
138 //We need to loop, meaning the spinlock has to be used
139 vui->use_tx_spinlock = 1;
140 if (thread_index == 0)
142 //Could not find a single valid one
143 for (thread_index = 0;
144 thread_index < vlib_get_thread_main ()->n_vlib_mains;
147 vui->per_cpu_tx_qid[thread_index] = 0;
155 * @brief Unassign existing interface/queue to thread mappings and re-assign
156 * new interface/queue to thread mappings
158 static_always_inline void
159 vhost_user_rx_thread_placement (vhost_user_intf_t * vui, u32 qid)
161 vhost_user_vring_t *txvq = &vui->vrings[qid];
162 vnet_main_t *vnm = vnet_get_main ();
166 ASSERT ((qid & 1) == 1); // should be odd
167 // Assign new queue mappings for the interface
168 vnet_hw_interface_set_input_node (vnm, vui->hw_if_index,
169 vhost_user_input_node.index);
170 vnet_hw_interface_assign_rx_thread (vnm, vui->hw_if_index, q, ~0);
171 if (txvq->mode == VNET_HW_IF_RX_MODE_UNKNOWN)
172 /* Set polling as the default */
173 txvq->mode = VNET_HW_IF_RX_MODE_POLLING;
175 rv = vnet_hw_interface_set_rx_mode (vnm, vui->hw_if_index, q, txvq->mode);
177 vu_log_warn (vui, "unable to set rx mode for interface %d, "
178 "queue %d: rc=%d", vui->hw_if_index, q, rv);
181 /** @brief Returns whether at least one TX and one RX vring are enabled */
182 static_always_inline int
183 vhost_user_intf_ready (vhost_user_intf_t * vui)
185 int i, found[2] = { }; //RX + TX
187 for (i = 0; i < VHOST_VRING_MAX_N; i++)
188 if (vui->vrings[i].started && vui->vrings[i].enabled)
191 return found[0] && found[1];
194 static_always_inline void
195 vhost_user_update_iface_state (vhost_user_intf_t * vui)
197 /* if we have pointers to descriptor table, go up */
198 int is_ready = vhost_user_intf_ready (vui);
199 if (is_ready != vui->is_ready)
201 vu_log_debug (vui, "interface %d %s", vui->sw_if_index,
202 is_ready ? "ready" : "down");
204 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
205 is_ready ? VNET_HW_INTERFACE_FLAG_LINK_UP
207 vui->is_ready = is_ready;
212 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
215 vnet_main_t *vnm = vnet_get_main ();
219 /* Only care about the odd number, or TX, virtqueue */
222 if (vhost_user_intf_ready (vui))
223 // qid >> 1 is to convert virtqueue number to vring queue index
224 vnet_device_input_set_interrupt_pending (vnm, vui->hw_if_index, qid >> 1);
227 static clib_error_t *
228 vhost_user_callfd_read_ready (clib_file_t * uf)
230 __attribute__ ((unused)) int n;
233 n = read (uf->file_descriptor, ((char *) &buff), 8);
238 static_always_inline void
239 vhost_user_thread_placement (vhost_user_intf_t * vui, u32 qid)
241 if (qid & 1) // RX is odd, TX is even
243 if (vui->vrings[qid].qid == -1)
244 vhost_user_rx_thread_placement (vui, qid);
247 vhost_user_tx_thread_placement (vui);
250 static clib_error_t *
251 vhost_user_kickfd_read_ready (clib_file_t * uf)
253 __attribute__ ((unused)) int n;
255 vhost_user_intf_t *vui =
256 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
257 uf->private_data >> 8);
258 u32 qid = uf->private_data & 0xff;
260 n = read (uf->file_descriptor, ((char *) &buff), 8);
261 vu_log_debug (vui, "if %d KICK queue %d", uf->private_data >> 8, qid);
262 if (!vui->vrings[qid].started ||
263 (vhost_user_intf_ready (vui) != vui->is_ready))
265 if (vui->vrings[qid].started == 0)
267 vui->vrings[qid].started = 1;
268 vhost_user_thread_placement (vui, qid);
269 vhost_user_update_iface_state (vui);
273 vhost_user_set_interrupt_pending (vui, uf->private_data);
277 static_always_inline void
278 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
280 vhost_user_vring_t *vring = &vui->vrings[qid];
281 clib_memset (vring, 0, sizeof (*vring));
282 vring->kickfd_idx = ~0;
283 vring->callfd_idx = ~0;
288 * We have a bug with some qemu 2.5, and this may be a fix.
289 * Feel like interpretation holy text, but this is from vhost-user.txt.
291 * One queue pair is enabled initially. More queues are enabled
292 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
294 * Don't know who's right, but this is what DPDK does.
296 if (qid == 0 || qid == 1)
300 static_always_inline void
301 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
303 vhost_user_vring_t *vring = &vui->vrings[qid];
305 if (vring->kickfd_idx != ~0)
307 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
309 clib_file_del (&file_main, uf);
310 vring->kickfd_idx = ~0;
312 if (vring->callfd_idx != ~0)
314 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
316 clib_file_del (&file_main, uf);
317 vring->callfd_idx = ~0;
319 if (vring->errfd != -1)
321 close (vring->errfd);
325 // save the qid so that we don't need to unassign and assign_rx_thread
326 // when the interface comes back up. They are expensive calls.
327 u16 q = vui->vrings[qid].qid;
328 vhost_user_vring_init (vui, qid);
329 vui->vrings[qid].qid = q;
332 static_always_inline void
333 vhost_user_if_disconnect (vhost_user_intf_t * vui)
335 vnet_main_t *vnm = vnet_get_main ();
338 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
340 if (vui->clib_file_index != ~0)
342 clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
343 vui->clib_file_index = ~0;
348 for (q = 0; q < VHOST_VRING_MAX_N; q++)
349 vhost_user_vring_close (vui, q);
351 unmap_all_mem_regions (vui);
352 vu_log_debug (vui, "interface ifindex %d disconnected", vui->sw_if_index);
355 static clib_error_t *
356 vhost_user_socket_read (clib_file_t * uf)
359 int fd, number_of_fds = 0;
360 int fds[VHOST_MEMORY_MAX_NREGIONS];
361 vhost_user_msg_t msg;
364 vhost_user_main_t *vum = &vhost_user_main;
365 vhost_user_intf_t *vui;
366 struct cmsghdr *cmsg;
368 clib_file_t template = { 0 };
369 vnet_main_t *vnm = vnet_get_main ();
370 vlib_main_t *vm = vlib_get_main ();
372 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
374 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
376 clib_memset (&mh, 0, sizeof (mh));
377 clib_memset (control, 0, sizeof (control));
379 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
382 /* set the payload */
383 iov[0].iov_base = (void *) &msg;
384 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
388 mh.msg_control = control;
389 mh.msg_controllen = sizeof (control);
391 n = recvmsg (uf->file_descriptor, &mh, 0);
393 if (n != VHOST_USER_MSG_HDR_SZ)
397 vu_log_debug (vui, "recvmsg returned error %d %s", errno,
402 vu_log_debug (vui, "n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
403 n, VHOST_USER_MSG_HDR_SZ);
408 if (mh.msg_flags & MSG_CTRUNC)
410 vu_log_debug (vui, "MSG_CTRUNC is set");
414 cmsg = CMSG_FIRSTHDR (&mh);
416 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
417 (cmsg->cmsg_type == SCM_RIGHTS) &&
418 (cmsg->cmsg_len - CMSG_LEN (0) <=
419 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
421 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
422 clib_memcpy_fast (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
425 /* version 1, no reply bit set */
426 if ((msg.flags & 7) != 1)
428 vu_log_debug (vui, "malformed message received. closing socket");
435 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
439 vu_log_debug (vui, "read failed %s", strerror (errno));
442 else if (rv != msg.size)
444 vu_log_debug (vui, "message too short (read %dB should be %dB)", rv,
452 case VHOST_USER_GET_FEATURES:
454 msg.u64 = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) |
455 VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ) |
456 VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT) |
457 VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC) |
458 VIRTIO_FEATURE (VHOST_F_LOG_ALL) |
459 VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_ANNOUNCE) |
460 VIRTIO_FEATURE (VIRTIO_NET_F_MQ) |
461 VIRTIO_FEATURE (VHOST_USER_F_PROTOCOL_FEATURES) |
462 VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
463 msg.u64 &= vui->feature_mask;
466 msg.u64 |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
467 if (vui->enable_packed)
468 msg.u64 |= VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
470 msg.size = sizeof (msg.u64);
471 vu_log_debug (vui, "if %d msg VHOST_USER_GET_FEATURES - reply "
472 "0x%016llx", vui->hw_if_index, msg.u64);
474 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
475 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
477 vu_log_debug (vui, "could not send message response");
482 case VHOST_USER_SET_FEATURES:
483 vu_log_debug (vui, "if %d msg VHOST_USER_SET_FEATURES features "
484 "0x%016llx", vui->hw_if_index, msg.u64);
486 vui->features = msg.u64;
489 (VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) |
490 VIRTIO_FEATURE (VIRTIO_F_VERSION_1)))
491 vui->virtio_net_hdr_sz = 12;
493 vui->virtio_net_hdr_sz = 10;
496 (vui->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
498 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
499 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
500 if (vui->enable_gso &&
501 ((vui->features & FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS)
502 == FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS))
504 (VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
505 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
507 hw->flags &= ~(VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
508 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
509 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
511 vhost_user_update_iface_state (vui);
514 case VHOST_USER_SET_MEM_TABLE:
515 vu_log_debug (vui, "if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
516 vui->hw_if_index, msg.memory.nregions);
518 if ((msg.memory.nregions < 1) ||
519 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
521 vu_log_debug (vui, "number of mem regions must be between 1 and %i",
522 VHOST_MEMORY_MAX_NREGIONS);
526 if (msg.memory.nregions != number_of_fds)
528 vu_log_debug (vui, "each memory region must have FD");
532 /* Do the mmap without barrier sync */
533 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
534 for (i = 0; i < msg.memory.nregions; i++)
536 long page_sz = get_huge_page_size (fds[i]);
538 /* align size to page */
539 ssize_t map_sz = (msg.memory.regions[i].memory_size +
540 msg.memory.regions[i].mmap_offset +
541 page_sz - 1) & ~(page_sz - 1);
543 region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
544 MAP_SHARED, fds[i], 0);
545 if (region_mmap_addr[i] == MAP_FAILED)
547 vu_log_err (vui, "failed to map memory. errno is %d", errno);
548 for (j = 0; j < i; j++)
549 munmap (region_mmap_addr[j], map_sz);
552 vu_log_debug (vui, "map memory region %d addr 0 len 0x%lx fd %d "
553 "mapped 0x%lx page_sz 0x%x", i, map_sz, fds[i],
554 region_mmap_addr[i], page_sz);
557 vlib_worker_thread_barrier_sync (vm);
558 unmap_all_mem_regions (vui);
559 for (i = 0; i < msg.memory.nregions; i++)
561 clib_memcpy_fast (&(vui->regions[i]), &msg.memory.regions[i],
562 sizeof (vhost_user_memory_region_t));
564 vui->region_mmap_addr[i] = region_mmap_addr[i];
565 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
566 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
567 vui->regions[i].memory_size;
569 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
570 vui->region_mmap_fd[i] = fds[i];
576 * Re-compute desc, used, and avail descriptor table if vring address
579 for (q = 0; q < VHOST_VRING_MAX_N; q++)
581 if (vui->vrings[q].desc_user_addr &&
582 vui->vrings[q].used_user_addr && vui->vrings[q].avail_user_addr)
584 vui->vrings[q].desc =
585 map_user_mem (vui, vui->vrings[q].desc_user_addr);
586 vui->vrings[q].used =
587 map_user_mem (vui, vui->vrings[q].used_user_addr);
588 vui->vrings[q].avail =
589 map_user_mem (vui, vui->vrings[q].avail_user_addr);
592 vlib_worker_thread_barrier_release (vm);
595 case VHOST_USER_SET_VRING_NUM:
596 vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
597 vui->hw_if_index, msg.state.index, msg.state.num);
599 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
600 (msg.state.num == 0) || /* it cannot be zero */
601 ((msg.state.num - 1) & msg.state.num) || /* must be power of 2 */
602 (msg.state.index >= VHOST_VRING_MAX_N))
604 vui->vrings[msg.state.index].qsz_mask = msg.state.num - 1;
607 case VHOST_USER_SET_VRING_ADDR:
608 vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
609 vui->hw_if_index, msg.state.index);
611 if (msg.state.index >= VHOST_VRING_MAX_N)
613 vu_log_debug (vui, "invalid vring index VHOST_USER_SET_VRING_ADDR:"
614 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
618 if (msg.size < sizeof (msg.addr))
620 vu_log_debug (vui, "vhost message is too short (%d < %d)",
621 msg.size, sizeof (msg.addr));
625 vring_desc_t *desc = map_user_mem (vui, msg.addr.desc_user_addr);
626 vring_used_t *used = map_user_mem (vui, msg.addr.used_user_addr);
627 vring_avail_t *avail = map_user_mem (vui, msg.addr.avail_user_addr);
629 if ((desc == NULL) || (used == NULL) || (avail == NULL))
631 vu_log_debug (vui, "failed to map user memory for hw_if_index %d",
636 vui->vrings[msg.state.index].desc_user_addr = msg.addr.desc_user_addr;
637 vui->vrings[msg.state.index].used_user_addr = msg.addr.used_user_addr;
638 vui->vrings[msg.state.index].avail_user_addr = msg.addr.avail_user_addr;
640 vlib_worker_thread_barrier_sync (vm);
641 vui->vrings[msg.state.index].desc = desc;
642 vui->vrings[msg.state.index].used = used;
643 vui->vrings[msg.state.index].avail = avail;
645 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
646 vui->vrings[msg.state.index].log_used =
647 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
649 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
650 the ring is initialized in an enabled state. */
651 if (!(vui->features & VIRTIO_FEATURE (VHOST_USER_F_PROTOCOL_FEATURES)))
652 vui->vrings[msg.state.index].enabled = 1;
654 vui->vrings[msg.state.index].last_used_idx =
655 vui->vrings[msg.state.index].last_avail_idx =
656 vui->vrings[msg.state.index].used->idx;
658 /* tell driver that we don't want interrupts */
659 if (vhost_user_is_packed_ring_supported (vui))
660 vui->vrings[msg.state.index].used_event->flags =
661 VRING_EVENT_F_DISABLE;
663 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
664 vlib_worker_thread_barrier_release (vm);
665 vhost_user_update_iface_state (vui);
668 case VHOST_USER_SET_OWNER:
669 vu_log_debug (vui, "if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
672 case VHOST_USER_RESET_OWNER:
673 vu_log_debug (vui, "if %d msg VHOST_USER_RESET_OWNER",
677 case VHOST_USER_SET_VRING_CALL:
678 vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_CALL %d",
679 vui->hw_if_index, msg.u64);
681 q = (u8) (msg.u64 & 0xFF);
682 if (q >= VHOST_VRING_MAX_N)
685 /* if there is old fd, delete and close it */
686 if (vui->vrings[q].callfd_idx != ~0)
688 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
689 vui->vrings[q].callfd_idx);
690 clib_file_del (&file_main, uf);
691 vui->vrings[q].callfd_idx = ~0;
694 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
696 if (number_of_fds != 1)
698 vu_log_debug (vui, "More than one fd received !");
702 template.read_function = vhost_user_callfd_read_ready;
703 template.file_descriptor = fds[0];
704 template.private_data =
705 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
706 vui->vrings[q].callfd_idx = clib_file_add (&file_main, &template);
709 vui->vrings[q].callfd_idx = ~0;
712 case VHOST_USER_SET_VRING_KICK:
713 vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_KICK %d",
714 vui->hw_if_index, msg.u64);
716 q = (u8) (msg.u64 & 0xFF);
717 if (q >= VHOST_VRING_MAX_N)
720 if (vui->vrings[q].kickfd_idx != ~0)
722 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
723 vui->vrings[q].kickfd_idx);
724 clib_file_del (&file_main, uf);
725 vui->vrings[q].kickfd_idx = ~0;
728 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
730 if (number_of_fds != 1)
732 vu_log_debug (vui, "More than one fd received !");
736 template.read_function = vhost_user_kickfd_read_ready;
737 template.file_descriptor = fds[0];
738 template.private_data =
739 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
741 vui->vrings[q].kickfd_idx = clib_file_add (&file_main, &template);
745 //When no kickfd is set, the queue is initialized as started
746 vui->vrings[q].kickfd_idx = ~0;
747 vui->vrings[q].started = 1;
748 vhost_user_thread_placement (vui, q);
750 vhost_user_update_iface_state (vui);
753 case VHOST_USER_SET_VRING_ERR:
754 vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_ERR %d",
755 vui->hw_if_index, msg.u64);
757 q = (u8) (msg.u64 & 0xFF);
758 if (q >= VHOST_VRING_MAX_N)
761 if (vui->vrings[q].errfd != -1)
762 close (vui->vrings[q].errfd);
764 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
766 if (number_of_fds != 1)
769 vui->vrings[q].errfd = fds[0];
772 vui->vrings[q].errfd = -1;
775 case VHOST_USER_SET_VRING_BASE:
777 "if %d msg VHOST_USER_SET_VRING_BASE idx %d num 0x%x",
778 vui->hw_if_index, msg.state.index, msg.state.num);
779 if (msg.state.index >= VHOST_VRING_MAX_N)
781 vlib_worker_thread_barrier_sync (vm);
782 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
783 if (vhost_user_is_packed_ring_supported (vui))
787 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
788 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
789 * | last avail idx | | last used idx | |
790 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
793 * avail wrap counter used wrap counter
795 /* last avail idx at bit 0-14. */
796 vui->vrings[msg.state.index].last_avail_idx =
797 msg.state.num & 0x7fff;
798 /* avail wrap counter at bit 15 */
799 vui->vrings[msg.state.index].avail_wrap_counter =
800 ! !(msg.state.num & (1 << 15));
803 * Although last_used_idx is passed in the upper 16 bits in qemu
804 * implementation, in practice, last_avail_idx and last_used_idx are
805 * usually the same. As a result, DPDK does not bother to pass us
806 * last_used_idx. The spec is not clear on thex coding. I figured it
807 * out by reading the qemu code. So let's just read last_avail_idx
808 * and set last_used_idx equals to last_avail_idx.
810 vui->vrings[msg.state.index].last_used_idx =
811 vui->vrings[msg.state.index].last_avail_idx;
812 vui->vrings[msg.state.index].used_wrap_counter =
813 vui->vrings[msg.state.index].avail_wrap_counter;
815 if (vui->vrings[msg.state.index].avail_wrap_counter == 1)
816 vui->vrings[msg.state.index].avail_wrap_counter =
819 vlib_worker_thread_barrier_release (vm);
822 case VHOST_USER_GET_VRING_BASE:
823 if (msg.state.index >= VHOST_VRING_MAX_N)
825 vu_log_debug (vui, "invalid vring index VHOST_USER_GET_VRING_BASE:"
826 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
830 /* protection is needed to prevent rx/tx from changing last_avail_idx */
831 vlib_worker_thread_barrier_sync (vm);
833 * Copy last_avail_idx from the vring before closing it because
834 * closing the vring also initializes the vring last_avail_idx
836 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
837 if (vhost_user_is_packed_ring_supported (vui))
840 (vui->vrings[msg.state.index].last_avail_idx & 0x7fff) |
841 (! !vui->vrings[msg.state.index].avail_wrap_counter << 15);
843 ((vui->vrings[msg.state.index].last_used_idx & 0x7fff) |
844 (! !vui->vrings[msg.state.index].used_wrap_counter << 15)) << 16;
847 msg.size = sizeof (msg.state);
850 * Spec says: Client must [...] stop ring upon receiving
851 * VHOST_USER_GET_VRING_BASE
853 vhost_user_vring_close (vui, msg.state.index);
854 vlib_worker_thread_barrier_release (vm);
856 "if %d msg VHOST_USER_GET_VRING_BASE idx %d num 0x%x",
857 vui->hw_if_index, msg.state.index, msg.state.num);
859 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
860 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
862 vu_log_debug (vui, "could not send message response");
865 vhost_user_update_iface_state (vui);
868 case VHOST_USER_NONE:
869 vu_log_debug (vui, "if %d msg VHOST_USER_NONE", vui->hw_if_index);
872 case VHOST_USER_SET_LOG_BASE:
873 vu_log_debug (vui, "if %d msg VHOST_USER_SET_LOG_BASE",
876 if (msg.size != sizeof (msg.log))
878 vu_log_debug (vui, "invalid msg size for VHOST_USER_SET_LOG_BASE:"
879 " %d instead of %d", msg.size, sizeof (msg.log));
883 if (!(vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
885 vu_log_debug (vui, "VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but "
886 "VHOST_USER_SET_LOG_BASE received");
891 /* align size to page */
892 long page_sz = get_huge_page_size (fd);
894 (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
896 void *log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
899 vu_log_debug (vui, "map log region addr 0 len 0x%lx off 0x%lx fd %d "
900 "mapped 0x%lx", map_sz, msg.log.offset, fd,
903 if (log_base_addr == MAP_FAILED)
905 vu_log_err (vui, "failed to map memory. errno is %d", errno);
909 vlib_worker_thread_barrier_sync (vm);
910 vui->log_base_addr = log_base_addr;
911 vui->log_base_addr += msg.log.offset;
912 vui->log_size = msg.log.size;
913 vlib_worker_thread_barrier_release (vm);
916 msg.size = sizeof (msg.u64);
918 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
919 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
921 vu_log_debug (vui, "could not send message response");
926 case VHOST_USER_SET_LOG_FD:
927 vu_log_debug (vui, "if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
930 case VHOST_USER_GET_PROTOCOL_FEATURES:
932 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
933 (1 << VHOST_USER_PROTOCOL_F_MQ);
934 msg.size = sizeof (msg.u64);
935 vu_log_debug (vui, "if %d msg VHOST_USER_GET_PROTOCOL_FEATURES - "
936 "reply 0x%016llx", vui->hw_if_index, msg.u64);
938 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
939 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
941 vu_log_debug (vui, "could not send message response");
946 case VHOST_USER_SET_PROTOCOL_FEATURES:
947 vu_log_debug (vui, "if %d msg VHOST_USER_SET_PROTOCOL_FEATURES "
948 "features 0x%016llx", vui->hw_if_index, msg.u64);
949 vui->protocol_features = msg.u64;
952 case VHOST_USER_GET_QUEUE_NUM:
954 msg.u64 = VHOST_VRING_MAX_N;
955 msg.size = sizeof (msg.u64);
956 vu_log_debug (vui, "if %d msg VHOST_USER_GET_QUEUE_NUM - reply %d",
957 vui->hw_if_index, msg.u64);
959 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
960 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
962 vu_log_debug (vui, "could not send message response");
967 case VHOST_USER_SET_VRING_ENABLE:
968 vu_log_debug (vui, "if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
969 vui->hw_if_index, msg.state.num ? "enable" : "disable",
971 if (msg.state.index >= VHOST_VRING_MAX_N)
973 vu_log_debug (vui, "invalid vring idx VHOST_USER_SET_VRING_ENABLE:"
974 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
978 vui->vrings[msg.state.index].enabled = msg.state.num;
979 vhost_user_thread_placement (vui, msg.state.index);
980 vhost_user_update_iface_state (vui);
984 vu_log_debug (vui, "unknown vhost-user message %d received. "
985 "closing socket", msg.request);
992 vlib_worker_thread_barrier_sync (vm);
993 vhost_user_if_disconnect (vui);
994 vlib_worker_thread_barrier_release (vm);
995 vhost_user_update_iface_state (vui);
999 static clib_error_t *
1000 vhost_user_socket_error (clib_file_t * uf)
1002 vlib_main_t *vm = vlib_get_main ();
1003 vhost_user_main_t *vum = &vhost_user_main;
1004 vhost_user_intf_t *vui =
1005 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1007 vu_log_debug (vui, "socket error on if %d", vui->sw_if_index);
1008 vlib_worker_thread_barrier_sync (vm);
1009 vhost_user_if_disconnect (vui);
1010 vlib_worker_thread_barrier_release (vm);
1014 static clib_error_t *
1015 vhost_user_socksvr_accept_ready (clib_file_t * uf)
1017 int client_fd, client_len;
1018 struct sockaddr_un client;
1019 clib_file_t template = { 0 };
1020 vhost_user_main_t *vum = &vhost_user_main;
1021 vhost_user_intf_t *vui;
1023 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1025 client_len = sizeof (client);
1026 client_fd = accept (uf->file_descriptor,
1027 (struct sockaddr *) &client,
1028 (socklen_t *) & client_len);
1031 return clib_error_return_unix (0, "accept");
1033 if (vui->clib_file_index != ~0)
1035 vu_log_debug (vui, "Close client socket for vhost interface %d, fd %d",
1036 vui->sw_if_index, UNIX_GET_FD (vui->clib_file_index));
1037 clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
1040 vu_log_debug (vui, "New client socket for vhost interface %d, fd %d",
1041 vui->sw_if_index, client_fd);
1042 template.read_function = vhost_user_socket_read;
1043 template.error_function = vhost_user_socket_error;
1044 template.file_descriptor = client_fd;
1045 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1046 vui->clib_file_index = clib_file_add (&file_main, &template);
1050 static clib_error_t *
1051 vhost_user_init (vlib_main_t * vm)
1053 vhost_user_main_t *vum = &vhost_user_main;
1054 vlib_thread_main_t *tm = vlib_get_thread_main ();
1056 vum->log_default = vlib_log_register_class ("vhost-user", 0);
1058 vum->coalesce_frames = 32;
1059 vum->coalesce_time = 1e-3;
1061 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1064 vec_foreach (cpu, vum->cpus)
1066 /* This is actually not necessary as validate already zeroes it
1067 * Just keeping the loop here for later because I am lazy. */
1068 cpu->rx_buffers_len = 0;
1071 vum->random = random_default_seed ();
1073 mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
1079 VLIB_INIT_FUNCTION (vhost_user_init) =
1081 .runs_after = VLIB_INITS("ip4_init"),
1086 vhost_user_send_interrupt_process (vlib_main_t * vm,
1087 vlib_node_runtime_t * rt, vlib_frame_t * f)
1089 vhost_user_intf_t *vui;
1090 f64 timeout = 3153600000.0 /* 100 years */ ;
1091 uword event_type, *event_data = 0;
1092 vhost_user_main_t *vum = &vhost_user_main;
1094 f64 now, poll_time_remaining;
1100 poll_time_remaining =
1101 vlib_process_wait_for_event_or_clock (vm, timeout);
1102 event_type = vlib_process_get_events (vm, &event_data);
1103 vec_reset_length (event_data);
1106 * Use the remaining timeout if it is less than coalesce time to avoid
1107 * resetting the existing timer in the middle of expiration
1109 timeout = poll_time_remaining;
1110 if (vlib_process_suspend_time_is_zero (timeout) ||
1111 (timeout > vum->coalesce_time))
1112 timeout = vum->coalesce_time;
1114 now = vlib_time_now (vm);
1117 case VHOST_USER_EVENT_STOP_TIMER:
1121 case VHOST_USER_EVENT_START_TIMER:
1123 if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
1129 pool_foreach (vui, vum->vhost_user_interfaces) {
1130 next_timeout = timeout;
1131 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid += 2)
1133 vhost_user_vring_t *rxvq = &vui->vrings[qid];
1134 vhost_user_vring_t *txvq = &vui->vrings[qid + 1];
1136 if (txvq->qid == -1)
1138 if (txvq->n_since_last_int)
1140 if (now >= txvq->int_deadline)
1141 vhost_user_send_call (vm, txvq);
1143 next_timeout = txvq->int_deadline - now;
1146 if (rxvq->n_since_last_int)
1148 if (now >= rxvq->int_deadline)
1149 vhost_user_send_call (vm, rxvq);
1151 next_timeout = rxvq->int_deadline - now;
1154 if ((next_timeout < timeout) && (next_timeout > 0.0))
1155 timeout = next_timeout;
1162 clib_warning ("BUG: unhandled event type %d", event_type);
1165 /* No less than 1 millisecond */
1169 timeout = 3153600000.0;
1175 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node) = {
1176 .function = vhost_user_send_interrupt_process,
1177 .type = VLIB_NODE_TYPE_PROCESS,
1178 .name = "vhost-user-send-interrupt-process",
1183 vhost_user_process (vlib_main_t * vm,
1184 vlib_node_runtime_t * rt, vlib_frame_t * f)
1186 vhost_user_main_t *vum = &vhost_user_main;
1187 vhost_user_intf_t *vui;
1188 struct sockaddr_un sun;
1190 clib_file_t template = { 0 };
1191 f64 timeout = 3153600000.0 /* 100 years */ ;
1192 uword *event_data = 0;
1195 sun.sun_family = AF_UNIX;
1196 template.read_function = vhost_user_socket_read;
1197 template.error_function = vhost_user_socket_error;
1201 vlib_process_wait_for_event_or_clock (vm, timeout);
1202 vlib_process_get_events (vm, &event_data);
1203 vec_reset_length (event_data);
1208 pool_foreach (vui, vum->vhost_user_interfaces) {
1210 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
1211 if (vui->clib_file_index == ~0)
1214 ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
1217 * 1st time error or new error for this interface,
1218 * spit out the message and record the error
1220 if (!vui->sock_errno || (vui->sock_errno != errno))
1223 ("Error: Could not open unix socket for %s",
1224 vui->sock_filename);
1225 vui->sock_errno = errno;
1230 /* try to connect */
1231 strncpy (sun.sun_path, (char *) vui->sock_filename,
1232 sizeof (sun.sun_path) - 1);
1233 sun.sun_path[sizeof (sun.sun_path) - 1] = 0;
1235 /* Avoid hanging VPP if the other end does not accept */
1236 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
1237 clib_unix_warning ("fcntl");
1239 if (connect (sockfd, (struct sockaddr *) &sun,
1240 sizeof (struct sockaddr_un)) == 0)
1242 /* Set the socket to blocking as it was before */
1243 if (fcntl(sockfd, F_SETFL, 0) < 0)
1244 clib_unix_warning ("fcntl2");
1246 vui->sock_errno = 0;
1247 template.file_descriptor = sockfd;
1248 template.private_data =
1249 vui - vhost_user_main.vhost_user_interfaces;
1250 vui->clib_file_index = clib_file_add (&file_main, &template);
1252 /* This sockfd is considered consumed */
1257 vui->sock_errno = errno;
1262 /* check if socket is alive */
1264 socklen_t len = sizeof (error);
1265 int fd = UNIX_GET_FD(vui->clib_file_index);
1267 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
1271 vu_log_debug (vui, "getsockopt returned %d", retval);
1272 vhost_user_if_disconnect (vui);
1283 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
1284 .function = vhost_user_process,
1285 .type = VLIB_NODE_TYPE_PROCESS,
1286 .name = "vhost-user-process",
1291 * Disables and reset interface structure.
1292 * It can then be either init again, or removed from used interfaces.
1295 vhost_user_term_if (vhost_user_intf_t * vui)
1298 vhost_user_main_t *vum = &vhost_user_main;
1300 // disconnect interface sockets
1301 vhost_user_if_disconnect (vui);
1302 vhost_user_update_gso_interface_count (vui, 0 /* delete */ );
1303 vhost_user_update_iface_state (vui);
1305 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1307 // Remove existing queue mapping for the interface
1311 vnet_main_t *vnm = vnet_get_main ();
1312 vhost_user_vring_t *txvq = &vui->vrings[q];
1314 if (txvq->qid != -1)
1316 rv = vnet_hw_interface_unassign_rx_thread (vnm,
1320 vu_log_warn (vui, "unable to unassign interface %d, "
1321 "queue %d: rc=%d", vui->hw_if_index, q >> 1, rv);
1325 clib_mem_free ((void *) vui->vring_locks[q]);
1328 if (vui->unix_server_index != ~0)
1330 //Close server socket
1331 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
1332 vui->unix_server_index);
1333 clib_file_del (&file_main, uf);
1334 vui->unix_server_index = ~0;
1335 unlink (vui->sock_filename);
1338 mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
1343 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
1345 vhost_user_main_t *vum = &vhost_user_main;
1346 vhost_user_intf_t *vui;
1348 vnet_hw_interface_t *hwif;
1353 vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index))
1354 || hwif->dev_class_index != vhost_user_device_class.index)
1355 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1357 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1359 vu_log_debug (vui, "Deleting vhost-user interface %s (instance %d)",
1360 hwif->name, hwif->dev_instance);
1362 for (qid = 1; qid < VHOST_VRING_MAX_N / 2; qid += 2)
1364 vhost_user_vring_t *txvq = &vui->vrings[qid];
1366 if (txvq->qid == -1)
1368 if ((vum->ifq_count > 0) &&
1369 ((txvq->mode == VNET_HW_IF_RX_MODE_INTERRUPT) ||
1370 (txvq->mode == VNET_HW_IF_RX_MODE_ADAPTIVE)))
1373 // Stop the timer if there is no more interrupt interface/queue
1374 if ((vum->ifq_count == 0) &&
1375 (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
1377 vlib_process_signal_event (vm,
1378 vhost_user_send_interrupt_node.index,
1379 VHOST_USER_EVENT_STOP_TIMER, 0);
1385 // Disable and reset interface
1386 vhost_user_term_if (vui);
1388 // Reset renumbered iface
1389 if (hwif->dev_instance <
1390 vec_len (vum->show_dev_instance_by_real_dev_instance))
1391 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
1393 // Delete ethernet interface
1394 ethernet_delete_interface (vnm, vui->hw_if_index);
1397 pool_put (vum->vhost_user_interfaces, vui);
1402 static clib_error_t *
1403 vhost_user_exit (vlib_main_t * vm)
1405 vnet_main_t *vnm = vnet_get_main ();
1406 vhost_user_main_t *vum = &vhost_user_main;
1407 vhost_user_intf_t *vui;
1409 vlib_worker_thread_barrier_sync (vlib_get_main ());
1411 pool_foreach (vui, vum->vhost_user_interfaces) {
1412 vhost_user_delete_if (vnm, vm, vui->sw_if_index);
1415 vlib_worker_thread_barrier_release (vlib_get_main ());
1419 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
1422 * Open server unix socket on specified sock_filename.
1425 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
1428 struct sockaddr_un un = { };
1430 /* create listening socket */
1431 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1432 return VNET_API_ERROR_SYSCALL_ERROR_1;
1434 un.sun_family = AF_UNIX;
1435 strncpy ((char *) un.sun_path, (char *) sock_filename,
1436 sizeof (un.sun_path) - 1);
1438 /* remove if exists */
1439 unlink ((char *) sock_filename);
1441 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
1443 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1447 if (listen (fd, 1) == -1)
1449 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1462 * Create ethernet interface for vhost user interface.
1465 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
1466 vhost_user_intf_t * vui, u8 * hwaddress)
1468 vhost_user_main_t *vum = &vhost_user_main;
1470 clib_error_t *error;
1472 /* create hw and sw interface */
1475 clib_memcpy (hwaddr, hwaddress, 6);
1479 random_u32 (&vum->random);
1480 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
1485 error = ethernet_register_interface
1487 vhost_user_device_class.index,
1488 vui - vum->vhost_user_interfaces /* device instance */ ,
1489 hwaddr /* ethernet address */ ,
1490 &vui->hw_if_index, 0 /* flag change */ );
1493 clib_error_report (error);
1497 * Initialize vui with specified attributes
1500 vhost_user_vui_init (vnet_main_t * vnm,
1501 vhost_user_intf_t * vui,
1503 const char *sock_filename,
1504 u64 feature_mask, u32 * sw_if_index, u8 enable_gso,
1507 vnet_sw_interface_t *sw;
1509 vhost_user_main_t *vum = &vhost_user_main;
1510 vnet_hw_interface_t *hw;
1512 hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
1513 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
1514 if (server_sock_fd != -1)
1516 clib_file_t template = { 0 };
1517 template.read_function = vhost_user_socksvr_accept_ready;
1518 template.file_descriptor = server_sock_fd;
1519 template.private_data = vui - vum->vhost_user_interfaces; //hw index
1520 vui->unix_server_index = clib_file_add (&file_main, &template);
1524 vui->unix_server_index = ~0;
1527 vui->sw_if_index = sw->sw_if_index;
1528 strncpy (vui->sock_filename, sock_filename,
1529 ARRAY_LEN (vui->sock_filename) - 1);
1530 vui->sock_errno = 0;
1532 vui->feature_mask = feature_mask;
1533 vui->clib_file_index = ~0;
1534 vui->log_base_addr = 0;
1535 vui->if_index = vui - vum->vhost_user_interfaces;
1536 vui->enable_gso = enable_gso;
1537 vui->enable_packed = enable_packed;
1539 * enable_gso takes precedence over configurable feature mask if there
1541 * if feature mask disables gso, but enable_gso is configured,
1542 * then gso is enable
1543 * if feature mask enables gso, but enable_gso is not configured,
1544 * then gso is enable
1546 * if gso is enable via feature mask, it must enable both host and guest
1547 * gso feature mask, we don't support one sided GSO or partial GSO.
1549 if ((vui->enable_gso == 0) &&
1550 ((feature_mask & FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS) ==
1551 (FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS)))
1552 vui->enable_gso = 1;
1553 vhost_user_update_gso_interface_count (vui, 1 /* add */ );
1554 mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
1557 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1558 vhost_user_vring_init (vui, q);
1560 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1561 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
1564 *sw_if_index = vui->sw_if_index;
1566 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1568 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
1569 CLIB_CACHE_LINE_BYTES);
1570 clib_memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
1573 vec_validate (vui->per_cpu_tx_qid,
1574 vlib_get_thread_main ()->n_vlib_mains - 1);
1575 vhost_user_tx_thread_placement (vui);
1579 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
1580 const char *sock_filename,
1584 u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
1585 u8 enable_gso, u8 enable_packed)
1587 vhost_user_intf_t *vui = NULL;
1590 int server_sock_fd = -1;
1591 vhost_user_main_t *vum = &vhost_user_main;
1594 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1596 return VNET_API_ERROR_INVALID_ARGUMENT;
1599 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1604 vui = &vum->vhost_user_interfaces[*if_index];
1605 *sw_if_index = vui->sw_if_index;
1607 return VNET_API_ERROR_IF_ALREADY_EXISTS;
1613 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
1619 /* Protect the uninitialized vui from being dispatched by rx/tx */
1620 vlib_worker_thread_barrier_sync (vm);
1621 pool_get (vhost_user_main.vhost_user_interfaces, vui);
1622 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
1623 vlib_worker_thread_barrier_release (vm);
1625 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
1626 feature_mask, &sw_if_idx, enable_gso, enable_packed);
1627 vnet_sw_interface_set_mtu (vnm, vui->sw_if_index, 9000);
1628 vhost_user_rx_thread_placement (vui, 1);
1631 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1634 *sw_if_index = sw_if_idx;
1636 // Process node must connect
1637 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1643 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
1644 const char *sock_filename,
1647 u64 feature_mask, u8 renumber, u32 custom_dev_instance,
1648 u8 enable_gso, u8 enable_packed)
1650 vhost_user_main_t *vum = &vhost_user_main;
1651 vhost_user_intf_t *vui = NULL;
1653 int server_sock_fd = -1;
1655 vnet_hw_interface_t *hwif;
1660 vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index))
1661 || hwif->dev_class_index != vhost_user_device_class.index)
1662 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1664 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1665 return VNET_API_ERROR_INVALID_ARGUMENT;
1667 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1670 * Disallow changing the interface to have the same path name
1671 * as other interface
1673 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1674 if (if_index && (*if_index != vui->if_index))
1675 return VNET_API_ERROR_IF_ALREADY_EXISTS;
1677 // First try to open server socket
1679 if ((rv = vhost_user_init_server_sock (sock_filename,
1680 &server_sock_fd)) != 0)
1683 vhost_user_term_if (vui);
1684 vhost_user_vui_init (vnm, vui, server_sock_fd,
1685 sock_filename, feature_mask, &sw_if_idx, enable_gso,
1689 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1691 // Process node must connect
1692 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1698 vhost_user_connect_command_fn (vlib_main_t * vm,
1699 unformat_input_t * input,
1700 vlib_cli_command_t * cmd)
1702 unformat_input_t _line_input, *line_input = &_line_input;
1703 u8 *sock_filename = NULL;
1706 u64 feature_mask = (u64) ~ (0ULL);
1708 u32 custom_dev_instance = ~0;
1711 clib_error_t *error = NULL;
1712 u8 enable_gso = 0, enable_packed = 0;
1714 /* Get a line of input. */
1715 if (!unformat_user (input, unformat_line_input, line_input))
1718 /* GSO feature is disable by default */
1719 feature_mask &= ~FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
1720 /* packed-ring feature is disable by default */
1721 feature_mask &= ~VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
1722 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1724 if (unformat (line_input, "socket %s", &sock_filename))
1726 else if (unformat (line_input, "server"))
1728 else if (unformat (line_input, "gso"))
1730 else if (unformat (line_input, "packed"))
1732 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
1736 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
1738 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
1744 error = clib_error_return (0, "unknown input `%U'",
1745 format_unformat_error, line_input);
1750 vnet_main_t *vnm = vnet_get_main ();
1753 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
1754 is_server, &sw_if_index, feature_mask,
1755 renumber, custom_dev_instance, hw,
1756 enable_gso, enable_packed)))
1758 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
1762 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
1766 vec_free (sock_filename);
1767 unformat_free (line_input);
1773 vhost_user_delete_command_fn (vlib_main_t * vm,
1774 unformat_input_t * input,
1775 vlib_cli_command_t * cmd)
1777 unformat_input_t _line_input, *line_input = &_line_input;
1778 u32 sw_if_index = ~0;
1779 vnet_main_t *vnm = vnet_get_main ();
1780 clib_error_t *error = NULL;
1782 /* Get a line of input. */
1783 if (!unformat_user (input, unformat_line_input, line_input))
1786 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1788 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
1791 (line_input, "%U", unformat_vnet_sw_interface, vnm,
1794 vnet_hw_interface_t *hwif =
1795 vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
1797 vhost_user_device_class.index != hwif->dev_class_index)
1799 error = clib_error_return (0, "Not a vhost interface");
1805 error = clib_error_return (0, "unknown input `%U'",
1806 format_unformat_error, line_input);
1811 vhost_user_delete_if (vnm, vm, sw_if_index);
1814 unformat_free (line_input);
1820 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
1821 vhost_user_intf_details_t ** out_vuids)
1824 vhost_user_main_t *vum = &vhost_user_main;
1825 vhost_user_intf_t *vui;
1826 vhost_user_intf_details_t *r_vuids = NULL;
1827 vhost_user_intf_details_t *vuid = NULL;
1828 u32 *hw_if_indices = 0;
1829 vnet_hw_interface_t *hi;
1835 pool_foreach (vui, vum->vhost_user_interfaces)
1836 vec_add1 (hw_if_indices, vui->hw_if_index);
1838 for (i = 0; i < vec_len (hw_if_indices); i++)
1840 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1841 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
1843 vec_add2 (r_vuids, vuid, 1);
1844 vuid->sw_if_index = vui->sw_if_index;
1845 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
1846 vuid->features = vui->features;
1847 vuid->num_regions = vui->nregions;
1848 vuid->is_server = vui->unix_server_index != ~0;
1849 vuid->sock_errno = vui->sock_errno;
1850 snprintf ((char *) vuid->sock_filename, sizeof (vuid->sock_filename),
1851 "%s", vui->sock_filename);
1852 memcpy_s (vuid->if_name, sizeof (vuid->if_name), hi->name,
1853 clib_min (vec_len (hi->name), sizeof (vuid->if_name) - 1));
1854 vuid->if_name[sizeof (vuid->if_name) - 1] = 0;
1857 vec_free (hw_if_indices);
1859 *out_vuids = r_vuids;
1865 format_vhost_user_desc (u8 * s, va_list * args)
1867 char *fmt = va_arg (*args, char *);
1868 vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1869 vring_desc_t *desc_table = va_arg (*args, vring_desc_t *);
1870 int idx = va_arg (*args, int);
1871 u32 *mem_hint = va_arg (*args, u32 *);
1873 s = format (s, fmt, idx, desc_table[idx].addr, desc_table[idx].len,
1874 desc_table[idx].flags, desc_table[idx].next,
1875 pointer_to_uword (map_guest_mem (vui, desc_table[idx].addr,
1881 format_vhost_user_vring (u8 * s, va_list * args)
1883 char *fmt = va_arg (*args, char *);
1884 vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1885 int q = va_arg (*args, int);
1887 s = format (s, fmt, vui->vrings[q].avail->flags, vui->vrings[q].avail->idx,
1888 vui->vrings[q].used->flags, vui->vrings[q].used->idx);
1893 vhost_user_show_fds (vlib_main_t * vm, vhost_user_intf_t * vui, int q)
1895 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
1896 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
1898 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n", kickfd, callfd,
1899 vui->vrings[q].errfd);
1903 vhost_user_show_desc (vlib_main_t * vm, vhost_user_intf_t * vui, int q,
1904 int show_descr, int show_verbose)
1910 vring_desc_t *desc_table;
1912 if (vui->vrings[q].avail && vui->vrings[q].used)
1913 vlib_cli_output (vm, "%U", format_vhost_user_vring,
1914 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
1917 vhost_user_show_fds (vm, vui, q);
1921 vlib_cli_output (vm, "\n descriptor table:\n");
1922 vlib_cli_output (vm,
1923 " slot addr len flags next "
1925 vlib_cli_output (vm,
1926 " ===== ================== ===== ====== ===== "
1927 "==================\n");
1928 for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
1930 desc_table = vui->vrings[q].desc;
1931 vlib_cli_output (vm, "%U", format_vhost_user_desc,
1932 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n", vui,
1933 desc_table, j, &mem_hint);
1934 if (show_verbose && (desc_table[j].flags & VRING_DESC_F_INDIRECT))
1936 n_entries = desc_table[j].len / sizeof (vring_desc_t);
1937 desc_table = map_guest_mem (vui, desc_table[j].addr, &mem_hint);
1940 for (idx = 0; idx < clib_min (20, n_entries); idx++)
1943 (vm, "%U", format_vhost_user_desc,
1944 "> %-4u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
1945 desc_table, idx, &mem_hint);
1947 if (n_entries >= 20)
1948 vlib_cli_output (vm, "Skip displaying entries 20...%u\n",
1957 format_vhost_user_packed_desc (u8 * s, va_list * args)
1959 char *fmt = va_arg (*args, char *);
1960 vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1961 vring_packed_desc_t *desc_table = va_arg (*args, vring_packed_desc_t *);
1962 int idx = va_arg (*args, int);
1963 u32 *mem_hint = va_arg (*args, u32 *);
1965 s = format (s, fmt, idx, desc_table[idx].addr, desc_table[idx].len,
1966 desc_table[idx].flags, desc_table[idx].id,
1967 pointer_to_uword (map_guest_mem (vui, desc_table[idx].addr,
1973 format_vhost_user_vring_packed (u8 * s, va_list * args)
1975 char *fmt = va_arg (*args, char *);
1976 vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1977 int q = va_arg (*args, int);
1979 s = format (s, fmt, vui->vrings[q].avail_event->flags,
1980 vui->vrings[q].avail_event->off_wrap,
1981 vui->vrings[q].used_event->flags,
1982 vui->vrings[q].used_event->off_wrap,
1983 vui->vrings[q].avail_wrap_counter,
1984 vui->vrings[q].used_wrap_counter);
1989 vhost_user_show_desc_packed (vlib_main_t * vm, vhost_user_intf_t * vui, int q,
1990 int show_descr, int show_verbose)
1996 vring_packed_desc_t *desc_table;
1998 if (vui->vrings[q].avail_event && vui->vrings[q].used_event)
1999 vlib_cli_output (vm, "%U", format_vhost_user_vring_packed,
2000 " avail_event.flags %x avail_event.off_wrap %u "
2001 "used_event.flags %x used_event.off_wrap %u\n"
2002 " avail wrap counter %u, used wrap counter %u\n",
2005 vhost_user_show_fds (vm, vui, q);
2009 vlib_cli_output (vm, "\n descriptor table:\n");
2010 vlib_cli_output (vm,
2011 " slot addr len flags id "
2013 vlib_cli_output (vm,
2014 " ===== ================== ===== ====== ===== "
2015 "==================\n");
2016 for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
2018 desc_table = vui->vrings[q].packed_desc;
2019 vlib_cli_output (vm, "%U", format_vhost_user_packed_desc,
2020 " %-5u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
2021 desc_table, j, &mem_hint);
2022 if (show_verbose && (desc_table[j].flags & VRING_DESC_F_INDIRECT))
2024 n_entries = desc_table[j].len >> 4;
2025 desc_table = map_guest_mem (vui, desc_table[j].addr, &mem_hint);
2028 for (idx = 0; idx < clib_min (20, n_entries); idx++)
2031 (vm, "%U", format_vhost_user_packed_desc,
2032 "> %-4u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
2033 desc_table, idx, &mem_hint);
2035 if (n_entries >= 20)
2036 vlib_cli_output (vm, "Skip displaying entries 20...%u\n",
2045 show_vhost_user_command_fn (vlib_main_t * vm,
2046 unformat_input_t * input,
2047 vlib_cli_command_t * cmd)
2049 clib_error_t *error = 0;
2050 vnet_main_t *vnm = vnet_get_main ();
2051 vhost_user_main_t *vum = &vhost_user_main;
2052 vhost_user_intf_t *vui;
2053 u32 hw_if_index, *hw_if_indices = 0;
2054 vnet_hw_interface_t *hi;
2059 int show_verbose = 0;
2065 struct feat_struct *feat_entry;
2067 static struct feat_struct feat_array[] = {
2068 #define _(s,b) { .str = #s, .bit = b, },
2069 foreach_virtio_net_features
2074 #define foreach_protocol_feature \
2075 _(VHOST_USER_PROTOCOL_F_MQ) \
2076 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
2078 static struct feat_struct proto_feat_array[] = {
2079 #define _(s) { .str = #s, .bit = s},
2080 foreach_protocol_feature
2085 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2088 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
2090 hi = vnet_get_hw_interface (vnm, hw_if_index);
2091 if (vhost_user_device_class.index != hi->dev_class_index)
2093 error = clib_error_return (0, "unknown input `%U'",
2094 format_unformat_error, input);
2097 vec_add1 (hw_if_indices, hw_if_index);
2099 else if (unformat (input, "descriptors") || unformat (input, "desc"))
2101 else if (unformat (input, "verbose"))
2105 error = clib_error_return (0, "unknown input `%U'",
2106 format_unformat_error, input);
2110 if (vec_len (hw_if_indices) == 0)
2112 pool_foreach (vui, vum->vhost_user_interfaces)
2113 vec_add1 (hw_if_indices, vui->hw_if_index);
2115 vlib_cli_output (vm, "Virtio vhost-user interfaces");
2116 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
2117 vum->coalesce_frames, vum->coalesce_time);
2118 vlib_cli_output (vm, " Number of rx virtqueues in interrupt mode: %d",
2120 vlib_cli_output (vm, " Number of GSO interfaces: %d", vum->gso_count);
2122 for (i = 0; i < vec_len (hw_if_indices); i++)
2124 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2125 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2126 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
2127 format_vnet_hw_if_index_name, vnm, hw_if_indices[i],
2129 if (vui->enable_gso)
2130 vlib_cli_output (vm, " GSO enable");
2131 if (vui->enable_packed)
2132 vlib_cli_output (vm, " Packed ring enable");
2134 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
2135 " features mask (0x%llx): \n"
2136 " features (0x%llx): \n",
2137 vui->virtio_net_hdr_sz, vui->feature_mask,
2140 feat_entry = (struct feat_struct *) &feat_array;
2141 while (feat_entry->str)
2143 if (vui->features & (1ULL << feat_entry->bit))
2144 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
2149 vlib_cli_output (vm, " protocol features (0x%llx)",
2150 vui->protocol_features);
2151 feat_entry = (struct feat_struct *) &proto_feat_array;
2152 while (feat_entry->str)
2154 if (vui->protocol_features & (1ULL << feat_entry->bit))
2155 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
2160 vlib_cli_output (vm, "\n");
2162 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
2164 (vui->unix_server_index != ~0) ? "server" : "client",
2165 strerror (vui->sock_errno));
2167 vlib_cli_output (vm, " rx placement: ");
2169 for (qid = 1; qid < VHOST_VRING_MAX_N / 2; qid += 2)
2171 vnet_main_t *vnm = vnet_get_main ();
2173 vnet_hw_if_rx_mode mode;
2174 vhost_user_vring_t *txvq = &vui->vrings[qid];
2176 if (txvq->qid == -1)
2179 vnet_get_device_input_thread_index (vnm, vui->hw_if_index,
2181 vnet_hw_interface_get_rx_mode (vnm, vui->hw_if_index, qid >> 1,
2183 vlib_cli_output (vm, " thread %d on vring %d, %U\n",
2185 format_vnet_hw_if_rx_mode, mode);
2188 vlib_cli_output (vm, " tx placement: %s\n",
2189 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
2191 vec_foreach_index (ci, vui->per_cpu_tx_qid)
2193 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
2194 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
2197 vlib_cli_output (vm, "\n");
2199 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
2203 vlib_cli_output (vm,
2204 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
2205 vlib_cli_output (vm,
2206 " ====== ===== ================== ================== ================== ================== ==================\n");
2208 for (j = 0; j < vui->nregions; j++)
2210 vlib_cli_output (vm,
2211 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
2212 j, vui->region_mmap_fd[j],
2213 vui->regions[j].guest_phys_addr,
2214 vui->regions[j].memory_size,
2215 vui->regions[j].userspace_addr,
2216 vui->regions[j].mmap_offset,
2217 pointer_to_uword (vui->region_mmap_addr[j]));
2219 for (q = 0; q < VHOST_VRING_MAX_N; q++)
2221 if (!vui->vrings[q].started)
2224 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
2225 (q & 1) ? "RX" : "TX",
2226 vui->vrings[q].enabled ? "" : " disabled");
2228 vlib_cli_output (vm,
2229 " qsz %d last_avail_idx %d last_used_idx %d\n",
2230 vui->vrings[q].qsz_mask + 1,
2231 vui->vrings[q].last_avail_idx,
2232 vui->vrings[q].last_used_idx);
2234 if (vhost_user_is_packed_ring_supported (vui))
2235 vhost_user_show_desc_packed (vm, vui, q, show_descr,
2238 vhost_user_show_desc (vm, vui, q, show_descr, show_verbose);
2240 vlib_cli_output (vm, "\n");
2243 vec_free (hw_if_indices);
2252 * Create a vHost User interface. Once created, a new virtual interface
2253 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
2254 * is the next free index.
2256 * There are several parameters associated with a vHost interface:
2258 * - <b>socket <socket-filename></b> - Name of the linux socket used by hypervisor
2259 * and VPP to manage the vHost interface. If in '<em>server</em>' mode, VPP will
2260 * create the socket if it does not already exist. If in '<em>client</em>' mode,
2261 * hypervisor will create the socket if it does not already exist. The VPP code
2262 * is indifferent to the file location. However, if SELinux is enabled, then the
2263 * socket needs to be created in '<em>/var/run/vpp/</em>'.
2265 * - <b>server</b> - Optional flag to indicate that VPP should be the server for
2266 * the linux socket. If not provided, VPP will be the client. In '<em>server</em>'
2267 * mode, the VM can be reset without tearing down the vHost Interface. In
2268 * '<em>client</em>' mode, VPP can be reset without bringing down the VM and
2269 * tearing down the vHost Interface.
2271 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
2272 * startup. <b>This is intended for degugging only.</b> It is recommended that this
2273 * parameter not be used except by experienced users. By default, all supported
2274 * features will be advertised. Otherwise, provide the set of features desired.
2275 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
2276 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
2277 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
2278 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
2279 * - 0x004000000 (26) - VHOST_F_LOG_ALL
2280 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
2281 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
2282 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
2283 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
2285 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
2286 * X:X:X:X:X:X unix or X.X.X cisco format.
2288 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
2289 * in the name to be specified. If instance already exists, name will be used
2290 * anyway and multiple instances will have the same name. Use with caution.
2293 * Example of how to create a vhost interface with VPP as the client and all features enabled:
2294 * @cliexstart{create vhost-user socket /var/run/vpp/vhost1.sock}
2295 * VirtualEthernet0/0/0
2297 * Example of how to create a vhost interface with VPP as the server and with just
2298 * multiple queues enabled:
2299 * @cliexstart{create vhost-user socket /var/run/vpp/vhost2.sock server feature-mask 0x40400000}
2300 * VirtualEthernet0/0/1
2302 * Once the vHost interface is created, enable the interface using:
2303 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
2306 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
2307 .path = "create vhost-user",
2308 .short_help = "create vhost-user socket <socket-filename> [server] "
2309 "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] [gso] "
2311 .function = vhost_user_connect_command_fn,
2317 * Delete a vHost User interface using the interface name or the
2318 * software interface index. Use the '<em>show interface</em>'
2319 * command to determine the software interface index. On deletion,
2320 * the linux socket will not be deleted.
2323 * Example of how to delete a vhost interface by name:
2324 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
2325 * Example of how to delete a vhost interface by software interface index:
2326 * @cliexcmd{delete vhost-user sw_if_index 1}
2329 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
2330 .path = "delete vhost-user",
2331 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
2332 .function = vhost_user_delete_command_fn,
2336 * Display the attributes of a single vHost User interface (provide interface
2337 * name), multiple vHost User interfaces (provide a list of interface names seperated
2338 * by spaces) or all Vhost User interfaces (omit an interface name to display all
2339 * vHost interfaces).
2343 * Example of how to display a vhost interface:
2344 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
2345 * Virtio vhost-user interfaces
2347 * coalesce frames 32 time 1e-3
2348 * Interface: VirtualEthernet0/0/0 (ifindex 1)
2349 * virtio_net_hdr_sz 12
2350 * features mask (0xffffffffffffffff):
2351 * features (0x50408000):
2352 * VIRTIO_NET_F_MRG_RXBUF (15)
2353 * VIRTIO_NET_F_MQ (22)
2354 * VIRTIO_F_INDIRECT_DESC (28)
2355 * VHOST_USER_F_PROTOCOL_FEATURES (30)
2356 * protocol features (0x3)
2357 * VHOST_USER_PROTOCOL_F_MQ (0)
2358 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
2360 * socket filename /var/run/vpp/vhost1.sock type client errno "Success"
2363 * thread 1 on vring 1
2364 * thread 1 on vring 5
2365 * thread 2 on vring 3
2366 * thread 2 on vring 7
2367 * tx placement: spin-lock
2368 * thread 0 on vring 0
2369 * thread 1 on vring 2
2370 * thread 2 on vring 0
2372 * Memory regions (total 2)
2373 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
2374 * ====== ===== ================== ================== ================== ================== ==================
2375 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
2376 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
2379 * qsz 256 last_avail_idx 0 last_used_idx 0
2380 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2381 * kickfd 62 callfd 64 errfd -1
2384 * qsz 256 last_avail_idx 0 last_used_idx 0
2385 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2386 * kickfd 65 callfd 66 errfd -1
2389 * qsz 256 last_avail_idx 0 last_used_idx 0
2390 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2391 * kickfd 63 callfd 70 errfd -1
2394 * qsz 256 last_avail_idx 0 last_used_idx 0
2395 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2396 * kickfd 72 callfd 74 errfd -1
2398 * Virtqueue 4 (TX disabled)
2399 * qsz 256 last_avail_idx 0 last_used_idx 0
2400 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2401 * kickfd 76 callfd 78 errfd -1
2403 * Virtqueue 5 (RX disabled)
2404 * qsz 256 last_avail_idx 0 last_used_idx 0
2405 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2406 * kickfd 80 callfd 82 errfd -1
2408 * Virtqueue 6 (TX disabled)
2409 * qsz 256 last_avail_idx 0 last_used_idx 0
2410 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2411 * kickfd 84 callfd 86 errfd -1
2413 * Virtqueue 7 (RX disabled)
2414 * qsz 256 last_avail_idx 0 last_used_idx 0
2415 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2416 * kickfd 88 callfd 90 errfd -1
2420 * The optional '<em>descriptors</em>' parameter will display the same output as
2421 * the previous example but will include the descriptor table for each queue.
2422 * The output is truncated below:
2423 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
2424 * Virtio vhost-user interfaces
2426 * coalesce frames 32 time 1e-3
2427 * Interface: VirtualEthernet0/0/0 (ifindex 1)
2428 * virtio_net_hdr_sz 12
2429 * features mask (0xffffffffffffffff):
2430 * features (0x50408000):
2431 * VIRTIO_NET_F_MRG_RXBUF (15)
2432 * VIRTIO_NET_F_MQ (22)
2435 * qsz 256 last_avail_idx 0 last_used_idx 0
2436 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2437 * kickfd 62 callfd 64 errfd -1
2440 * id addr len flags next user_addr
2441 * ===== ================== ===== ====== ===== ==================
2442 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
2443 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
2444 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
2445 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
2446 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
2447 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
2448 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
2449 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
2450 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
2451 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
2452 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
2454 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
2455 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
2456 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
2457 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
2458 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
2459 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
2460 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
2463 * qsz 256 last_avail_idx 0 last_used_idx 0
2469 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
2470 .path = "show vhost-user",
2471 .short_help = "show vhost-user [<interface> [<interface> [..]]] "
2472 "[[descriptors] [verbose]]",
2473 .function = show_vhost_user_command_fn,
2478 static clib_error_t *
2479 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
2481 vhost_user_main_t *vum = &vhost_user_main;
2483 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2485 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
2487 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
2489 else if (unformat (input, "dont-dump-memory"))
2490 vum->dont_dump_vhost_user_memory = 1;
2492 return clib_error_return (0, "unknown input `%U'",
2493 format_unformat_error, input);
2499 /* vhost-user { ... } configuration. */
2500 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
2503 vhost_user_unmap_all (void)
2505 vhost_user_main_t *vum = &vhost_user_main;
2506 vhost_user_intf_t *vui;
2508 if (vum->dont_dump_vhost_user_memory)
2510 pool_foreach (vui, vum->vhost_user_interfaces)
2511 unmap_all_mem_regions (vui);
2516 * fd.io coding-style-patch-verification: ON
2519 * eval: (c-set-style "gnu")