1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
7 * The vhost-user protocol connection is an external interface, so it must be
8 * robust against invalid inputs.
10 * This is important because the vhost-user master is only one step removed
11 * from the guest. Malicious guests that have escaped will then launch further
12 * attacks from the vhost-user master.
14 * Even in deployments where guests are trusted, a bug in the vhost-user master
15 * can still cause invalid messages to be sent. Such messages must not
16 * compromise the stability of the DPDK application by causing crashes, memory
17 * corruption, or other problematic behavior.
19 * Do not assume received VhostUserMsg fields contain sensible values!
28 #include <sys/types.h>
31 #ifdef RTE_LIBRTE_VHOST_NUMA
35 #include <rte_common.h>
36 #include <rte_malloc.h>
41 #include "vhost_user.h"
43 #define VIRTIO_MIN_MTU 68
44 #define VIRTIO_MAX_MTU 65535
46 static const char *vhost_message_str[VHOST_USER_MAX] = {
47 [VHOST_USER_NONE] = "VHOST_USER_NONE",
48 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
49 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
50 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
51 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
52 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
53 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
54 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
55 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
56 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
57 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
58 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
59 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
60 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
61 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
62 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
63 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
64 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
65 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
66 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
67 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
68 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
69 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
78 ret = fstat(fd, &stat);
79 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
83 free_mem_region(struct virtio_net *dev)
86 struct rte_vhost_mem_region *reg;
88 if (!dev || !dev->mem)
91 for (i = 0; i < dev->mem->nregions; i++) {
92 reg = &dev->mem->regions[i];
93 if (reg->host_user_addr) {
94 munmap(reg->mmap_addr, reg->mmap_size);
101 vhost_backend_cleanup(struct virtio_net *dev)
104 free_mem_region(dev);
109 free(dev->guest_pages);
110 dev->guest_pages = NULL;
113 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
117 if (dev->slave_req_fd >= 0) {
118 close(dev->slave_req_fd);
119 dev->slave_req_fd = -1;
124 * This function just returns success at the moment unless
125 * the device hasn't been initialised.
128 vhost_user_set_owner(void)
134 vhost_user_reset_owner(struct virtio_net *dev)
136 if (dev->flags & VIRTIO_DEV_RUNNING) {
137 dev->flags &= ~VIRTIO_DEV_RUNNING;
138 dev->notify_ops->destroy_device(dev->vid);
141 cleanup_device(dev, 0);
147 * The features that we support are requested.
150 vhost_user_get_features(struct virtio_net *dev)
152 uint64_t features = 0;
154 rte_vhost_driver_get_features(dev->ifname, &features);
159 * We receive the negotiated features supported by us and the virtio device.
162 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
164 uint64_t vhost_features = 0;
166 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
167 if (features & ~vhost_features) {
168 RTE_LOG(ERR, VHOST_CONFIG,
169 "(%d) received invalid negotiated features.\n",
174 if (dev->flags & VIRTIO_DEV_RUNNING) {
175 if (dev->features == features)
179 * Error out if master tries to change features while device is
180 * in running state. The exception being VHOST_F_LOG_ALL, which
181 * is enabled when the live-migration starts.
183 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
184 RTE_LOG(ERR, VHOST_CONFIG,
185 "(%d) features changed while device is running.\n",
190 if (dev->notify_ops->features_changed)
191 dev->notify_ops->features_changed(dev->vid, features);
194 dev->features = features;
196 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
197 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
199 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
201 LOG_DEBUG(VHOST_CONFIG,
202 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
204 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
205 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
207 if ((dev->flags & VIRTIO_DEV_BUILTIN_VIRTIO_NET) &&
208 !(dev->features & (1ULL << VIRTIO_NET_F_MQ))) {
210 * Remove all but first queue pair if MQ hasn't been
211 * negotiated. This is safe because the device is not
212 * running at this stage.
214 while (dev->nr_vring > 2) {
215 struct vhost_virtqueue *vq;
217 vq = dev->virtqueue[--dev->nr_vring];
221 dev->virtqueue[dev->nr_vring] = NULL;
231 * The virtio device sends us the size of the descriptor ring.
234 vhost_user_set_vring_num(struct virtio_net *dev,
237 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
239 vq->size = msg->payload.state.num;
241 /* VIRTIO 1.0, 2.4 Virtqueues says:
243 * Queue Size value is always a power of 2. The maximum Queue Size
246 if ((vq->size & (vq->size - 1)) || vq->size > 32768) {
247 RTE_LOG(ERR, VHOST_CONFIG,
248 "invalid virtqueue size %u\n", vq->size);
252 if (dev->dequeue_zero_copy) {
254 vq->last_zmbuf_idx = 0;
255 vq->zmbuf_size = vq->size;
256 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
257 sizeof(struct zcopy_mbuf), 0);
258 if (vq->zmbufs == NULL) {
259 RTE_LOG(WARNING, VHOST_CONFIG,
260 "failed to allocate mem for zero copy; "
261 "zero copy is force disabled\n");
262 dev->dequeue_zero_copy = 0;
264 TAILQ_INIT(&vq->zmbuf_list);
267 vq->shadow_used_ring = rte_malloc(NULL,
268 vq->size * sizeof(struct vring_used_elem),
269 RTE_CACHE_LINE_SIZE);
270 if (!vq->shadow_used_ring) {
271 RTE_LOG(ERR, VHOST_CONFIG,
272 "failed to allocate memory for shadow used ring.\n");
276 vq->batch_copy_elems = rte_malloc(NULL,
277 vq->size * sizeof(struct batch_copy_elem),
278 RTE_CACHE_LINE_SIZE);
279 if (!vq->batch_copy_elems) {
280 RTE_LOG(ERR, VHOST_CONFIG,
281 "failed to allocate memory for batching copy.\n");
289 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
290 * same numa node as the memory of vring descriptor.
292 #ifdef RTE_LIBRTE_VHOST_NUMA
293 static struct virtio_net*
294 numa_realloc(struct virtio_net *dev, int index)
296 int oldnode, newnode;
297 struct virtio_net *old_dev;
298 struct vhost_virtqueue *old_vq, *vq;
299 struct zcopy_mbuf *new_zmbuf;
300 struct vring_used_elem *new_shadow_used_ring;
301 struct batch_copy_elem *new_batch_copy_elems;
305 vq = old_vq = dev->virtqueue[index];
307 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
308 MPOL_F_NODE | MPOL_F_ADDR);
310 /* check if we need to reallocate vq */
311 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
312 MPOL_F_NODE | MPOL_F_ADDR);
314 RTE_LOG(ERR, VHOST_CONFIG,
315 "Unable to get vq numa information.\n");
318 if (oldnode != newnode) {
319 RTE_LOG(INFO, VHOST_CONFIG,
320 "reallocate vq from %d to %d node\n", oldnode, newnode);
321 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
325 memcpy(vq, old_vq, sizeof(*vq));
326 TAILQ_INIT(&vq->zmbuf_list);
328 new_zmbuf = rte_malloc_socket(NULL, vq->zmbuf_size *
329 sizeof(struct zcopy_mbuf), 0, newnode);
331 rte_free(vq->zmbufs);
332 vq->zmbufs = new_zmbuf;
335 new_shadow_used_ring = rte_malloc_socket(NULL,
336 vq->size * sizeof(struct vring_used_elem),
339 if (new_shadow_used_ring) {
340 rte_free(vq->shadow_used_ring);
341 vq->shadow_used_ring = new_shadow_used_ring;
344 new_batch_copy_elems = rte_malloc_socket(NULL,
345 vq->size * sizeof(struct batch_copy_elem),
348 if (new_batch_copy_elems) {
349 rte_free(vq->batch_copy_elems);
350 vq->batch_copy_elems = new_batch_copy_elems;
356 /* check if we need to reallocate dev */
357 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
358 MPOL_F_NODE | MPOL_F_ADDR);
360 RTE_LOG(ERR, VHOST_CONFIG,
361 "Unable to get dev numa information.\n");
364 if (oldnode != newnode) {
365 RTE_LOG(INFO, VHOST_CONFIG,
366 "reallocate dev from %d to %d node\n",
368 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
374 memcpy(dev, old_dev, sizeof(*dev));
379 dev->virtqueue[index] = vq;
380 vhost_devices[dev->vid] = dev;
383 vhost_user_iotlb_init(dev, index);
388 static struct virtio_net*
389 numa_realloc(struct virtio_net *dev, int index __rte_unused)
395 /* Converts QEMU virtual address to Vhost virtual address. */
397 qva_to_vva(struct virtio_net *dev, uint64_t qva)
399 struct rte_vhost_mem_region *reg;
402 /* Find the region where the address lives. */
403 for (i = 0; i < dev->mem->nregions; i++) {
404 reg = &dev->mem->regions[i];
406 if (qva >= reg->guest_user_addr &&
407 qva < reg->guest_user_addr + reg->size) {
408 return qva - reg->guest_user_addr +
418 * Converts ring address to Vhost virtual address.
419 * If IOMMU is enabled, the ring address is a guest IO virtual address,
420 * else it is a QEMU virtual address.
423 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
424 uint64_t ra, uint64_t size)
426 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
429 vva = vhost_user_iotlb_cache_find(vq, ra,
430 &size, VHOST_ACCESS_RW);
432 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
437 return qva_to_vva(dev, ra);
440 static struct virtio_net *
441 translate_ring_addresses(struct virtio_net *dev, int vq_index)
443 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
444 struct vhost_vring_addr *addr = &vq->ring_addrs;
446 /* The addresses are converted from QEMU virtual to Vhost virtual. */
447 if (vq->desc && vq->avail && vq->used)
450 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
451 vq, addr->desc_user_addr, sizeof(struct vring_desc));
453 RTE_LOG(DEBUG, VHOST_CONFIG,
454 "(%d) failed to find desc ring address.\n",
459 dev = numa_realloc(dev, vq_index);
460 vq = dev->virtqueue[vq_index];
461 addr = &vq->ring_addrs;
463 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
464 vq, addr->avail_user_addr, sizeof(struct vring_avail));
465 if (vq->avail == 0) {
466 RTE_LOG(DEBUG, VHOST_CONFIG,
467 "(%d) failed to find avail ring address.\n",
472 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
473 vq, addr->used_user_addr, sizeof(struct vring_used));
475 RTE_LOG(DEBUG, VHOST_CONFIG,
476 "(%d) failed to find used ring address.\n",
481 if (vq->last_used_idx != vq->used->idx) {
482 RTE_LOG(WARNING, VHOST_CONFIG,
483 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
484 "some packets maybe resent for Tx and dropped for Rx\n",
485 vq->last_used_idx, vq->used->idx);
486 vq->last_used_idx = vq->used->idx;
487 vq->last_avail_idx = vq->used->idx;
490 vq->log_guest_addr = addr->log_guest_addr;
492 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
494 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
495 dev->vid, vq->avail);
496 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
498 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
499 dev->vid, vq->log_guest_addr);
505 * The virtio device sends us the desc, used and avail ring addresses.
506 * This function then converts these to our address space.
509 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
511 struct vhost_virtqueue *vq;
512 struct vhost_vring_addr *addr = &msg->payload.addr;
513 struct virtio_net *dev = *pdev;
515 if (dev->mem == NULL)
518 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
519 vq = dev->virtqueue[msg->payload.addr.index];
522 * Rings addresses should not be interpreted as long as the ring is not
523 * started and enabled
525 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
527 vring_invalidate(dev, vq);
529 if (vq->enabled && (dev->features &
530 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
531 dev = translate_ring_addresses(dev, msg->payload.addr.index);
542 * The virtio device sends us the available ring last used index.
545 vhost_user_set_vring_base(struct virtio_net *dev,
548 dev->virtqueue[msg->payload.state.index]->last_used_idx =
549 msg->payload.state.num;
550 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
551 msg->payload.state.num;
557 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
558 uint64_t host_phys_addr, uint64_t size)
560 struct guest_page *page, *last_page;
562 if (dev->nr_guest_pages == dev->max_guest_pages) {
563 dev->max_guest_pages *= 2;
564 dev->guest_pages = realloc(dev->guest_pages,
565 dev->max_guest_pages * sizeof(*page));
568 if (dev->nr_guest_pages > 0) {
569 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
570 /* merge if the two pages are continuous */
571 if (host_phys_addr == last_page->host_phys_addr +
573 last_page->size += size;
578 page = &dev->guest_pages[dev->nr_guest_pages++];
579 page->guest_phys_addr = guest_phys_addr;
580 page->host_phys_addr = host_phys_addr;
585 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
588 uint64_t reg_size = reg->size;
589 uint64_t host_user_addr = reg->host_user_addr;
590 uint64_t guest_phys_addr = reg->guest_phys_addr;
591 uint64_t host_phys_addr;
594 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
595 size = page_size - (guest_phys_addr & (page_size - 1));
596 size = RTE_MIN(size, reg_size);
598 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
599 host_user_addr += size;
600 guest_phys_addr += size;
603 while (reg_size > 0) {
604 size = RTE_MIN(reg_size, page_size);
605 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
607 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
609 host_user_addr += size;
610 guest_phys_addr += size;
615 #ifdef RTE_LIBRTE_VHOST_DEBUG
616 /* TODO: enable it only in debug mode? */
618 dump_guest_pages(struct virtio_net *dev)
621 struct guest_page *page;
623 for (i = 0; i < dev->nr_guest_pages; i++) {
624 page = &dev->guest_pages[i];
626 RTE_LOG(INFO, VHOST_CONFIG,
627 "guest physical page region %u\n"
628 "\t guest_phys_addr: %" PRIx64 "\n"
629 "\t host_phys_addr : %" PRIx64 "\n"
630 "\t size : %" PRIx64 "\n",
632 page->guest_phys_addr,
633 page->host_phys_addr,
638 #define dump_guest_pages(dev)
642 vhost_memory_changed(struct VhostUserMemory *new,
643 struct rte_vhost_memory *old)
647 if (new->nregions != old->nregions)
650 for (i = 0; i < new->nregions; ++i) {
651 VhostUserMemoryRegion *new_r = &new->regions[i];
652 struct rte_vhost_mem_region *old_r = &old->regions[i];
654 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
656 if (new_r->memory_size != old_r->size)
658 if (new_r->userspace_addr != old_r->guest_user_addr)
666 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
668 struct VhostUserMemory memory = pmsg->payload.memory;
669 struct rte_vhost_mem_region *reg;
672 uint64_t mmap_offset;
677 if (memory.nregions > VHOST_MEMORY_MAX_NREGIONS) {
678 RTE_LOG(ERR, VHOST_CONFIG,
679 "too many memory regions (%u)\n", memory.nregions);
683 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
684 RTE_LOG(INFO, VHOST_CONFIG,
685 "(%d) memory regions not changed\n", dev->vid);
687 for (i = 0; i < memory.nregions; i++)
694 free_mem_region(dev);
699 dev->nr_guest_pages = 0;
700 if (!dev->guest_pages) {
701 dev->max_guest_pages = 8;
702 dev->guest_pages = malloc(dev->max_guest_pages *
703 sizeof(struct guest_page));
704 if (dev->guest_pages == NULL) {
705 RTE_LOG(ERR, VHOST_CONFIG,
706 "(%d) failed to allocate memory "
707 "for dev->guest_pages\n",
713 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
714 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
715 if (dev->mem == NULL) {
716 RTE_LOG(ERR, VHOST_CONFIG,
717 "(%d) failed to allocate memory for dev->mem\n",
721 dev->mem->nregions = memory.nregions;
723 for (i = 0; i < memory.nregions; i++) {
725 reg = &dev->mem->regions[i];
727 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
728 reg->guest_user_addr = memory.regions[i].userspace_addr;
729 reg->size = memory.regions[i].memory_size;
732 mmap_offset = memory.regions[i].mmap_offset;
733 mmap_size = reg->size + mmap_offset;
735 /* mmap() without flag of MAP_ANONYMOUS, should be called
736 * with length argument aligned with hugepagesz at older
737 * longterm version Linux, like 2.6.32 and 3.2.72, or
738 * mmap() will fail with EINVAL.
740 * to avoid failure, make sure in caller to keep length
743 alignment = get_blk_size(fd);
744 if (alignment == (uint64_t)-1) {
745 RTE_LOG(ERR, VHOST_CONFIG,
746 "couldn't get hugepage size through fstat\n");
749 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
751 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
752 MAP_SHARED | MAP_POPULATE, fd, 0);
754 if (mmap_addr == MAP_FAILED) {
755 RTE_LOG(ERR, VHOST_CONFIG,
756 "mmap region %u failed.\n", i);
760 reg->mmap_addr = mmap_addr;
761 reg->mmap_size = mmap_size;
762 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
765 if (dev->dequeue_zero_copy)
766 add_guest_pages(dev, reg, alignment);
768 RTE_LOG(INFO, VHOST_CONFIG,
769 "guest memory region %u, size: 0x%" PRIx64 "\n"
770 "\t guest physical addr: 0x%" PRIx64 "\n"
771 "\t guest virtual addr: 0x%" PRIx64 "\n"
772 "\t host virtual addr: 0x%" PRIx64 "\n"
773 "\t mmap addr : 0x%" PRIx64 "\n"
774 "\t mmap size : 0x%" PRIx64 "\n"
775 "\t mmap align: 0x%" PRIx64 "\n"
776 "\t mmap off : 0x%" PRIx64 "\n",
778 reg->guest_phys_addr,
779 reg->guest_user_addr,
781 (uint64_t)(uintptr_t)mmap_addr,
787 dump_guest_pages(dev);
792 free_mem_region(dev);
799 vq_is_ready(struct vhost_virtqueue *vq)
801 return vq && vq->desc && vq->avail && vq->used &&
802 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
803 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
807 virtio_is_ready(struct virtio_net *dev)
809 struct vhost_virtqueue *vq;
812 if (dev->nr_vring == 0)
815 for (i = 0; i < dev->nr_vring; i++) {
816 vq = dev->virtqueue[i];
818 if (!vq_is_ready(vq))
822 RTE_LOG(INFO, VHOST_CONFIG,
823 "virtio is now ready for processing.\n");
828 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
830 struct vhost_vring_file file;
831 struct vhost_virtqueue *vq;
833 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
834 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
835 file.fd = VIRTIO_INVALID_EVENTFD;
837 file.fd = pmsg->fds[0];
838 RTE_LOG(INFO, VHOST_CONFIG,
839 "vring call idx:%d file:%d\n", file.index, file.fd);
841 vq = dev->virtqueue[file.index];
845 vq->callfd = file.fd;
849 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
851 struct vhost_vring_file file;
852 struct vhost_virtqueue *vq;
853 struct virtio_net *dev = *pdev;
855 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
856 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
857 file.fd = VIRTIO_INVALID_EVENTFD;
859 file.fd = pmsg->fds[0];
860 RTE_LOG(INFO, VHOST_CONFIG,
861 "vring kick idx:%d file:%d\n", file.index, file.fd);
863 /* Interpret ring addresses only when ring is started. */
864 dev = translate_ring_addresses(dev, file.index);
870 vq = dev->virtqueue[file.index];
873 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
874 * the ring starts already enabled. Otherwise, it is enabled via
875 * the SET_VRING_ENABLE message.
877 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
882 vq->kickfd = file.fd;
886 free_zmbufs(struct vhost_virtqueue *vq)
888 struct zcopy_mbuf *zmbuf, *next;
890 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
891 zmbuf != NULL; zmbuf = next) {
892 next = TAILQ_NEXT(zmbuf, next);
894 rte_pktmbuf_free(zmbuf->mbuf);
895 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
898 rte_free(vq->zmbufs);
902 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
905 vhost_user_get_vring_base(struct virtio_net *dev,
908 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
910 /* We have to stop the queue (virtio) if it is running. */
911 if (dev->flags & VIRTIO_DEV_RUNNING) {
912 dev->flags &= ~VIRTIO_DEV_RUNNING;
913 dev->notify_ops->destroy_device(dev->vid);
916 dev->flags &= ~VIRTIO_DEV_READY;
918 /* Here we are safe to get the last used index */
919 msg->payload.state.num = vq->last_used_idx;
921 RTE_LOG(INFO, VHOST_CONFIG,
922 "vring base idx:%d file:%d\n", msg->payload.state.index,
923 msg->payload.state.num);
925 * Based on current qemu vhost-user implementation, this message is
926 * sent and only sent in vhost_vring_stop.
927 * TODO: cleanup the vring, it isn't usable since here.
932 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
934 if (dev->dequeue_zero_copy)
936 rte_free(vq->shadow_used_ring);
937 vq->shadow_used_ring = NULL;
939 rte_free(vq->batch_copy_elems);
940 vq->batch_copy_elems = NULL;
946 * when virtio queues are ready to work, qemu will send us to
947 * enable the virtio queue pair.
950 vhost_user_set_vring_enable(struct virtio_net *dev,
953 int enable = (int)msg->payload.state.num;
955 RTE_LOG(INFO, VHOST_CONFIG,
956 "set queue enable: %d to qp idx: %d\n",
957 enable, msg->payload.state.index);
959 if (dev->notify_ops->vring_state_changed)
960 dev->notify_ops->vring_state_changed(dev->vid,
961 msg->payload.state.index, enable);
963 dev->virtqueue[msg->payload.state.index]->enabled = enable;
969 vhost_user_get_protocol_features(struct virtio_net *dev,
970 struct VhostUserMsg *msg)
972 uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
974 rte_vhost_driver_get_features(dev->ifname, &features);
977 * REPLY_ACK protocol feature is only mandatory for now
978 * for IOMMU feature. If IOMMU is explicitly disabled by the
979 * application, disable also REPLY_ACK feature for older buggy
980 * Qemu versions (from v2.7.0 to v2.9.0).
982 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
983 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
985 msg->payload.u64 = protocol_features;
986 msg->size = sizeof(msg->payload.u64);
990 vhost_user_set_protocol_features(struct virtio_net *dev,
991 uint64_t protocol_features)
993 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
996 dev->protocol_features = protocol_features;
1000 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
1002 int fd = msg->fds[0];
1007 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
1011 if (msg->size != sizeof(VhostUserLog)) {
1012 RTE_LOG(ERR, VHOST_CONFIG,
1013 "invalid log base msg size: %"PRId32" != %d\n",
1014 msg->size, (int)sizeof(VhostUserLog));
1018 size = msg->payload.log.mmap_size;
1019 off = msg->payload.log.mmap_offset;
1021 /* Don't allow mmap_offset to point outside the mmap region */
1023 RTE_LOG(ERR, VHOST_CONFIG,
1024 "log offset %#"PRIx64" exceeds log size %#"PRIx64"\n",
1029 RTE_LOG(INFO, VHOST_CONFIG,
1030 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1034 * mmap from 0 to workaround a hugepage mmap bug: mmap will
1035 * fail when offset is not page size aligned.
1037 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1039 if (addr == MAP_FAILED) {
1040 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1045 * Free previously mapped log memory on occasionally
1046 * multiple VHOST_USER_SET_LOG_BASE.
1048 if (dev->log_addr) {
1049 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1051 dev->log_addr = (uint64_t)(uintptr_t)addr;
1052 dev->log_base = dev->log_addr + off;
1053 dev->log_size = size;
1059 * An rarp packet is constructed and broadcasted to notify switches about
1060 * the new location of the migrated VM, so that packets from outside will
1061 * not be lost after migration.
1063 * However, we don't actually "send" a rarp packet here, instead, we set
1064 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1067 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
1069 uint8_t *mac = (uint8_t *)&msg->payload.u64;
1071 RTE_LOG(DEBUG, VHOST_CONFIG,
1072 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1073 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1074 memcpy(dev->mac.addr_bytes, mac, 6);
1077 * Set the flag to inject a RARP broadcast packet at
1078 * rte_vhost_dequeue_burst().
1080 * rte_smp_wmb() is for making sure the mac is copied
1081 * before the flag is set.
1084 rte_atomic16_set(&dev->broadcast_rarp, 1);
1090 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1092 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1093 msg->payload.u64 > VIRTIO_MAX_MTU) {
1094 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1100 dev->mtu = msg->payload.u64;
1106 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1108 int fd = msg->fds[0];
1111 RTE_LOG(ERR, VHOST_CONFIG,
1112 "Invalid file descriptor for slave channel (%d)\n",
1117 dev->slave_req_fd = fd;
1123 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1125 struct vhost_vring_addr *ra;
1126 uint64_t start, end;
1129 end = start + imsg->size;
1131 ra = &vq->ring_addrs;
1132 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1134 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1136 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1143 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1144 struct vhost_iotlb_msg *imsg)
1146 uint64_t istart, iend, vstart, vend;
1148 istart = imsg->iova;
1149 iend = istart + imsg->size - 1;
1151 vstart = (uintptr_t)vq->desc;
1152 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1153 if (vstart <= iend && istart <= vend)
1156 vstart = (uintptr_t)vq->avail;
1157 vend = vstart + sizeof(struct vring_avail);
1158 vend += sizeof(uint16_t) * vq->size - 1;
1159 if (vstart <= iend && istart <= vend)
1162 vstart = (uintptr_t)vq->used;
1163 vend = vstart + sizeof(struct vring_used);
1164 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1165 if (vstart <= iend && istart <= vend)
1172 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1174 struct virtio_net *dev = *pdev;
1175 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1179 switch (imsg->type) {
1180 case VHOST_IOTLB_UPDATE:
1181 vva = qva_to_vva(dev, imsg->uaddr);
1185 for (i = 0; i < dev->nr_vring; i++) {
1186 struct vhost_virtqueue *vq = dev->virtqueue[i];
1188 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1189 imsg->size, imsg->perm);
1191 if (is_vring_iotlb_update(vq, imsg))
1192 *pdev = dev = translate_ring_addresses(dev, i);
1195 case VHOST_IOTLB_INVALIDATE:
1196 for (i = 0; i < dev->nr_vring; i++) {
1197 struct vhost_virtqueue *vq = dev->virtqueue[i];
1199 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1202 if (is_vring_iotlb_invalidate(vq, imsg))
1203 vring_invalidate(dev, vq);
1207 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1215 /* return bytes# of read on success or negative val on failure. */
1217 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1221 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1222 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1226 if (msg && msg->size) {
1227 if (msg->size > sizeof(msg->payload)) {
1228 RTE_LOG(ERR, VHOST_CONFIG,
1229 "invalid msg size: %d\n", msg->size);
1232 ret = read(sockfd, &msg->payload, msg->size);
1235 if (ret != (int)msg->size) {
1236 RTE_LOG(ERR, VHOST_CONFIG,
1237 "read control message failed\n");
1246 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1251 return send_fd_message(sockfd, (char *)msg,
1252 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1256 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1261 msg->flags &= ~VHOST_USER_VERSION_MASK;
1262 msg->flags &= ~VHOST_USER_NEED_REPLY;
1263 msg->flags |= VHOST_USER_VERSION;
1264 msg->flags |= VHOST_USER_REPLY_MASK;
1266 return send_vhost_message(sockfd, msg);
1270 * Allocate a queue pair if it hasn't been allocated yet
1273 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1277 switch (msg->request.master) {
1278 case VHOST_USER_SET_VRING_KICK:
1279 case VHOST_USER_SET_VRING_CALL:
1280 case VHOST_USER_SET_VRING_ERR:
1281 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1283 case VHOST_USER_SET_VRING_NUM:
1284 case VHOST_USER_SET_VRING_BASE:
1285 case VHOST_USER_SET_VRING_ENABLE:
1286 vring_idx = msg->payload.state.index;
1288 case VHOST_USER_SET_VRING_ADDR:
1289 vring_idx = msg->payload.addr.index;
1295 if (vring_idx >= VHOST_MAX_VRING) {
1296 RTE_LOG(ERR, VHOST_CONFIG,
1297 "invalid vring index: %u\n", vring_idx);
1301 if (dev->virtqueue[vring_idx])
1304 return alloc_vring_queue(dev, vring_idx);
1308 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1311 unsigned int vq_num = 0;
1313 while (vq_num < dev->nr_vring) {
1314 struct vhost_virtqueue *vq = dev->virtqueue[i];
1317 rte_spinlock_lock(&vq->access_lock);
1325 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1328 unsigned int vq_num = 0;
1330 while (vq_num < dev->nr_vring) {
1331 struct vhost_virtqueue *vq = dev->virtqueue[i];
1334 rte_spinlock_unlock(&vq->access_lock);
1342 vhost_user_msg_handler(int vid, int fd)
1344 struct virtio_net *dev;
1345 struct VhostUserMsg msg;
1347 int unlock_required = 0;
1349 dev = get_device(vid);
1353 if (!dev->notify_ops) {
1354 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1355 if (!dev->notify_ops) {
1356 RTE_LOG(ERR, VHOST_CONFIG,
1357 "failed to get callback ops for driver %s\n",
1363 ret = read_vhost_message(fd, &msg);
1364 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1366 RTE_LOG(ERR, VHOST_CONFIG,
1367 "vhost read message failed\n");
1369 RTE_LOG(INFO, VHOST_CONFIG,
1370 "vhost peer closed\n");
1372 RTE_LOG(ERR, VHOST_CONFIG,
1373 "vhost read incorrect message\n");
1379 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1380 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1381 vhost_message_str[msg.request.master]);
1383 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1384 vhost_message_str[msg.request.master]);
1386 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1388 RTE_LOG(ERR, VHOST_CONFIG,
1389 "failed to alloc queue\n");
1394 * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1395 * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1396 * and device is destroyed. destroy_device waits for queues to be
1397 * inactive, so it is safe. Otherwise taking the access_lock
1398 * would cause a dead lock.
1400 switch (msg.request.master) {
1401 case VHOST_USER_SET_FEATURES:
1402 case VHOST_USER_SET_PROTOCOL_FEATURES:
1403 case VHOST_USER_SET_OWNER:
1404 case VHOST_USER_SET_MEM_TABLE:
1405 case VHOST_USER_SET_LOG_BASE:
1406 case VHOST_USER_SET_LOG_FD:
1407 case VHOST_USER_SET_VRING_NUM:
1408 case VHOST_USER_SET_VRING_ADDR:
1409 case VHOST_USER_SET_VRING_BASE:
1410 case VHOST_USER_SET_VRING_KICK:
1411 case VHOST_USER_SET_VRING_CALL:
1412 case VHOST_USER_SET_VRING_ERR:
1413 case VHOST_USER_SET_VRING_ENABLE:
1414 case VHOST_USER_SEND_RARP:
1415 case VHOST_USER_NET_SET_MTU:
1416 case VHOST_USER_SET_SLAVE_REQ_FD:
1417 vhost_user_lock_all_queue_pairs(dev);
1418 unlock_required = 1;
1425 switch (msg.request.master) {
1426 case VHOST_USER_GET_FEATURES:
1427 msg.payload.u64 = vhost_user_get_features(dev);
1428 msg.size = sizeof(msg.payload.u64);
1429 send_vhost_reply(fd, &msg);
1431 case VHOST_USER_SET_FEATURES:
1432 ret = vhost_user_set_features(dev, msg.payload.u64);
1437 case VHOST_USER_GET_PROTOCOL_FEATURES:
1438 vhost_user_get_protocol_features(dev, &msg);
1439 send_vhost_reply(fd, &msg);
1441 case VHOST_USER_SET_PROTOCOL_FEATURES:
1442 vhost_user_set_protocol_features(dev, msg.payload.u64);
1445 case VHOST_USER_SET_OWNER:
1446 vhost_user_set_owner();
1448 case VHOST_USER_RESET_OWNER:
1449 vhost_user_reset_owner(dev);
1452 case VHOST_USER_SET_MEM_TABLE:
1453 ret = vhost_user_set_mem_table(dev, &msg);
1456 case VHOST_USER_SET_LOG_BASE:
1457 vhost_user_set_log_base(dev, &msg);
1459 /* it needs a reply */
1460 msg.size = sizeof(msg.payload.u64);
1461 send_vhost_reply(fd, &msg);
1463 case VHOST_USER_SET_LOG_FD:
1465 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1468 case VHOST_USER_SET_VRING_NUM:
1469 vhost_user_set_vring_num(dev, &msg);
1471 case VHOST_USER_SET_VRING_ADDR:
1472 vhost_user_set_vring_addr(&dev, &msg);
1474 case VHOST_USER_SET_VRING_BASE:
1475 vhost_user_set_vring_base(dev, &msg);
1478 case VHOST_USER_GET_VRING_BASE:
1479 vhost_user_get_vring_base(dev, &msg);
1480 msg.size = sizeof(msg.payload.state);
1481 send_vhost_reply(fd, &msg);
1484 case VHOST_USER_SET_VRING_KICK:
1485 vhost_user_set_vring_kick(&dev, &msg);
1487 case VHOST_USER_SET_VRING_CALL:
1488 vhost_user_set_vring_call(dev, &msg);
1491 case VHOST_USER_SET_VRING_ERR:
1492 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1494 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1497 case VHOST_USER_GET_QUEUE_NUM:
1498 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1499 msg.size = sizeof(msg.payload.u64);
1500 send_vhost_reply(fd, &msg);
1503 case VHOST_USER_SET_VRING_ENABLE:
1504 vhost_user_set_vring_enable(dev, &msg);
1506 case VHOST_USER_SEND_RARP:
1507 vhost_user_send_rarp(dev, &msg);
1510 case VHOST_USER_NET_SET_MTU:
1511 ret = vhost_user_net_set_mtu(dev, &msg);
1514 case VHOST_USER_SET_SLAVE_REQ_FD:
1515 ret = vhost_user_set_req_fd(dev, &msg);
1518 case VHOST_USER_IOTLB_MSG:
1519 ret = vhost_user_iotlb_msg(&dev, &msg);
1528 if (unlock_required)
1529 vhost_user_unlock_all_queue_pairs(dev);
1531 if (msg.flags & VHOST_USER_NEED_REPLY) {
1532 msg.payload.u64 = !!ret;
1533 msg.size = sizeof(msg.payload.u64);
1534 send_vhost_reply(fd, &msg);
1537 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1538 dev->flags |= VIRTIO_DEV_READY;
1540 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1541 if (dev->dequeue_zero_copy) {
1542 RTE_LOG(INFO, VHOST_CONFIG,
1543 "dequeue zero copy is enabled\n");
1546 if (dev->notify_ops->new_device(dev->vid) == 0)
1547 dev->flags |= VIRTIO_DEV_RUNNING;
1555 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1558 struct VhostUserMsg msg = {
1559 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1560 .flags = VHOST_USER_VERSION,
1561 .size = sizeof(msg.payload.iotlb),
1565 .type = VHOST_IOTLB_MISS,
1569 ret = send_vhost_message(dev->slave_req_fd, &msg);
1571 RTE_LOG(ERR, VHOST_CONFIG,
1572 "Failed to send IOTLB miss message (%d)\n",