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/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>
43 #include <vnet/devices/virtio/vhost_user_inline.h>
47 * @brief vHost User Device Driver.
49 * This file contains the source code for vHost User interface.
53 vlib_node_registration_t vhost_user_send_interrupt_node;
56 vhost_user_main_t vhost_user_main = {
60 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
66 get_huge_page_size (int fd)
74 unmap_all_mem_regions (vhost_user_intf_t * vui)
77 vhost_user_vring_t *vq;
79 for (i = 0; i < vui->nregions; i++)
81 if (vui->region_mmap_addr[i] != MAP_FAILED)
84 long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
86 ssize_t map_sz = (vui->regions[i].memory_size +
87 vui->regions[i].mmap_offset +
88 page_sz - 1) & ~(page_sz - 1);
91 munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
95 ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
96 vui->region_mmap_addr[i], map_sz, page_sz);
98 vui->region_mmap_addr[i] = MAP_FAILED;
102 clib_warning ("failed to unmap memory region (errno %d)",
105 close (vui->region_mmap_fd[i]);
110 for (q = 0; q < VHOST_VRING_MAX_N; q++)
112 vq = &vui->vrings[q];
120 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
122 //Let's try to assign one queue to each thread
124 u32 thread_index = 0;
125 vui->use_tx_spinlock = 0;
128 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
130 vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
131 if (!rxvq->started || !rxvq->enabled)
134 vui->per_cpu_tx_qid[thread_index] = qid;
136 if (thread_index == vlib_get_thread_main ()->n_vlib_mains)
139 //We need to loop, meaning the spinlock has to be used
140 vui->use_tx_spinlock = 1;
141 if (thread_index == 0)
143 //Could not find a single valid one
144 for (thread_index = 0;
145 thread_index < vlib_get_thread_main ()->n_vlib_mains;
148 vui->per_cpu_tx_qid[thread_index] = 0;
156 * @brief Unassign existing interface/queue to thread mappings and re-assign
157 * new interface/queue to thread mappings
160 vhost_user_rx_thread_placement ()
162 vhost_user_main_t *vum = &vhost_user_main;
163 vhost_user_intf_t *vui;
164 vhost_user_vring_t *txvq;
165 vnet_main_t *vnm = vnet_get_main ();
170 // Scrap all existing mappings for all interfaces/queues
172 pool_foreach (vui, vum->vhost_user_interfaces, {
173 vec_foreach (queue, vui->rx_queues)
175 rv = vnet_hw_interface_unassign_rx_thread (vnm, vui->hw_if_index,
178 clib_warning ("Warning: unable to unassign interface %d, "
179 "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
181 vec_reset_length (vui->rx_queues);
185 // Create the rx_queues for all interfaces
187 pool_foreach (vui, vum->vhost_user_interfaces, {
188 for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
190 txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
193 if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
194 /* Set polling as the default */
195 txvq->mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
196 vec_add1 (vui->rx_queues, qid);
202 // Assign new mappings for all interfaces/queues
204 pool_foreach (vui, vum->vhost_user_interfaces, {
205 vnet_hw_interface_set_input_node (vnm, vui->hw_if_index,
206 vhost_user_input_node.index);
207 vec_foreach (queue, vui->rx_queues)
209 vnet_hw_interface_assign_rx_thread (vnm, vui->hw_if_index, *queue,
211 txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
212 rv = vnet_hw_interface_set_rx_mode (vnm, vui->hw_if_index, *queue,
215 clib_warning ("Warning: unable to set rx mode for interface %d, "
216 "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
222 /** @brief Returns whether at least one TX and one RX vring are enabled */
223 static_always_inline int
224 vhost_user_intf_ready (vhost_user_intf_t * vui)
226 int i, found[2] = { }; //RX + TX
228 for (i = 0; i < VHOST_VRING_MAX_N; i++)
229 if (vui->vrings[i].started && vui->vrings[i].enabled)
232 return found[0] && found[1];
236 vhost_user_update_iface_state (vhost_user_intf_t * vui)
238 /* if we have pointers to descriptor table, go up */
239 int is_up = vhost_user_intf_ready (vui);
240 if (is_up != vui->is_up)
242 DBG_SOCK ("interface %d %s", vui->sw_if_index,
243 is_up ? "ready" : "down");
244 vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
245 is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
249 vhost_user_rx_thread_placement ();
250 vhost_user_tx_thread_placement (vui);
254 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
257 vnet_main_t *vnm = vnet_get_main ();
261 /* Only care about the odd number, or TX, virtqueue */
264 if (vhost_user_intf_ready (vui))
265 // qid >> 1 is to convert virtqueue number to vring queue index
266 vnet_device_input_set_interrupt_pending (vnm, vui->hw_if_index, qid >> 1);
269 static clib_error_t *
270 vhost_user_callfd_read_ready (clib_file_t * uf)
272 __attribute__ ((unused)) int n;
275 n = read (uf->file_descriptor, ((char *) &buff), 8);
280 static clib_error_t *
281 vhost_user_kickfd_read_ready (clib_file_t * uf)
283 __attribute__ ((unused)) int n;
285 vhost_user_intf_t *vui =
286 pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
287 uf->private_data >> 8);
288 u32 qid = uf->private_data & 0xff;
290 n = read (uf->file_descriptor, ((char *) &buff), 8);
291 DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
292 if (!vui->vrings[qid].started ||
293 (vhost_user_intf_ready (vui) != vui->is_up))
295 vlib_worker_thread_barrier_sync (vlib_get_main ());
296 vui->vrings[qid].started = 1;
297 vhost_user_update_iface_state (vui);
298 vlib_worker_thread_barrier_release (vlib_get_main ());
301 vhost_user_set_interrupt_pending (vui, uf->private_data);
305 static_always_inline void
306 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
308 vhost_user_vring_t *vring = &vui->vrings[qid];
309 memset (vring, 0, sizeof (*vring));
310 vring->kickfd_idx = ~0;
311 vring->callfd_idx = ~0;
315 * We have a bug with some qemu 2.5, and this may be a fix.
316 * Feel like interpretation holy text, but this is from vhost-user.txt.
318 * One queue pair is enabled initially. More queues are enabled
319 * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
321 * Don't know who's right, but this is what DPDK does.
323 if (qid == 0 || qid == 1)
327 static_always_inline void
328 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
330 vhost_user_vring_t *vring = &vui->vrings[qid];
331 if (vring->kickfd_idx != ~0)
333 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
335 clib_file_del (&file_main, uf);
336 vring->kickfd_idx = ~0;
338 if (vring->callfd_idx != ~0)
340 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
342 clib_file_del (&file_main, uf);
343 vring->callfd_idx = ~0;
345 if (vring->errfd != -1)
347 close (vring->errfd);
350 vhost_user_vring_init (vui, qid);
353 static_always_inline void
354 vhost_user_if_disconnect (vhost_user_intf_t * vui)
356 vnet_main_t *vnm = vnet_get_main ();
359 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
361 if (vui->clib_file_index != ~0)
363 clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
364 vui->clib_file_index = ~0;
369 for (q = 0; q < VHOST_VRING_MAX_N; q++)
370 vhost_user_vring_close (vui, q);
372 unmap_all_mem_regions (vui);
373 DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
376 static clib_error_t *
377 vhost_user_socket_read (clib_file_t * uf)
380 int fd, number_of_fds = 0;
381 int fds[VHOST_MEMORY_MAX_NREGIONS];
382 vhost_user_msg_t msg;
385 vhost_user_main_t *vum = &vhost_user_main;
386 vhost_user_intf_t *vui;
387 struct cmsghdr *cmsg;
389 clib_file_t template = { 0 };
390 vnet_main_t *vnm = vnet_get_main ();
392 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
394 char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
396 memset (&mh, 0, sizeof (mh));
397 memset (control, 0, sizeof (control));
399 for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
402 /* set the payload */
403 iov[0].iov_base = (void *) &msg;
404 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
408 mh.msg_control = control;
409 mh.msg_controllen = sizeof (control);
411 n = recvmsg (uf->file_descriptor, &mh, 0);
413 /* Stop workers to avoid end of the world */
414 vlib_worker_thread_barrier_sync (vlib_get_main ());
416 if (n != VHOST_USER_MSG_HDR_SZ)
420 DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
424 DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
425 n, VHOST_USER_MSG_HDR_SZ);
430 if (mh.msg_flags & MSG_CTRUNC)
432 DBG_SOCK ("MSG_CTRUNC is set");
436 cmsg = CMSG_FIRSTHDR (&mh);
438 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
439 (cmsg->cmsg_type == SCM_RIGHTS) &&
440 (cmsg->cmsg_len - CMSG_LEN (0) <=
441 VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
443 number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
444 clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
447 /* version 1, no reply bit set */
448 if ((msg.flags & 7) != 1)
450 DBG_SOCK ("malformed message received. closing socket");
457 read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
461 DBG_SOCK ("read failed %s", strerror (errno));
464 else if (rv != msg.size)
466 DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
473 case VHOST_USER_GET_FEATURES:
475 msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
476 (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
477 (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
478 (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
479 (1ULL << FEAT_VHOST_F_LOG_ALL) |
480 (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
481 (1ULL << FEAT_VIRTIO_NET_F_MQ) |
482 (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
483 (1ULL << FEAT_VIRTIO_F_VERSION_1);
484 msg.u64 &= vui->feature_mask;
485 msg.size = sizeof (msg.u64);
486 DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
487 vui->hw_if_index, msg.u64);
490 case VHOST_USER_SET_FEATURES:
491 DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
492 vui->hw_if_index, msg.u64);
494 vui->features = msg.u64;
497 ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
498 (1ULL << FEAT_VIRTIO_F_VERSION_1)))
499 vui->virtio_net_hdr_sz = 12;
501 vui->virtio_net_hdr_sz = 10;
504 (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
506 ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
507 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
510 /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
511 vhost_user_vring_close(&vui->vrings[q]); */
515 case VHOST_USER_SET_MEM_TABLE:
516 DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
517 vui->hw_if_index, msg.memory.nregions);
519 if ((msg.memory.nregions < 1) ||
520 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
523 DBG_SOCK ("number of mem regions must be between 1 and %i",
524 VHOST_MEMORY_MAX_NREGIONS);
529 if (msg.memory.nregions != number_of_fds)
531 DBG_SOCK ("each memory region must have FD");
534 unmap_all_mem_regions (vui);
535 for (i = 0; i < msg.memory.nregions; i++)
537 clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
538 sizeof (vhost_user_memory_region_t));
540 long page_sz = get_huge_page_size (fds[i]);
542 /* align size to page */
543 ssize_t map_sz = (vui->regions[i].memory_size +
544 vui->regions[i].mmap_offset +
545 page_sz - 1) & ~(page_sz - 1);
547 vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
548 MAP_SHARED, fds[i], 0);
549 vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
550 vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
551 vui->regions[i].memory_size;
554 ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
555 "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
558 if (vui->region_mmap_addr[i] == MAP_FAILED)
560 clib_warning ("failed to map memory. errno is %d", errno);
563 vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
564 vui->region_mmap_fd[i] = fds[i];
570 case VHOST_USER_SET_VRING_NUM:
571 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
572 vui->hw_if_index, msg.state.index, msg.state.num);
574 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
575 (msg.state.num == 0) || /* it cannot be zero */
576 ((msg.state.num - 1) & msg.state.num)) /* must be power of 2 */
578 vui->vrings[msg.state.index].qsz_mask = msg.state.num - 1;
581 case VHOST_USER_SET_VRING_ADDR:
582 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
583 vui->hw_if_index, msg.state.index);
585 if (msg.state.index >= VHOST_VRING_MAX_N)
587 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
588 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
592 if (msg.size < sizeof (msg.addr))
594 DBG_SOCK ("vhost message is too short (%d < %d)",
595 msg.size, sizeof (msg.addr));
599 vui->vrings[msg.state.index].desc = (vring_desc_t *)
600 map_user_mem (vui, msg.addr.desc_user_addr);
601 vui->vrings[msg.state.index].used = (vring_used_t *)
602 map_user_mem (vui, msg.addr.used_user_addr);
603 vui->vrings[msg.state.index].avail = (vring_avail_t *)
604 map_user_mem (vui, msg.addr.avail_user_addr);
606 if ((vui->vrings[msg.state.index].desc == NULL) ||
607 (vui->vrings[msg.state.index].used == NULL) ||
608 (vui->vrings[msg.state.index].avail == NULL))
610 DBG_SOCK ("failed to map user memory for hw_if_index %d",
615 vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
616 vui->vrings[msg.state.index].log_used =
617 (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
619 /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
620 the ring is initialized in an enabled state. */
621 if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
623 vui->vrings[msg.state.index].enabled = 1;
626 vui->vrings[msg.state.index].last_used_idx =
627 vui->vrings[msg.state.index].last_avail_idx =
628 vui->vrings[msg.state.index].used->idx;
630 /* tell driver that we don't want interrupts */
631 vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
634 case VHOST_USER_SET_OWNER:
635 DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
638 case VHOST_USER_RESET_OWNER:
639 DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
642 case VHOST_USER_SET_VRING_CALL:
643 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL %d",
644 vui->hw_if_index, msg.u64);
646 q = (u8) (msg.u64 & 0xFF);
648 /* if there is old fd, delete and close it */
649 if (vui->vrings[q].callfd_idx != ~0)
651 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
652 vui->vrings[q].callfd_idx);
653 clib_file_del (&file_main, uf);
654 vui->vrings[q].callfd_idx = ~0;
657 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
659 if (number_of_fds != 1)
661 DBG_SOCK ("More than one fd received !");
665 template.read_function = vhost_user_callfd_read_ready;
666 template.file_descriptor = fds[0];
667 template.private_data =
668 ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
669 vui->vrings[q].callfd_idx = clib_file_add (&file_main, &template);
672 vui->vrings[q].callfd_idx = ~0;
675 case VHOST_USER_SET_VRING_KICK:
676 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK %d",
677 vui->hw_if_index, msg.u64);
679 q = (u8) (msg.u64 & 0xFF);
681 if (vui->vrings[q].kickfd_idx != ~0)
683 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
684 vui->vrings[q].kickfd_idx);
685 clib_file_del (&file_main, uf);
686 vui->vrings[q].kickfd_idx = ~0;
689 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
691 if (number_of_fds != 1)
693 DBG_SOCK ("More than one fd received !");
697 template.read_function = vhost_user_kickfd_read_ready;
698 template.file_descriptor = fds[0];
699 template.private_data =
700 (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
702 vui->vrings[q].kickfd_idx = clib_file_add (&file_main, &template);
706 //When no kickfd is set, the queue is initialized as started
707 vui->vrings[q].kickfd_idx = ~0;
708 vui->vrings[q].started = 1;
713 case VHOST_USER_SET_VRING_ERR:
714 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR %d",
715 vui->hw_if_index, msg.u64);
717 q = (u8) (msg.u64 & 0xFF);
719 if (vui->vrings[q].errfd != -1)
720 close (vui->vrings[q].errfd);
722 if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
724 if (number_of_fds != 1)
727 vui->vrings[q].errfd = fds[0];
730 vui->vrings[q].errfd = -1;
734 case VHOST_USER_SET_VRING_BASE:
735 DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
736 vui->hw_if_index, msg.state.index, msg.state.num);
738 vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
741 case VHOST_USER_GET_VRING_BASE:
742 if (msg.state.index >= VHOST_VRING_MAX_N)
744 DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
745 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
750 * Copy last_avail_idx from the vring before closing it because
751 * closing the vring also initializes the vring last_avail_idx
753 msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
755 msg.size = sizeof (msg.state);
757 /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
758 vhost_user_vring_close (vui, msg.state.index);
759 DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
760 vui->hw_if_index, msg.state.index, msg.state.num);
763 case VHOST_USER_NONE:
764 DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
768 case VHOST_USER_SET_LOG_BASE:
770 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
772 if (msg.size != sizeof (msg.log))
775 ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
776 msg.size, sizeof (msg.log));
781 (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
784 ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
789 /* align size to page */
790 long page_sz = get_huge_page_size (fd);
792 (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
794 vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
798 ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
799 map_sz, msg.log.offset, fd, vui->log_base_addr);
801 if (vui->log_base_addr == MAP_FAILED)
803 clib_warning ("failed to map memory. errno is %d", errno);
807 vui->log_base_addr += msg.log.offset;
808 vui->log_size = msg.log.size;
811 msg.size = sizeof (msg.u64);
816 case VHOST_USER_SET_LOG_FD:
817 DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
821 case VHOST_USER_GET_PROTOCOL_FEATURES:
823 msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
824 (1 << VHOST_USER_PROTOCOL_F_MQ);
825 msg.size = sizeof (msg.u64);
827 ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES - reply 0x%016llx",
828 vui->hw_if_index, msg.u64);
831 case VHOST_USER_SET_PROTOCOL_FEATURES:
833 ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%016llx",
834 vui->hw_if_index, msg.u64);
836 vui->protocol_features = msg.u64;
840 case VHOST_USER_GET_QUEUE_NUM:
842 msg.u64 = VHOST_VRING_MAX_N;
843 msg.size = sizeof (msg.u64);
844 DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM - reply %d",
845 vui->hw_if_index, msg.u64);
848 case VHOST_USER_SET_VRING_ENABLE:
849 DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
850 vui->hw_if_index, msg.state.num ? "enable" : "disable",
852 if (msg.state.index >= VHOST_VRING_MAX_N)
854 DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
855 " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
859 vui->vrings[msg.state.index].enabled = msg.state.num;
863 DBG_SOCK ("unknown vhost-user message %d received. closing socket",
868 /* if we need to reply */
872 send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
873 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
875 DBG_SOCK ("could not send message response");
880 vhost_user_update_iface_state (vui);
881 vlib_worker_thread_barrier_release (vlib_get_main ());
885 vhost_user_if_disconnect (vui);
886 vhost_user_update_iface_state (vui);
887 vlib_worker_thread_barrier_release (vlib_get_main ());
891 static clib_error_t *
892 vhost_user_socket_error (clib_file_t * uf)
894 vlib_main_t *vm = vlib_get_main ();
895 vhost_user_main_t *vum = &vhost_user_main;
896 vhost_user_intf_t *vui =
897 pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
899 DBG_SOCK ("socket error on if %d", vui->sw_if_index);
900 vlib_worker_thread_barrier_sync (vm);
901 vhost_user_if_disconnect (vui);
902 vhost_user_rx_thread_placement ();
903 vlib_worker_thread_barrier_release (vm);
907 static clib_error_t *
908 vhost_user_socksvr_accept_ready (clib_file_t * uf)
910 int client_fd, client_len;
911 struct sockaddr_un client;
912 clib_file_t template = { 0 };
913 vhost_user_main_t *vum = &vhost_user_main;
914 vhost_user_intf_t *vui;
916 vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
918 client_len = sizeof (client);
919 client_fd = accept (uf->file_descriptor,
920 (struct sockaddr *) &client,
921 (socklen_t *) & client_len);
924 return clib_error_return_unix (0, "accept");
926 if (vui->clib_file_index != ~0)
928 DBG_SOCK ("Close client socket for vhost interface %d, fd %d",
929 vui->sw_if_index, UNIX_GET_FD (vui->clib_file_index));
930 clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
933 DBG_SOCK ("New client socket for vhost interface %d, fd %d",
934 vui->sw_if_index, client_fd);
935 template.read_function = vhost_user_socket_read;
936 template.error_function = vhost_user_socket_error;
937 template.file_descriptor = client_fd;
938 template.private_data = vui - vhost_user_main.vhost_user_interfaces;
939 vui->clib_file_index = clib_file_add (&file_main, &template);
943 static clib_error_t *
944 vhost_user_init (vlib_main_t * vm)
947 vhost_user_main_t *vum = &vhost_user_main;
948 vlib_thread_main_t *tm = vlib_get_thread_main ();
950 error = vlib_call_init_function (vm, ip4_init);
954 vum->coalesce_frames = 32;
955 vum->coalesce_time = 1e-3;
957 vec_validate (vum->cpus, tm->n_vlib_mains - 1);
960 vec_foreach (cpu, vum->cpus)
962 /* This is actually not necessary as validate already zeroes it
963 * Just keeping the loop here for later because I am lazy. */
964 cpu->rx_buffers_len = 0;
967 vum->random = random_default_seed ();
969 mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
974 VLIB_INIT_FUNCTION (vhost_user_init);
977 vhost_user_send_interrupt_process (vlib_main_t * vm,
978 vlib_node_runtime_t * rt, vlib_frame_t * f)
980 vhost_user_intf_t *vui;
981 f64 timeout = 3153600000.0 /* 100 years */ ;
982 uword event_type, *event_data = 0;
983 vhost_user_main_t *vum = &vhost_user_main;
985 f64 now, poll_time_remaining;
991 poll_time_remaining =
992 vlib_process_wait_for_event_or_clock (vm, timeout);
993 event_type = vlib_process_get_events (vm, &event_data);
994 vec_reset_length (event_data);
997 * Use the remaining timeout if it is less than coalesce time to avoid
998 * resetting the existing timer in the middle of expiration
1000 timeout = poll_time_remaining;
1001 if (vlib_process_suspend_time_is_zero (timeout) ||
1002 (timeout > vum->coalesce_time))
1003 timeout = vum->coalesce_time;
1005 now = vlib_time_now (vm);
1008 case VHOST_USER_EVENT_STOP_TIMER:
1012 case VHOST_USER_EVENT_START_TIMER:
1014 if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
1020 pool_foreach (vui, vum->vhost_user_interfaces, {
1021 next_timeout = timeout;
1022 vec_foreach (queue, vui->rx_queues)
1024 vhost_user_vring_t *rxvq =
1025 &vui->vrings[VHOST_VRING_IDX_RX (*queue)];
1026 vhost_user_vring_t *txvq =
1027 &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
1029 if (txvq->n_since_last_int)
1031 if (now >= txvq->int_deadline)
1032 vhost_user_send_call (vm, txvq);
1034 next_timeout = txvq->int_deadline - now;
1037 if (rxvq->n_since_last_int)
1039 if (now >= rxvq->int_deadline)
1040 vhost_user_send_call (vm, rxvq);
1042 next_timeout = rxvq->int_deadline - now;
1045 if ((next_timeout < timeout) && (next_timeout > 0.0))
1046 timeout = next_timeout;
1053 clib_warning ("BUG: unhandled event type %d", event_type);
1056 /* No less than 1 millisecond */
1060 timeout = 3153600000.0;
1066 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node) = {
1067 .function = vhost_user_send_interrupt_process,
1068 .type = VLIB_NODE_TYPE_PROCESS,
1069 .name = "vhost-user-send-interrupt-process",
1074 vhost_user_process (vlib_main_t * vm,
1075 vlib_node_runtime_t * rt, vlib_frame_t * f)
1077 vhost_user_main_t *vum = &vhost_user_main;
1078 vhost_user_intf_t *vui;
1079 struct sockaddr_un sun;
1081 clib_file_t template = { 0 };
1082 f64 timeout = 3153600000.0 /* 100 years */ ;
1083 uword *event_data = 0;
1086 sun.sun_family = AF_UNIX;
1087 template.read_function = vhost_user_socket_read;
1088 template.error_function = vhost_user_socket_error;
1092 vlib_process_wait_for_event_or_clock (vm, timeout);
1093 vlib_process_get_events (vm, &event_data);
1094 vec_reset_length (event_data);
1099 pool_foreach (vui, vum->vhost_user_interfaces, {
1101 if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
1102 if (vui->clib_file_index == ~0)
1105 ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
1108 * 1st time error or new error for this interface,
1109 * spit out the message and record the error
1111 if (!vui->sock_errno || (vui->sock_errno != errno))
1114 ("Error: Could not open unix socket for %s",
1115 vui->sock_filename);
1116 vui->sock_errno = errno;
1121 /* try to connect */
1122 strncpy (sun.sun_path, (char *) vui->sock_filename,
1123 sizeof (sun.sun_path) - 1);
1125 /* Avoid hanging VPP if the other end does not accept */
1126 if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
1127 clib_unix_warning ("fcntl");
1129 if (connect (sockfd, (struct sockaddr *) &sun,
1130 sizeof (struct sockaddr_un)) == 0)
1132 /* Set the socket to blocking as it was before */
1133 if (fcntl(sockfd, F_SETFL, 0) < 0)
1134 clib_unix_warning ("fcntl2");
1136 vui->sock_errno = 0;
1137 template.file_descriptor = sockfd;
1138 template.private_data =
1139 vui - vhost_user_main.vhost_user_interfaces;
1140 vui->clib_file_index = clib_file_add (&file_main, &template);
1142 /* This sockfd is considered consumed */
1147 vui->sock_errno = errno;
1152 /* check if socket is alive */
1154 socklen_t len = sizeof (error);
1155 int fd = UNIX_GET_FD(vui->clib_file_index);
1157 getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
1161 DBG_SOCK ("getsockopt returned %d", retval);
1162 vhost_user_if_disconnect (vui);
1173 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
1174 .function = vhost_user_process,
1175 .type = VLIB_NODE_TYPE_PROCESS,
1176 .name = "vhost-user-process",
1181 * Disables and reset interface structure.
1182 * It can then be either init again, or removed from used interfaces.
1185 vhost_user_term_if (vhost_user_intf_t * vui)
1188 vhost_user_main_t *vum = &vhost_user_main;
1190 // disconnect interface sockets
1191 vhost_user_if_disconnect (vui);
1192 vhost_user_update_iface_state (vui);
1194 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1196 clib_mem_free ((void *) vui->vring_locks[q]);
1199 if (vui->unix_server_index != ~0)
1201 //Close server socket
1202 clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
1203 vui->unix_server_index);
1204 clib_file_del (&file_main, uf);
1205 vui->unix_server_index = ~0;
1206 unlink (vui->sock_filename);
1209 mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
1214 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
1216 vhost_user_main_t *vum = &vhost_user_main;
1217 vhost_user_intf_t *vui;
1219 vnet_hw_interface_t *hwif;
1222 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
1223 hwif->dev_class_index != vhost_user_device_class.index)
1224 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1226 DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
1227 hwif->name, hwif->dev_instance);
1229 vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1231 vec_foreach (queue, vui->rx_queues)
1233 vhost_user_vring_t *txvq;
1235 txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
1236 if ((vum->ifq_count > 0) &&
1237 ((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
1238 (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)))
1241 // Stop the timer if there is no more interrupt interface/queue
1242 if ((vum->ifq_count == 0) &&
1243 (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
1245 vlib_process_signal_event (vm,
1246 vhost_user_send_interrupt_node.index,
1247 VHOST_USER_EVENT_STOP_TIMER, 0);
1253 // Disable and reset interface
1254 vhost_user_term_if (vui);
1256 // Reset renumbered iface
1257 if (hwif->dev_instance <
1258 vec_len (vum->show_dev_instance_by_real_dev_instance))
1259 vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
1261 // Delete ethernet interface
1262 ethernet_delete_interface (vnm, vui->hw_if_index);
1265 pool_put (vum->vhost_user_interfaces, vui);
1270 static clib_error_t *
1271 vhost_user_exit (vlib_main_t * vm)
1273 vnet_main_t *vnm = vnet_get_main ();
1274 vhost_user_main_t *vum = &vhost_user_main;
1275 vhost_user_intf_t *vui;
1277 vlib_worker_thread_barrier_sync (vlib_get_main ());
1279 pool_foreach (vui, vum->vhost_user_interfaces, {
1280 vhost_user_delete_if (vnm, vm, vui->sw_if_index);
1283 vlib_worker_thread_barrier_release (vlib_get_main ());
1287 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
1290 * Open server unix socket on specified sock_filename.
1293 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
1296 struct sockaddr_un un = { };
1298 /* create listening socket */
1299 if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1300 return VNET_API_ERROR_SYSCALL_ERROR_1;
1302 un.sun_family = AF_UNIX;
1303 strncpy ((char *) un.sun_path, (char *) sock_filename,
1304 sizeof (un.sun_path) - 1);
1306 /* remove if exists */
1307 unlink ((char *) sock_filename);
1309 if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
1311 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1315 if (listen (fd, 1) == -1)
1317 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1330 * Create ethernet interface for vhost user interface.
1333 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
1334 vhost_user_intf_t * vui, u8 * hwaddress)
1336 vhost_user_main_t *vum = &vhost_user_main;
1338 clib_error_t *error;
1340 /* create hw and sw interface */
1343 clib_memcpy (hwaddr, hwaddress, 6);
1347 random_u32 (&vum->random);
1348 clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
1353 error = ethernet_register_interface
1355 vhost_user_device_class.index,
1356 vui - vum->vhost_user_interfaces /* device instance */ ,
1357 hwaddr /* ethernet address */ ,
1358 &vui->hw_if_index, 0 /* flag change */ );
1361 clib_error_report (error);
1363 vnet_sw_interface_set_mtu (vnm, vui->sw_if_index, 9000);
1367 * Initialize vui with specified attributes
1370 vhost_user_vui_init (vnet_main_t * vnm,
1371 vhost_user_intf_t * vui,
1373 const char *sock_filename,
1374 u64 feature_mask, u32 * sw_if_index)
1376 vnet_sw_interface_t *sw;
1378 vhost_user_main_t *vum = &vhost_user_main;
1379 vnet_hw_interface_t *hw;
1381 hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
1382 sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
1383 if (server_sock_fd != -1)
1385 clib_file_t template = { 0 };
1386 template.read_function = vhost_user_socksvr_accept_ready;
1387 template.file_descriptor = server_sock_fd;
1388 template.private_data = vui - vum->vhost_user_interfaces; //hw index
1389 vui->unix_server_index = clib_file_add (&file_main, &template);
1393 vui->unix_server_index = ~0;
1396 vui->sw_if_index = sw->sw_if_index;
1397 strncpy (vui->sock_filename, sock_filename,
1398 ARRAY_LEN (vui->sock_filename) - 1);
1399 vui->sock_errno = 0;
1401 vui->feature_mask = feature_mask;
1402 vui->clib_file_index = ~0;
1403 vui->log_base_addr = 0;
1404 vui->if_index = vui - vum->vhost_user_interfaces;
1405 mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
1408 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1409 vhost_user_vring_init (vui, q);
1411 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1412 vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
1415 *sw_if_index = vui->sw_if_index;
1417 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1419 vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
1420 CLIB_CACHE_LINE_BYTES);
1421 memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
1424 vec_validate (vui->per_cpu_tx_qid,
1425 vlib_get_thread_main ()->n_vlib_mains - 1);
1426 vhost_user_tx_thread_placement (vui);
1430 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
1431 const char *sock_filename,
1435 u8 renumber, u32 custom_dev_instance, u8 * hwaddr)
1437 vhost_user_intf_t *vui = NULL;
1440 int server_sock_fd = -1;
1441 vhost_user_main_t *vum = &vhost_user_main;
1444 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1446 return VNET_API_ERROR_INVALID_ARGUMENT;
1449 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1454 vui = &vum->vhost_user_interfaces[*if_index];
1455 *sw_if_index = vui->sw_if_index;
1457 return VNET_API_ERROR_IF_ALREADY_EXISTS;
1463 vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
1469 pool_get (vhost_user_main.vhost_user_interfaces, vui);
1471 vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
1472 vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
1473 feature_mask, &sw_if_idx);
1476 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1479 *sw_if_index = sw_if_idx;
1481 // Process node must connect
1482 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1488 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
1489 const char *sock_filename,
1492 u64 feature_mask, u8 renumber, u32 custom_dev_instance)
1494 vhost_user_main_t *vum = &vhost_user_main;
1495 vhost_user_intf_t *vui = NULL;
1497 int server_sock_fd = -1;
1499 vnet_hw_interface_t *hwif;
1502 if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
1503 hwif->dev_class_index != vhost_user_device_class.index)
1504 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1506 if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1507 return VNET_API_ERROR_INVALID_ARGUMENT;
1509 vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1512 * Disallow changing the interface to have the same path name
1513 * as other interface
1515 if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1516 if (if_index && (*if_index != vui->if_index))
1517 return VNET_API_ERROR_IF_ALREADY_EXISTS;
1519 // First try to open server socket
1521 if ((rv = vhost_user_init_server_sock (sock_filename,
1522 &server_sock_fd)) != 0)
1525 vhost_user_term_if (vui);
1526 vhost_user_vui_init (vnm, vui, server_sock_fd,
1527 sock_filename, feature_mask, &sw_if_idx);
1530 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1532 // Process node must connect
1533 vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1539 vhost_user_connect_command_fn (vlib_main_t * vm,
1540 unformat_input_t * input,
1541 vlib_cli_command_t * cmd)
1543 unformat_input_t _line_input, *line_input = &_line_input;
1544 u8 *sock_filename = NULL;
1547 u64 feature_mask = (u64) ~ (0ULL);
1549 u32 custom_dev_instance = ~0;
1552 clib_error_t *error = NULL;
1554 /* Get a line of input. */
1555 if (!unformat_user (input, unformat_line_input, line_input))
1558 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1560 if (unformat (line_input, "socket %s", &sock_filename))
1562 else if (unformat (line_input, "server"))
1564 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
1568 (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
1570 else if (unformat (line_input, "renumber %d", &custom_dev_instance))
1576 error = clib_error_return (0, "unknown input `%U'",
1577 format_unformat_error, line_input);
1582 vnet_main_t *vnm = vnet_get_main ();
1585 if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
1586 is_server, &sw_if_index, feature_mask,
1587 renumber, custom_dev_instance, hw)))
1589 error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
1593 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
1597 vec_free (sock_filename);
1598 unformat_free (line_input);
1604 vhost_user_delete_command_fn (vlib_main_t * vm,
1605 unformat_input_t * input,
1606 vlib_cli_command_t * cmd)
1608 unformat_input_t _line_input, *line_input = &_line_input;
1609 u32 sw_if_index = ~0;
1610 vnet_main_t *vnm = vnet_get_main ();
1611 clib_error_t *error = NULL;
1613 /* Get a line of input. */
1614 if (!unformat_user (input, unformat_line_input, line_input))
1617 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1619 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
1622 (line_input, "%U", unformat_vnet_sw_interface, vnm,
1625 vnet_hw_interface_t *hwif =
1626 vnet_get_sup_hw_interface (vnm, sw_if_index);
1628 vhost_user_device_class.index != hwif->dev_class_index)
1630 error = clib_error_return (0, "Not a vhost interface");
1636 error = clib_error_return (0, "unknown input `%U'",
1637 format_unformat_error, line_input);
1642 vhost_user_delete_if (vnm, vm, sw_if_index);
1645 unformat_free (line_input);
1651 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
1652 vhost_user_intf_details_t ** out_vuids)
1655 vhost_user_main_t *vum = &vhost_user_main;
1656 vhost_user_intf_t *vui;
1657 vhost_user_intf_details_t *r_vuids = NULL;
1658 vhost_user_intf_details_t *vuid = NULL;
1659 u32 *hw_if_indices = 0;
1660 vnet_hw_interface_t *hi;
1667 pool_foreach (vui, vum->vhost_user_interfaces,
1668 vec_add1 (hw_if_indices, vui->hw_if_index);
1671 for (i = 0; i < vec_len (hw_if_indices); i++)
1673 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1674 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
1676 vec_add2 (r_vuids, vuid, 1);
1677 vuid->sw_if_index = vui->sw_if_index;
1678 vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
1679 vuid->features = vui->features;
1680 vuid->num_regions = vui->nregions;
1681 vuid->is_server = vui->unix_server_index != ~0;
1682 vuid->sock_errno = vui->sock_errno;
1683 strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
1684 sizeof (vuid->sock_filename));
1685 vuid->sock_filename[ARRAY_LEN (vuid->sock_filename) - 1] = '\0';
1686 s = format (s, "%v%c", hi->name, 0);
1688 strncpy ((char *) vuid->if_name, (char *) s,
1689 ARRAY_LEN (vuid->if_name) - 1);
1694 vec_free (hw_if_indices);
1696 *out_vuids = r_vuids;
1702 show_vhost_user_command_fn (vlib_main_t * vm,
1703 unformat_input_t * input,
1704 vlib_cli_command_t * cmd)
1706 clib_error_t *error = 0;
1707 vnet_main_t *vnm = vnet_get_main ();
1708 vhost_user_main_t *vum = &vhost_user_main;
1709 vhost_user_intf_t *vui;
1710 u32 hw_if_index, *hw_if_indices = 0;
1711 vnet_hw_interface_t *hi;
1721 struct feat_struct *feat_entry;
1723 static struct feat_struct feat_array[] = {
1724 #define _(s,b) { .str = #s, .bit = b, },
1725 foreach_virtio_net_feature
1730 #define foreach_protocol_feature \
1731 _(VHOST_USER_PROTOCOL_F_MQ) \
1732 _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
1734 static struct feat_struct proto_feat_array[] = {
1735 #define _(s) { .str = #s, .bit = s},
1736 foreach_protocol_feature
1741 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1744 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1746 hi = vnet_get_hw_interface (vnm, hw_if_index);
1747 if (vhost_user_device_class.index != hi->dev_class_index)
1749 error = clib_error_return (0, "unknown input `%U'",
1750 format_unformat_error, input);
1753 vec_add1 (hw_if_indices, hw_if_index);
1755 else if (unformat (input, "descriptors") || unformat (input, "desc"))
1759 error = clib_error_return (0, "unknown input `%U'",
1760 format_unformat_error, input);
1764 if (vec_len (hw_if_indices) == 0)
1766 pool_foreach (vui, vum->vhost_user_interfaces,
1767 vec_add1 (hw_if_indices, vui->hw_if_index);
1770 vlib_cli_output (vm, "Virtio vhost-user interfaces");
1771 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e",
1772 vum->coalesce_frames, vum->coalesce_time);
1773 vlib_cli_output (vm, " number of rx virtqueues in interrupt mode: %d",
1776 for (i = 0; i < vec_len (hw_if_indices); i++)
1778 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1779 vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
1780 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
1781 format_vnet_hw_if_index_name, vnm, hw_if_indices[i],
1784 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
1785 " features mask (0x%llx): \n"
1786 " features (0x%llx): \n",
1787 vui->virtio_net_hdr_sz, vui->feature_mask,
1790 feat_entry = (struct feat_struct *) &feat_array;
1791 while (feat_entry->str)
1793 if (vui->features & (1ULL << feat_entry->bit))
1794 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
1799 vlib_cli_output (vm, " protocol features (0x%llx)",
1800 vui->protocol_features);
1801 feat_entry = (struct feat_struct *) &proto_feat_array;
1802 while (feat_entry->str)
1804 if (vui->protocol_features & (1ULL << feat_entry->bit))
1805 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
1810 vlib_cli_output (vm, "\n");
1812 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
1814 (vui->unix_server_index != ~0) ? "server" : "client",
1815 strerror (vui->sock_errno));
1817 vlib_cli_output (vm, " rx placement: ");
1819 vec_foreach (queue, vui->rx_queues)
1821 vnet_main_t *vnm = vnet_get_main ();
1823 vnet_hw_interface_rx_mode mode;
1825 thread_index = vnet_get_device_input_thread_index (vnm,
1828 vnet_hw_interface_get_rx_mode (vnm, vui->hw_if_index, *queue, &mode);
1829 vlib_cli_output (vm, " thread %d on vring %d, %U\n",
1830 thread_index, VHOST_VRING_IDX_TX (*queue),
1831 format_vnet_hw_interface_rx_mode, mode);
1834 vlib_cli_output (vm, " tx placement: %s\n",
1835 vui->use_tx_spinlock ? "spin-lock" : "lock-free");
1837 vec_foreach_index (ci, vui->per_cpu_tx_qid)
1839 vlib_cli_output (vm, " thread %d on vring %d\n", ci,
1840 VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
1843 vlib_cli_output (vm, "\n");
1845 vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
1849 vlib_cli_output (vm,
1850 " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
1851 vlib_cli_output (vm,
1852 " ====== ===== ================== ================== ================== ================== ==================\n");
1854 for (j = 0; j < vui->nregions; j++)
1856 vlib_cli_output (vm,
1857 " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
1858 j, vui->region_mmap_fd[j],
1859 vui->regions[j].guest_phys_addr,
1860 vui->regions[j].memory_size,
1861 vui->regions[j].userspace_addr,
1862 vui->regions[j].mmap_offset,
1863 pointer_to_uword (vui->region_mmap_addr[j]));
1865 for (q = 0; q < VHOST_VRING_MAX_N; q++)
1867 if (!vui->vrings[q].started)
1870 vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
1871 (q & 1) ? "RX" : "TX",
1872 vui->vrings[q].enabled ? "" : " disabled");
1874 vlib_cli_output (vm,
1875 " qsz %d last_avail_idx %d last_used_idx %d\n",
1876 vui->vrings[q].qsz_mask + 1,
1877 vui->vrings[q].last_avail_idx,
1878 vui->vrings[q].last_used_idx);
1880 if (vui->vrings[q].avail && vui->vrings[q].used)
1881 vlib_cli_output (vm,
1882 " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
1883 vui->vrings[q].avail->flags,
1884 vui->vrings[q].avail->idx,
1885 vui->vrings[q].used->flags,
1886 vui->vrings[q].used->idx);
1888 int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
1889 int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
1890 vlib_cli_output (vm, " kickfd %d callfd %d errfd %d\n",
1891 kickfd, callfd, vui->vrings[q].errfd);
1895 vlib_cli_output (vm, "\n descriptor table:\n");
1896 vlib_cli_output (vm,
1897 " id addr len flags next user_addr\n");
1898 vlib_cli_output (vm,
1899 " ===== ================== ===== ====== ===== ==================\n");
1900 for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
1903 vlib_cli_output (vm,
1904 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
1905 j, vui->vrings[q].desc[j].addr,
1906 vui->vrings[q].desc[j].len,
1907 vui->vrings[q].desc[j].flags,
1908 vui->vrings[q].desc[j].next,
1909 pointer_to_uword (map_guest_mem
1911 vui->vrings[q].desc[j].
1916 vlib_cli_output (vm, "\n");
1919 vec_free (hw_if_indices);
1928 * Create a vHost User interface. Once created, a new virtual interface
1929 * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
1930 * is the next free index.
1932 * There are several parameters associated with a vHost interface:
1934 * - <b>socket <socket-filename></b> - Name of the linux socket used by hypervisor
1935 * and VPP to manage the vHost interface. If in '<em>server</em>' mode, VPP will
1936 * create the socket if it does not already exist. If in '<em>client</em>' mode,
1937 * hypervisor will create the socket if it does not already exist. The VPP code
1938 * is indifferent to the file location. However, if SELinux is enabled, then the
1939 * socket needs to be created in '<em>/var/run/vpp/</em>'.
1941 * - <b>server</b> - Optional flag to indicate that VPP should be the server for
1942 * the linux socket. If not provided, VPP will be the client. In '<em>server</em>'
1943 * mode, the VM can be reset without tearing down the vHost Interface. In
1944 * '<em>client</em>' mode, VPP can be reset without bringing down the VM and
1945 * tearing down the vHost Interface.
1947 * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
1948 * startup. <b>This is intended for degugging only.</b> It is recommended that this
1949 * parameter not be used except by experienced users. By default, all supported
1950 * features will be advertised. Otherwise, provide the set of features desired.
1951 * - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
1952 * - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
1953 * - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
1954 * - 0x000400000 (22) - VIRTIO_NET_F_MQ
1955 * - 0x004000000 (26) - VHOST_F_LOG_ALL
1956 * - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
1957 * - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
1958 * - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
1959 * - 0x100000000 (32) - VIRTIO_F_VERSION_1
1961 * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
1962 * X:X:X:X:X:X unix or X.X.X cisco format.
1964 * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
1965 * in the name to be specified. If instance already exists, name will be used
1966 * anyway and multiple instances will have the same name. Use with caution.
1969 * Example of how to create a vhost interface with VPP as the client and all features enabled:
1970 * @cliexstart{create vhost-user socket /var/run/vpp/vhost1.sock}
1971 * VirtualEthernet0/0/0
1973 * Example of how to create a vhost interface with VPP as the server and with just
1974 * multiple queues enabled:
1975 * @cliexstart{create vhost-user socket /var/run/vpp/vhost2.sock server feature-mask 0x40400000}
1976 * VirtualEthernet0/0/1
1978 * Once the vHost interface is created, enable the interface using:
1979 * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
1982 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
1983 .path = "create vhost-user",
1984 .short_help = "create vhost-user socket <socket-filename> [server] "
1985 "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] ",
1986 .function = vhost_user_connect_command_fn,
1991 * Delete a vHost User interface using the interface name or the
1992 * software interface index. Use the '<em>show interface</em>'
1993 * command to determine the software interface index. On deletion,
1994 * the linux socket will not be deleted.
1997 * Example of how to delete a vhost interface by name:
1998 * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
1999 * Example of how to delete a vhost interface by software interface index:
2000 * @cliexcmd{delete vhost-user sw_if_index 1}
2003 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
2004 .path = "delete vhost-user",
2005 .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
2006 .function = vhost_user_delete_command_fn,
2010 * Display the attributes of a single vHost User interface (provide interface
2011 * name), multiple vHost User interfaces (provide a list of interface names seperated
2012 * by spaces) or all Vhost User interfaces (omit an interface name to display all
2013 * vHost interfaces).
2017 * Example of how to display a vhost interface:
2018 * @cliexstart{show vhost-user VirtualEthernet0/0/0}
2019 * Virtio vhost-user interfaces
2021 * coalesce frames 32 time 1e-3
2022 * Interface: VirtualEthernet0/0/0 (ifindex 1)
2023 * virtio_net_hdr_sz 12
2024 * features mask (0xffffffffffffffff):
2025 * features (0x50408000):
2026 * VIRTIO_NET_F_MRG_RXBUF (15)
2027 * VIRTIO_NET_F_MQ (22)
2028 * VIRTIO_F_INDIRECT_DESC (28)
2029 * VHOST_USER_F_PROTOCOL_FEATURES (30)
2030 * protocol features (0x3)
2031 * VHOST_USER_PROTOCOL_F_MQ (0)
2032 * VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
2034 * socket filename /var/run/vpp/vhost1.sock type client errno "Success"
2037 * thread 1 on vring 1
2038 * thread 1 on vring 5
2039 * thread 2 on vring 3
2040 * thread 2 on vring 7
2041 * tx placement: spin-lock
2042 * thread 0 on vring 0
2043 * thread 1 on vring 2
2044 * thread 2 on vring 0
2046 * Memory regions (total 2)
2047 * region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr
2048 * ====== ===== ================== ================== ================== ================== ==================
2049 * 0 60 0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
2050 * 1 61 0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
2053 * qsz 256 last_avail_idx 0 last_used_idx 0
2054 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2055 * kickfd 62 callfd 64 errfd -1
2058 * qsz 256 last_avail_idx 0 last_used_idx 0
2059 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2060 * kickfd 65 callfd 66 errfd -1
2063 * qsz 256 last_avail_idx 0 last_used_idx 0
2064 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2065 * kickfd 63 callfd 70 errfd -1
2068 * qsz 256 last_avail_idx 0 last_used_idx 0
2069 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2070 * kickfd 72 callfd 74 errfd -1
2072 * Virtqueue 4 (TX disabled)
2073 * qsz 256 last_avail_idx 0 last_used_idx 0
2074 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2075 * kickfd 76 callfd 78 errfd -1
2077 * Virtqueue 5 (RX disabled)
2078 * qsz 256 last_avail_idx 0 last_used_idx 0
2079 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2080 * kickfd 80 callfd 82 errfd -1
2082 * Virtqueue 6 (TX disabled)
2083 * qsz 256 last_avail_idx 0 last_used_idx 0
2084 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2085 * kickfd 84 callfd 86 errfd -1
2087 * Virtqueue 7 (RX disabled)
2088 * qsz 256 last_avail_idx 0 last_used_idx 0
2089 * avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2090 * kickfd 88 callfd 90 errfd -1
2094 * The optional '<em>descriptors</em>' parameter will display the same output as
2095 * the previous example but will include the descriptor table for each queue.
2096 * The output is truncated below:
2097 * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
2098 * Virtio vhost-user interfaces
2100 * coalesce frames 32 time 1e-3
2101 * Interface: VirtualEthernet0/0/0 (ifindex 1)
2102 * virtio_net_hdr_sz 12
2103 * features mask (0xffffffffffffffff):
2104 * features (0x50408000):
2105 * VIRTIO_NET_F_MRG_RXBUF (15)
2106 * VIRTIO_NET_F_MQ (22)
2109 * qsz 256 last_avail_idx 0 last_used_idx 0
2110 * avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2111 * kickfd 62 callfd 64 errfd -1
2114 * id addr len flags next user_addr
2115 * ===== ================== ===== ====== ===== ==================
2116 * 0 0x0000000010b6e974 2060 0x0002 1 0x00002aabbc76e974
2117 * 1 0x0000000010b6e034 2060 0x0002 2 0x00002aabbc76e034
2118 * 2 0x0000000010b6d6f4 2060 0x0002 3 0x00002aabbc76d6f4
2119 * 3 0x0000000010b6cdb4 2060 0x0002 4 0x00002aabbc76cdb4
2120 * 4 0x0000000010b6c474 2060 0x0002 5 0x00002aabbc76c474
2121 * 5 0x0000000010b6bb34 2060 0x0002 6 0x00002aabbc76bb34
2122 * 6 0x0000000010b6b1f4 2060 0x0002 7 0x00002aabbc76b1f4
2123 * 7 0x0000000010b6a8b4 2060 0x0002 8 0x00002aabbc76a8b4
2124 * 8 0x0000000010b69f74 2060 0x0002 9 0x00002aabbc769f74
2125 * 9 0x0000000010b69634 2060 0x0002 10 0x00002aabbc769634
2126 * 10 0x0000000010b68cf4 2060 0x0002 11 0x00002aabbc768cf4
2128 * 249 0x0000000000000000 0 0x0000 250 0x00002aab2b400000
2129 * 250 0x0000000000000000 0 0x0000 251 0x00002aab2b400000
2130 * 251 0x0000000000000000 0 0x0000 252 0x00002aab2b400000
2131 * 252 0x0000000000000000 0 0x0000 253 0x00002aab2b400000
2132 * 253 0x0000000000000000 0 0x0000 254 0x00002aab2b400000
2133 * 254 0x0000000000000000 0 0x0000 255 0x00002aab2b400000
2134 * 255 0x0000000000000000 0 0x0000 32768 0x00002aab2b400000
2137 * qsz 256 last_avail_idx 0 last_used_idx 0
2143 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
2144 .path = "show vhost-user",
2145 .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
2146 .function = show_vhost_user_command_fn,
2151 debug_vhost_user_command_fn (vlib_main_t * vm,
2152 unformat_input_t * input,
2153 vlib_cli_command_t * cmd)
2155 unformat_input_t _line_input, *line_input = &_line_input;
2156 clib_error_t *error = NULL;
2157 vhost_user_main_t *vum = &vhost_user_main;
2161 /* Get a line of input. */
2162 if (!unformat_user (input, unformat_line_input, line_input))
2163 return clib_error_return (0, "missing argument");
2165 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2169 error = clib_error_return (0, "unknown input `%U'",
2170 format_unformat_error, line_input);
2174 if (unformat (line_input, "on"))
2179 else if (unformat (line_input, "off"))
2186 error = clib_error_return (0, "unknown input `%U'",
2187 format_unformat_error, line_input);
2195 unformat_free (line_input);
2201 VLIB_CLI_COMMAND (debug_vhost_user_command, static) = {
2202 .path = "debug vhost-user",
2203 .short_help = "debug vhost-user <on | off>",
2204 .function = debug_vhost_user_command_fn,
2208 static clib_error_t *
2209 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
2211 vhost_user_main_t *vum = &vhost_user_main;
2213 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2215 if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
2217 else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
2219 else if (unformat (input, "dont-dump-memory"))
2220 vum->dont_dump_vhost_user_memory = 1;
2222 return clib_error_return (0, "unknown input `%U'",
2223 format_unformat_error, input);
2230 /* vhost-user { ... } configuration. */
2231 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
2234 vhost_user_unmap_all (void)
2236 vhost_user_main_t *vum = &vhost_user_main;
2237 vhost_user_intf_t *vui;
2239 if (vum->dont_dump_vhost_user_memory)
2241 pool_foreach (vui, vum->vhost_user_interfaces,
2242 unmap_all_mem_regions (vui);
2248 * fd.io coding-style-patch-verification: ON
2251 * eval: (c-set-style "gnu")