4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/types.h>
43 #ifdef RTE_LIBRTE_VHOST_NUMA
47 #include <rte_common.h>
48 #include <rte_malloc.h>
53 #include "vhost_user.h"
55 #define VIRTIO_MIN_MTU 68
56 #define VIRTIO_MAX_MTU 65535
58 static const char *vhost_message_str[VHOST_USER_MAX] = {
59 [VHOST_USER_NONE] = "VHOST_USER_NONE",
60 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
61 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
62 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
63 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
64 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
65 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
66 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
67 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
68 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
69 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
70 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
71 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
72 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
73 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
74 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
75 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
76 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
77 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
78 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
79 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
80 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
81 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
90 ret = fstat(fd, &stat);
91 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
95 free_mem_region(struct virtio_net *dev)
98 struct rte_vhost_mem_region *reg;
100 if (!dev || !dev->mem)
103 for (i = 0; i < dev->mem->nregions; i++) {
104 reg = &dev->mem->regions[i];
105 if (reg->host_user_addr) {
106 munmap(reg->mmap_addr, reg->mmap_size);
113 vhost_backend_cleanup(struct virtio_net *dev)
116 free_mem_region(dev);
121 free(dev->guest_pages);
122 dev->guest_pages = NULL;
125 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
129 if (dev->slave_req_fd >= 0) {
130 close(dev->slave_req_fd);
131 dev->slave_req_fd = -1;
136 * This function just returns success at the moment unless
137 * the device hasn't been initialised.
140 vhost_user_set_owner(void)
146 vhost_user_reset_owner(struct virtio_net *dev)
148 if (dev->flags & VIRTIO_DEV_RUNNING) {
149 dev->flags &= ~VIRTIO_DEV_RUNNING;
150 dev->notify_ops->destroy_device(dev->vid);
153 cleanup_device(dev, 0);
159 * The features that we support are requested.
162 vhost_user_get_features(struct virtio_net *dev)
164 uint64_t features = 0;
166 rte_vhost_driver_get_features(dev->ifname, &features);
171 * We receive the negotiated features supported by us and the virtio device.
174 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
176 uint64_t vhost_features = 0;
178 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
179 if (features & ~vhost_features) {
180 RTE_LOG(ERR, VHOST_CONFIG,
181 "(%d) received invalid negotiated features.\n",
186 if ((dev->flags & VIRTIO_DEV_RUNNING) && dev->features != features) {
187 if (dev->notify_ops->features_changed)
188 dev->notify_ops->features_changed(dev->vid, features);
191 dev->features = features;
193 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
194 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
196 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
198 LOG_DEBUG(VHOST_CONFIG,
199 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
201 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
202 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
208 * The virtio device sends us the size of the descriptor ring.
211 vhost_user_set_vring_num(struct virtio_net *dev,
214 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
216 vq->size = msg->payload.state.num;
218 if (dev->dequeue_zero_copy) {
220 vq->last_zmbuf_idx = 0;
221 vq->zmbuf_size = vq->size;
222 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
223 sizeof(struct zcopy_mbuf), 0);
224 if (vq->zmbufs == NULL) {
225 RTE_LOG(WARNING, VHOST_CONFIG,
226 "failed to allocate mem for zero copy; "
227 "zero copy is force disabled\n");
228 dev->dequeue_zero_copy = 0;
232 vq->shadow_used_ring = rte_malloc(NULL,
233 vq->size * sizeof(struct vring_used_elem),
234 RTE_CACHE_LINE_SIZE);
235 if (!vq->shadow_used_ring) {
236 RTE_LOG(ERR, VHOST_CONFIG,
237 "failed to allocate memory for shadow used ring.\n");
241 vq->batch_copy_elems = rte_malloc(NULL,
242 vq->size * sizeof(struct batch_copy_elem),
243 RTE_CACHE_LINE_SIZE);
244 if (!vq->batch_copy_elems) {
245 RTE_LOG(ERR, VHOST_CONFIG,
246 "failed to allocate memory for batching copy.\n");
254 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
255 * same numa node as the memory of vring descriptor.
257 #ifdef RTE_LIBRTE_VHOST_NUMA
258 static struct virtio_net*
259 numa_realloc(struct virtio_net *dev, int index)
261 int oldnode, newnode;
262 struct virtio_net *old_dev;
263 struct vhost_virtqueue *old_vq, *vq;
267 vq = old_vq = dev->virtqueue[index];
269 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
270 MPOL_F_NODE | MPOL_F_ADDR);
272 /* check if we need to reallocate vq */
273 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
274 MPOL_F_NODE | MPOL_F_ADDR);
276 RTE_LOG(ERR, VHOST_CONFIG,
277 "Unable to get vq numa information.\n");
280 if (oldnode != newnode) {
281 RTE_LOG(INFO, VHOST_CONFIG,
282 "reallocate vq from %d to %d node\n", oldnode, newnode);
283 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
287 memcpy(vq, old_vq, sizeof(*vq));
291 /* check if we need to reallocate dev */
292 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
293 MPOL_F_NODE | MPOL_F_ADDR);
295 RTE_LOG(ERR, VHOST_CONFIG,
296 "Unable to get dev numa information.\n");
299 if (oldnode != newnode) {
300 RTE_LOG(INFO, VHOST_CONFIG,
301 "reallocate dev from %d to %d node\n",
303 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
309 memcpy(dev, old_dev, sizeof(*dev));
314 dev->virtqueue[index] = vq;
315 vhost_devices[dev->vid] = dev;
318 vhost_user_iotlb_init(dev, index);
323 static struct virtio_net*
324 numa_realloc(struct virtio_net *dev, int index __rte_unused)
330 /* Converts QEMU virtual address to Vhost virtual address. */
332 qva_to_vva(struct virtio_net *dev, uint64_t qva, uint64_t *len)
334 struct rte_vhost_mem_region *r;
337 /* Find the region where the address lives. */
338 for (i = 0; i < dev->mem->nregions; i++) {
339 r = &dev->mem->regions[i];
341 if (qva >= r->guest_user_addr &&
342 qva < r->guest_user_addr + r->size) {
344 if (unlikely(*len > r->guest_user_addr + r->size - qva))
345 *len = r->guest_user_addr + r->size - qva;
347 return qva - r->guest_user_addr +
358 * Converts ring address to Vhost virtual address.
359 * If IOMMU is enabled, the ring address is a guest IO virtual address,
360 * else it is a QEMU virtual address.
363 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
364 uint64_t ra, uint64_t *size)
366 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
369 vva = vhost_user_iotlb_cache_find(vq, ra,
370 size, VHOST_ACCESS_RW);
372 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
377 return qva_to_vva(dev, ra, size);
380 static struct virtio_net *
381 translate_ring_addresses(struct virtio_net *dev, int vq_index)
383 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
384 struct vhost_vring_addr *addr = &vq->ring_addrs;
387 /* The addresses are converted from QEMU virtual to Vhost virtual. */
388 if (vq->desc && vq->avail && vq->used)
391 len = sizeof(struct vring_desc) * vq->size;
392 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
393 vq, addr->desc_user_addr, &len);
394 if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
395 RTE_LOG(DEBUG, VHOST_CONFIG,
396 "(%d) failed to map desc ring.\n",
401 dev = numa_realloc(dev, vq_index);
402 vq = dev->virtqueue[vq_index];
403 addr = &vq->ring_addrs;
405 len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
406 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
407 vq, addr->avail_user_addr, &len);
408 if (vq->avail == 0 ||
409 len != sizeof(struct vring_avail) +
410 sizeof(uint16_t) * vq->size) {
411 RTE_LOG(DEBUG, VHOST_CONFIG,
412 "(%d) failed to map avail ring.\n",
417 len = sizeof(struct vring_used) +
418 sizeof(struct vring_used_elem) * vq->size;
419 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
420 vq, addr->used_user_addr, &len);
421 if (vq->used == 0 || len != sizeof(struct vring_used) +
422 sizeof(struct vring_used_elem) * vq->size) {
423 RTE_LOG(DEBUG, VHOST_CONFIG,
424 "(%d) failed to map used ring.\n",
429 if (vq->last_used_idx != vq->used->idx) {
430 RTE_LOG(WARNING, VHOST_CONFIG,
431 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
432 "some packets maybe resent for Tx and dropped for Rx\n",
433 vq->last_used_idx, vq->used->idx);
434 vq->last_used_idx = vq->used->idx;
435 vq->last_avail_idx = vq->used->idx;
438 vq->log_guest_addr = addr->log_guest_addr;
440 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
442 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
443 dev->vid, vq->avail);
444 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
446 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
447 dev->vid, vq->log_guest_addr);
453 * The virtio device sends us the desc, used and avail ring addresses.
454 * This function then converts these to our address space.
457 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
459 struct vhost_virtqueue *vq;
460 struct vhost_vring_addr *addr = &msg->payload.addr;
461 struct virtio_net *dev = *pdev;
463 if (dev->mem == NULL)
466 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
467 vq = dev->virtqueue[msg->payload.addr.index];
470 * Rings addresses should not be interpreted as long as the ring is not
471 * started and enabled
473 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
475 vring_invalidate(dev, vq);
477 if (vq->enabled && (dev->features &
478 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
479 dev = translate_ring_addresses(dev, msg->payload.addr.index);
490 * The virtio device sends us the available ring last used index.
493 vhost_user_set_vring_base(struct virtio_net *dev,
496 dev->virtqueue[msg->payload.state.index]->last_used_idx =
497 msg->payload.state.num;
498 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
499 msg->payload.state.num;
505 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
506 uint64_t host_phys_addr, uint64_t size)
508 struct guest_page *page, *last_page;
510 if (dev->nr_guest_pages == dev->max_guest_pages) {
511 dev->max_guest_pages *= 2;
512 dev->guest_pages = realloc(dev->guest_pages,
513 dev->max_guest_pages * sizeof(*page));
514 if (!dev->guest_pages) {
515 RTE_LOG(ERR, VHOST_CONFIG, "cannot realloc guest_pages\n");
520 if (dev->nr_guest_pages > 0) {
521 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
522 /* merge if the two pages are continuous */
523 if (host_phys_addr == last_page->host_phys_addr +
525 last_page->size += size;
530 page = &dev->guest_pages[dev->nr_guest_pages++];
531 page->guest_phys_addr = guest_phys_addr;
532 page->host_phys_addr = host_phys_addr;
539 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
542 uint64_t reg_size = reg->size;
543 uint64_t host_user_addr = reg->host_user_addr;
544 uint64_t guest_phys_addr = reg->guest_phys_addr;
545 uint64_t host_phys_addr;
548 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
549 size = page_size - (guest_phys_addr & (page_size - 1));
550 size = RTE_MIN(size, reg_size);
552 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size) < 0)
555 host_user_addr += size;
556 guest_phys_addr += size;
559 while (reg_size > 0) {
560 size = RTE_MIN(reg_size, page_size);
561 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
563 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr,
567 host_user_addr += size;
568 guest_phys_addr += size;
575 #ifdef RTE_LIBRTE_VHOST_DEBUG
576 /* TODO: enable it only in debug mode? */
578 dump_guest_pages(struct virtio_net *dev)
581 struct guest_page *page;
583 for (i = 0; i < dev->nr_guest_pages; i++) {
584 page = &dev->guest_pages[i];
586 RTE_LOG(INFO, VHOST_CONFIG,
587 "guest physical page region %u\n"
588 "\t guest_phys_addr: %" PRIx64 "\n"
589 "\t host_phys_addr : %" PRIx64 "\n"
590 "\t size : %" PRIx64 "\n",
592 page->guest_phys_addr,
593 page->host_phys_addr,
598 #define dump_guest_pages(dev)
602 vhost_memory_changed(struct VhostUserMemory *new,
603 struct rte_vhost_memory *old)
607 if (new->nregions != old->nregions)
610 for (i = 0; i < new->nregions; ++i) {
611 VhostUserMemoryRegion *new_r = &new->regions[i];
612 struct rte_vhost_mem_region *old_r = &old->regions[i];
614 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
616 if (new_r->memory_size != old_r->size)
618 if (new_r->userspace_addr != old_r->guest_user_addr)
626 vhost_user_set_mem_table(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
628 struct virtio_net *dev = *pdev;
629 struct VhostUserMemory memory = pmsg->payload.memory;
630 struct rte_vhost_mem_region *reg;
633 uint64_t mmap_offset;
638 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
639 RTE_LOG(INFO, VHOST_CONFIG,
640 "(%d) memory regions not changed\n", dev->vid);
642 for (i = 0; i < memory.nregions; i++)
649 free_mem_region(dev);
654 /* Flush IOTLB cache as previous HVAs are now invalid */
655 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
656 for (i = 0; i < dev->nr_vring; i++)
657 vhost_user_iotlb_flush_all(dev->virtqueue[i]);
659 dev->nr_guest_pages = 0;
660 if (!dev->guest_pages) {
661 dev->max_guest_pages = 8;
662 dev->guest_pages = malloc(dev->max_guest_pages *
663 sizeof(struct guest_page));
664 if (dev->guest_pages == NULL) {
665 RTE_LOG(ERR, VHOST_CONFIG,
666 "(%d) failed to allocate memory "
667 "for dev->guest_pages\n",
673 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
674 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
675 if (dev->mem == NULL) {
676 RTE_LOG(ERR, VHOST_CONFIG,
677 "(%d) failed to allocate memory for dev->mem\n",
681 dev->mem->nregions = memory.nregions;
683 for (i = 0; i < memory.nregions; i++) {
685 reg = &dev->mem->regions[i];
687 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
688 reg->guest_user_addr = memory.regions[i].userspace_addr;
689 reg->size = memory.regions[i].memory_size;
692 mmap_offset = memory.regions[i].mmap_offset;
693 mmap_size = reg->size + mmap_offset;
695 /* mmap() without flag of MAP_ANONYMOUS, should be called
696 * with length argument aligned with hugepagesz at older
697 * longterm version Linux, like 2.6.32 and 3.2.72, or
698 * mmap() will fail with EINVAL.
700 * to avoid failure, make sure in caller to keep length
703 alignment = get_blk_size(fd);
704 if (alignment == (uint64_t)-1) {
705 RTE_LOG(ERR, VHOST_CONFIG,
706 "couldn't get hugepage size through fstat\n");
709 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
711 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
712 MAP_SHARED | MAP_POPULATE, fd, 0);
714 if (mmap_addr == MAP_FAILED) {
715 RTE_LOG(ERR, VHOST_CONFIG,
716 "mmap region %u failed.\n", i);
720 reg->mmap_addr = mmap_addr;
721 reg->mmap_size = mmap_size;
722 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
725 if (dev->dequeue_zero_copy)
726 if (add_guest_pages(dev, reg, alignment) < 0) {
727 RTE_LOG(ERR, VHOST_CONFIG,
728 "adding guest pages to region %u failed.\n",
733 RTE_LOG(INFO, VHOST_CONFIG,
734 "guest memory region %u, size: 0x%" PRIx64 "\n"
735 "\t guest physical addr: 0x%" PRIx64 "\n"
736 "\t guest virtual addr: 0x%" PRIx64 "\n"
737 "\t host virtual addr: 0x%" PRIx64 "\n"
738 "\t mmap addr : 0x%" PRIx64 "\n"
739 "\t mmap size : 0x%" PRIx64 "\n"
740 "\t mmap align: 0x%" PRIx64 "\n"
741 "\t mmap off : 0x%" PRIx64 "\n",
743 reg->guest_phys_addr,
744 reg->guest_user_addr,
746 (uint64_t)(uintptr_t)mmap_addr,
752 for (i = 0; i < dev->nr_vring; i++) {
753 struct vhost_virtqueue *vq = dev->virtqueue[i];
755 if (vq->desc || vq->avail || vq->used) {
757 * If the memory table got updated, the ring addresses
758 * need to be translated again as virtual addresses have
761 vring_invalidate(dev, vq);
763 dev = translate_ring_addresses(dev, i);
771 dump_guest_pages(dev);
776 free_mem_region(dev);
783 vq_is_ready(struct vhost_virtqueue *vq)
785 return vq && vq->desc && vq->avail && vq->used &&
786 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
787 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
791 virtio_is_ready(struct virtio_net *dev)
793 struct vhost_virtqueue *vq;
796 if (dev->nr_vring == 0)
799 for (i = 0; i < dev->nr_vring; i++) {
800 vq = dev->virtqueue[i];
802 if (!vq_is_ready(vq))
806 RTE_LOG(INFO, VHOST_CONFIG,
807 "virtio is now ready for processing.\n");
812 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
814 struct vhost_vring_file file;
815 struct vhost_virtqueue *vq;
817 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
818 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
819 file.fd = VIRTIO_INVALID_EVENTFD;
821 file.fd = pmsg->fds[0];
822 RTE_LOG(INFO, VHOST_CONFIG,
823 "vring call idx:%d file:%d\n", file.index, file.fd);
825 vq = dev->virtqueue[file.index];
829 vq->callfd = file.fd;
833 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
835 struct vhost_vring_file file;
836 struct vhost_virtqueue *vq;
837 struct virtio_net *dev = *pdev;
839 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
840 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
841 file.fd = VIRTIO_INVALID_EVENTFD;
843 file.fd = pmsg->fds[0];
844 RTE_LOG(INFO, VHOST_CONFIG,
845 "vring kick idx:%d file:%d\n", file.index, file.fd);
847 /* Interpret ring addresses only when ring is started. */
848 dev = translate_ring_addresses(dev, file.index);
854 vq = dev->virtqueue[file.index];
857 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
858 * the ring starts already enabled. Otherwise, it is enabled via
859 * the SET_VRING_ENABLE message.
861 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
866 vq->kickfd = file.fd;
870 free_zmbufs(struct vhost_virtqueue *vq)
872 struct zcopy_mbuf *zmbuf, *next;
874 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
875 zmbuf != NULL; zmbuf = next) {
876 next = TAILQ_NEXT(zmbuf, next);
878 rte_pktmbuf_free(zmbuf->mbuf);
879 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
882 rte_free(vq->zmbufs);
886 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
889 vhost_user_get_vring_base(struct virtio_net *dev,
892 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
894 /* We have to stop the queue (virtio) if it is running. */
895 if (dev->flags & VIRTIO_DEV_RUNNING) {
896 dev->flags &= ~VIRTIO_DEV_RUNNING;
897 dev->notify_ops->destroy_device(dev->vid);
900 dev->flags &= ~VIRTIO_DEV_READY;
902 /* Here we are safe to get the last avail index */
903 msg->payload.state.num = vq->last_avail_idx;
905 RTE_LOG(INFO, VHOST_CONFIG,
906 "vring base idx:%d file:%d\n", msg->payload.state.index,
907 msg->payload.state.num);
909 * Based on current qemu vhost-user implementation, this message is
910 * sent and only sent in vhost_vring_stop.
911 * TODO: cleanup the vring, it isn't usable since here.
916 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
921 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
923 if (dev->dequeue_zero_copy)
925 rte_free(vq->shadow_used_ring);
926 vq->shadow_used_ring = NULL;
928 rte_free(vq->batch_copy_elems);
929 vq->batch_copy_elems = NULL;
935 * when virtio queues are ready to work, qemu will send us to
936 * enable the virtio queue pair.
939 vhost_user_set_vring_enable(struct virtio_net *dev,
942 int enable = (int)msg->payload.state.num;
944 RTE_LOG(INFO, VHOST_CONFIG,
945 "set queue enable: %d to qp idx: %d\n",
946 enable, msg->payload.state.index);
948 if (dev->notify_ops->vring_state_changed)
949 dev->notify_ops->vring_state_changed(dev->vid,
950 msg->payload.state.index, enable);
952 dev->virtqueue[msg->payload.state.index]->enabled = enable;
958 vhost_user_get_protocol_features(struct virtio_net *dev,
959 struct VhostUserMsg *msg)
961 uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
963 rte_vhost_driver_get_features(dev->ifname, &features);
966 * REPLY_ACK protocol feature is only mandatory for now
967 * for IOMMU feature. If IOMMU is explicitly disabled by the
968 * application, disable also REPLY_ACK feature for older buggy
969 * Qemu versions (from v2.7.0 to v2.9.0).
971 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
972 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
974 msg->payload.u64 = protocol_features;
975 msg->size = sizeof(msg->payload.u64);
979 vhost_user_set_protocol_features(struct virtio_net *dev,
980 uint64_t protocol_features)
982 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
985 dev->protocol_features = protocol_features;
989 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
991 int fd = msg->fds[0];
996 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
1000 if (msg->size != sizeof(VhostUserLog)) {
1001 RTE_LOG(ERR, VHOST_CONFIG,
1002 "invalid log base msg size: %"PRId32" != %d\n",
1003 msg->size, (int)sizeof(VhostUserLog));
1007 size = msg->payload.log.mmap_size;
1008 off = msg->payload.log.mmap_offset;
1009 RTE_LOG(INFO, VHOST_CONFIG,
1010 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1014 * mmap from 0 to workaround a hugepage mmap bug: mmap will
1015 * fail when offset is not page size aligned.
1017 addr = mmap(0, size + off, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1019 if (addr == MAP_FAILED) {
1020 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1025 * Free previously mapped log memory on occasionally
1026 * multiple VHOST_USER_SET_LOG_BASE.
1028 if (dev->log_addr) {
1029 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1031 dev->log_addr = (uint64_t)(uintptr_t)addr;
1032 dev->log_base = dev->log_addr + off;
1033 dev->log_size = size;
1039 * An rarp packet is constructed and broadcasted to notify switches about
1040 * the new location of the migrated VM, so that packets from outside will
1041 * not be lost after migration.
1043 * However, we don't actually "send" a rarp packet here, instead, we set
1044 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1047 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
1049 uint8_t *mac = (uint8_t *)&msg->payload.u64;
1051 RTE_LOG(DEBUG, VHOST_CONFIG,
1052 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1053 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1054 memcpy(dev->mac.addr_bytes, mac, 6);
1057 * Set the flag to inject a RARP broadcast packet at
1058 * rte_vhost_dequeue_burst().
1060 * rte_smp_wmb() is for making sure the mac is copied
1061 * before the flag is set.
1064 rte_atomic16_set(&dev->broadcast_rarp, 1);
1070 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1072 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1073 msg->payload.u64 > VIRTIO_MAX_MTU) {
1074 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1080 dev->mtu = msg->payload.u64;
1086 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1088 int fd = msg->fds[0];
1091 RTE_LOG(ERR, VHOST_CONFIG,
1092 "Invalid file descriptor for slave channel (%d)\n",
1097 dev->slave_req_fd = fd;
1103 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1105 struct vhost_vring_addr *ra;
1106 uint64_t start, end;
1109 end = start + imsg->size;
1111 ra = &vq->ring_addrs;
1112 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1114 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1116 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1123 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1124 struct vhost_iotlb_msg *imsg)
1126 uint64_t istart, iend, vstart, vend;
1128 istart = imsg->iova;
1129 iend = istart + imsg->size - 1;
1131 vstart = (uintptr_t)vq->desc;
1132 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1133 if (vstart <= iend && istart <= vend)
1136 vstart = (uintptr_t)vq->avail;
1137 vend = vstart + sizeof(struct vring_avail);
1138 vend += sizeof(uint16_t) * vq->size - 1;
1139 if (vstart <= iend && istart <= vend)
1142 vstart = (uintptr_t)vq->used;
1143 vend = vstart + sizeof(struct vring_used);
1144 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1145 if (vstart <= iend && istart <= vend)
1152 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1154 struct virtio_net *dev = *pdev;
1155 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1159 switch (imsg->type) {
1160 case VHOST_IOTLB_UPDATE:
1162 vva = qva_to_vva(dev, imsg->uaddr, &len);
1166 for (i = 0; i < dev->nr_vring; i++) {
1167 struct vhost_virtqueue *vq = dev->virtqueue[i];
1169 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1172 if (is_vring_iotlb_update(vq, imsg))
1173 *pdev = dev = translate_ring_addresses(dev, i);
1176 case VHOST_IOTLB_INVALIDATE:
1177 for (i = 0; i < dev->nr_vring; i++) {
1178 struct vhost_virtqueue *vq = dev->virtqueue[i];
1180 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1183 if (is_vring_iotlb_invalidate(vq, imsg))
1184 vring_invalidate(dev, vq);
1188 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1196 /* return bytes# of read on success or negative val on failure. */
1198 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1202 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1203 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1207 if (msg && msg->size) {
1208 if (msg->size > sizeof(msg->payload)) {
1209 RTE_LOG(ERR, VHOST_CONFIG,
1210 "invalid msg size: %d\n", msg->size);
1213 ret = read(sockfd, &msg->payload, msg->size);
1216 if (ret != (int)msg->size) {
1217 RTE_LOG(ERR, VHOST_CONFIG,
1218 "read control message failed\n");
1227 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1232 return send_fd_message(sockfd, (char *)msg,
1233 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1237 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1242 msg->flags &= ~VHOST_USER_VERSION_MASK;
1243 msg->flags &= ~VHOST_USER_NEED_REPLY;
1244 msg->flags |= VHOST_USER_VERSION;
1245 msg->flags |= VHOST_USER_REPLY_MASK;
1247 return send_vhost_message(sockfd, msg);
1251 * Allocate a queue pair if it hasn't been allocated yet
1254 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1258 switch (msg->request.master) {
1259 case VHOST_USER_SET_VRING_KICK:
1260 case VHOST_USER_SET_VRING_CALL:
1261 case VHOST_USER_SET_VRING_ERR:
1262 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1264 case VHOST_USER_SET_VRING_NUM:
1265 case VHOST_USER_SET_VRING_BASE:
1266 case VHOST_USER_SET_VRING_ENABLE:
1267 vring_idx = msg->payload.state.index;
1269 case VHOST_USER_SET_VRING_ADDR:
1270 vring_idx = msg->payload.addr.index;
1276 if (vring_idx >= VHOST_MAX_VRING) {
1277 RTE_LOG(ERR, VHOST_CONFIG,
1278 "invalid vring index: %u\n", vring_idx);
1282 if (dev->virtqueue[vring_idx])
1285 return alloc_vring_queue(dev, vring_idx);
1289 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1292 unsigned int vq_num = 0;
1294 while (vq_num < dev->nr_vring) {
1295 struct vhost_virtqueue *vq = dev->virtqueue[i];
1298 rte_spinlock_lock(&vq->access_lock);
1306 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1309 unsigned int vq_num = 0;
1311 while (vq_num < dev->nr_vring) {
1312 struct vhost_virtqueue *vq = dev->virtqueue[i];
1315 rte_spinlock_unlock(&vq->access_lock);
1323 vhost_user_msg_handler(int vid, int fd)
1325 struct virtio_net *dev;
1326 struct VhostUserMsg msg;
1328 int unlock_required = 0;
1330 dev = get_device(vid);
1334 if (!dev->notify_ops) {
1335 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1336 if (!dev->notify_ops) {
1337 RTE_LOG(ERR, VHOST_CONFIG,
1338 "failed to get callback ops for driver %s\n",
1344 ret = read_vhost_message(fd, &msg);
1345 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1347 RTE_LOG(ERR, VHOST_CONFIG,
1348 "vhost read message failed\n");
1350 RTE_LOG(INFO, VHOST_CONFIG,
1351 "vhost peer closed\n");
1353 RTE_LOG(ERR, VHOST_CONFIG,
1354 "vhost read incorrect message\n");
1360 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1361 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1362 vhost_message_str[msg.request.master]);
1364 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1365 vhost_message_str[msg.request.master]);
1367 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1369 RTE_LOG(ERR, VHOST_CONFIG,
1370 "failed to alloc queue\n");
1375 * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE,
1376 * since it is sent when virtio stops and device is destroyed.
1377 * destroy_device waits for queues to be inactive, so it is safe.
1378 * Otherwise taking the access_lock would cause a dead lock.
1380 switch (msg.request.master) {
1381 case VHOST_USER_SET_FEATURES:
1382 case VHOST_USER_SET_PROTOCOL_FEATURES:
1383 case VHOST_USER_SET_OWNER:
1384 case VHOST_USER_RESET_OWNER:
1385 case VHOST_USER_SET_MEM_TABLE:
1386 case VHOST_USER_SET_LOG_BASE:
1387 case VHOST_USER_SET_LOG_FD:
1388 case VHOST_USER_SET_VRING_NUM:
1389 case VHOST_USER_SET_VRING_ADDR:
1390 case VHOST_USER_SET_VRING_BASE:
1391 case VHOST_USER_SET_VRING_KICK:
1392 case VHOST_USER_SET_VRING_CALL:
1393 case VHOST_USER_SET_VRING_ERR:
1394 case VHOST_USER_SET_VRING_ENABLE:
1395 case VHOST_USER_SEND_RARP:
1396 case VHOST_USER_NET_SET_MTU:
1397 case VHOST_USER_SET_SLAVE_REQ_FD:
1398 vhost_user_lock_all_queue_pairs(dev);
1399 unlock_required = 1;
1406 switch (msg.request.master) {
1407 case VHOST_USER_GET_FEATURES:
1408 msg.payload.u64 = vhost_user_get_features(dev);
1409 msg.size = sizeof(msg.payload.u64);
1410 send_vhost_reply(fd, &msg);
1412 case VHOST_USER_SET_FEATURES:
1413 vhost_user_set_features(dev, msg.payload.u64);
1416 case VHOST_USER_GET_PROTOCOL_FEATURES:
1417 vhost_user_get_protocol_features(dev, &msg);
1418 send_vhost_reply(fd, &msg);
1420 case VHOST_USER_SET_PROTOCOL_FEATURES:
1421 vhost_user_set_protocol_features(dev, msg.payload.u64);
1424 case VHOST_USER_SET_OWNER:
1425 vhost_user_set_owner();
1427 case VHOST_USER_RESET_OWNER:
1428 vhost_user_reset_owner(dev);
1431 case VHOST_USER_SET_MEM_TABLE:
1432 ret = vhost_user_set_mem_table(&dev, &msg);
1435 case VHOST_USER_SET_LOG_BASE:
1436 vhost_user_set_log_base(dev, &msg);
1438 /* it needs a reply */
1439 msg.size = sizeof(msg.payload.u64);
1440 send_vhost_reply(fd, &msg);
1442 case VHOST_USER_SET_LOG_FD:
1444 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1447 case VHOST_USER_SET_VRING_NUM:
1448 vhost_user_set_vring_num(dev, &msg);
1450 case VHOST_USER_SET_VRING_ADDR:
1451 vhost_user_set_vring_addr(&dev, &msg);
1453 case VHOST_USER_SET_VRING_BASE:
1454 vhost_user_set_vring_base(dev, &msg);
1457 case VHOST_USER_GET_VRING_BASE:
1458 vhost_user_get_vring_base(dev, &msg);
1459 msg.size = sizeof(msg.payload.state);
1460 send_vhost_reply(fd, &msg);
1463 case VHOST_USER_SET_VRING_KICK:
1464 vhost_user_set_vring_kick(&dev, &msg);
1466 case VHOST_USER_SET_VRING_CALL:
1467 vhost_user_set_vring_call(dev, &msg);
1470 case VHOST_USER_SET_VRING_ERR:
1471 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1473 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1476 case VHOST_USER_GET_QUEUE_NUM:
1477 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1478 msg.size = sizeof(msg.payload.u64);
1479 send_vhost_reply(fd, &msg);
1482 case VHOST_USER_SET_VRING_ENABLE:
1483 vhost_user_set_vring_enable(dev, &msg);
1485 case VHOST_USER_SEND_RARP:
1486 vhost_user_send_rarp(dev, &msg);
1489 case VHOST_USER_NET_SET_MTU:
1490 ret = vhost_user_net_set_mtu(dev, &msg);
1493 case VHOST_USER_SET_SLAVE_REQ_FD:
1494 ret = vhost_user_set_req_fd(dev, &msg);
1497 case VHOST_USER_IOTLB_MSG:
1498 ret = vhost_user_iotlb_msg(&dev, &msg);
1507 if (unlock_required)
1508 vhost_user_unlock_all_queue_pairs(dev);
1510 if (msg.flags & VHOST_USER_NEED_REPLY) {
1511 msg.payload.u64 = !!ret;
1512 msg.size = sizeof(msg.payload.u64);
1513 send_vhost_reply(fd, &msg);
1516 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1517 dev->flags |= VIRTIO_DEV_READY;
1519 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1520 if (dev->dequeue_zero_copy) {
1521 RTE_LOG(INFO, VHOST_CONFIG,
1522 "dequeue zero copy is enabled\n");
1525 if (dev->notify_ops->new_device(dev->vid) == 0)
1526 dev->flags |= VIRTIO_DEV_RUNNING;
1534 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1537 struct VhostUserMsg msg = {
1538 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1539 .flags = VHOST_USER_VERSION,
1540 .size = sizeof(msg.payload.iotlb),
1544 .type = VHOST_IOTLB_MISS,
1548 ret = send_vhost_message(dev->slave_req_fd, &msg);
1550 RTE_LOG(ERR, VHOST_CONFIG,
1551 "Failed to send IOTLB miss message (%d)\n",