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.state.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));
516 if (dev->nr_guest_pages > 0) {
517 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
518 /* merge if the two pages are continuous */
519 if (host_phys_addr == last_page->host_phys_addr +
521 last_page->size += size;
526 page = &dev->guest_pages[dev->nr_guest_pages++];
527 page->guest_phys_addr = guest_phys_addr;
528 page->host_phys_addr = host_phys_addr;
533 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
536 uint64_t reg_size = reg->size;
537 uint64_t host_user_addr = reg->host_user_addr;
538 uint64_t guest_phys_addr = reg->guest_phys_addr;
539 uint64_t host_phys_addr;
542 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
543 size = page_size - (guest_phys_addr & (page_size - 1));
544 size = RTE_MIN(size, reg_size);
546 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
547 host_user_addr += size;
548 guest_phys_addr += size;
551 while (reg_size > 0) {
552 size = RTE_MIN(reg_size, page_size);
553 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
555 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
557 host_user_addr += size;
558 guest_phys_addr += size;
563 #ifdef RTE_LIBRTE_VHOST_DEBUG
564 /* TODO: enable it only in debug mode? */
566 dump_guest_pages(struct virtio_net *dev)
569 struct guest_page *page;
571 for (i = 0; i < dev->nr_guest_pages; i++) {
572 page = &dev->guest_pages[i];
574 RTE_LOG(INFO, VHOST_CONFIG,
575 "guest physical page region %u\n"
576 "\t guest_phys_addr: %" PRIx64 "\n"
577 "\t host_phys_addr : %" PRIx64 "\n"
578 "\t size : %" PRIx64 "\n",
580 page->guest_phys_addr,
581 page->host_phys_addr,
586 #define dump_guest_pages(dev)
590 vhost_memory_changed(struct VhostUserMemory *new,
591 struct rte_vhost_memory *old)
595 if (new->nregions != old->nregions)
598 for (i = 0; i < new->nregions; ++i) {
599 VhostUserMemoryRegion *new_r = &new->regions[i];
600 struct rte_vhost_mem_region *old_r = &old->regions[i];
602 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
604 if (new_r->memory_size != old_r->size)
606 if (new_r->userspace_addr != old_r->guest_user_addr)
614 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
616 struct VhostUserMemory memory = pmsg->payload.memory;
617 struct rte_vhost_mem_region *reg;
620 uint64_t mmap_offset;
625 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
626 RTE_LOG(INFO, VHOST_CONFIG,
627 "(%d) memory regions not changed\n", dev->vid);
629 for (i = 0; i < memory.nregions; i++)
636 free_mem_region(dev);
641 dev->nr_guest_pages = 0;
642 if (!dev->guest_pages) {
643 dev->max_guest_pages = 8;
644 dev->guest_pages = malloc(dev->max_guest_pages *
645 sizeof(struct guest_page));
646 if (dev->guest_pages == NULL) {
647 RTE_LOG(ERR, VHOST_CONFIG,
648 "(%d) failed to allocate memory "
649 "for dev->guest_pages\n",
655 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
656 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
657 if (dev->mem == NULL) {
658 RTE_LOG(ERR, VHOST_CONFIG,
659 "(%d) failed to allocate memory for dev->mem\n",
663 dev->mem->nregions = memory.nregions;
665 for (i = 0; i < memory.nregions; i++) {
667 reg = &dev->mem->regions[i];
669 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
670 reg->guest_user_addr = memory.regions[i].userspace_addr;
671 reg->size = memory.regions[i].memory_size;
674 mmap_offset = memory.regions[i].mmap_offset;
675 mmap_size = reg->size + mmap_offset;
677 /* mmap() without flag of MAP_ANONYMOUS, should be called
678 * with length argument aligned with hugepagesz at older
679 * longterm version Linux, like 2.6.32 and 3.2.72, or
680 * mmap() will fail with EINVAL.
682 * to avoid failure, make sure in caller to keep length
685 alignment = get_blk_size(fd);
686 if (alignment == (uint64_t)-1) {
687 RTE_LOG(ERR, VHOST_CONFIG,
688 "couldn't get hugepage size through fstat\n");
691 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
693 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
694 MAP_SHARED | MAP_POPULATE, fd, 0);
696 if (mmap_addr == MAP_FAILED) {
697 RTE_LOG(ERR, VHOST_CONFIG,
698 "mmap region %u failed.\n", i);
702 reg->mmap_addr = mmap_addr;
703 reg->mmap_size = mmap_size;
704 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
707 if (dev->dequeue_zero_copy)
708 add_guest_pages(dev, reg, alignment);
710 RTE_LOG(INFO, VHOST_CONFIG,
711 "guest memory region %u, size: 0x%" PRIx64 "\n"
712 "\t guest physical addr: 0x%" PRIx64 "\n"
713 "\t guest virtual addr: 0x%" PRIx64 "\n"
714 "\t host virtual addr: 0x%" PRIx64 "\n"
715 "\t mmap addr : 0x%" PRIx64 "\n"
716 "\t mmap size : 0x%" PRIx64 "\n"
717 "\t mmap align: 0x%" PRIx64 "\n"
718 "\t mmap off : 0x%" PRIx64 "\n",
720 reg->guest_phys_addr,
721 reg->guest_user_addr,
723 (uint64_t)(uintptr_t)mmap_addr,
729 dump_guest_pages(dev);
734 free_mem_region(dev);
741 vq_is_ready(struct vhost_virtqueue *vq)
743 return vq && vq->desc && vq->avail && vq->used &&
744 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
745 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
749 virtio_is_ready(struct virtio_net *dev)
751 struct vhost_virtqueue *vq;
754 if (dev->nr_vring == 0)
757 for (i = 0; i < dev->nr_vring; i++) {
758 vq = dev->virtqueue[i];
760 if (!vq_is_ready(vq))
764 RTE_LOG(INFO, VHOST_CONFIG,
765 "virtio is now ready for processing.\n");
770 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
772 struct vhost_vring_file file;
773 struct vhost_virtqueue *vq;
775 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
776 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
777 file.fd = VIRTIO_INVALID_EVENTFD;
779 file.fd = pmsg->fds[0];
780 RTE_LOG(INFO, VHOST_CONFIG,
781 "vring call idx:%d file:%d\n", file.index, file.fd);
783 vq = dev->virtqueue[file.index];
787 vq->callfd = file.fd;
791 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
793 struct vhost_vring_file file;
794 struct vhost_virtqueue *vq;
795 struct virtio_net *dev = *pdev;
797 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
798 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
799 file.fd = VIRTIO_INVALID_EVENTFD;
801 file.fd = pmsg->fds[0];
802 RTE_LOG(INFO, VHOST_CONFIG,
803 "vring kick idx:%d file:%d\n", file.index, file.fd);
805 /* Interpret ring addresses only when ring is started. */
806 dev = translate_ring_addresses(dev, file.index);
812 vq = dev->virtqueue[file.index];
815 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
816 * the ring starts already enabled. Otherwise, it is enabled via
817 * the SET_VRING_ENABLE message.
819 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
824 vq->kickfd = file.fd;
828 free_zmbufs(struct vhost_virtqueue *vq)
830 struct zcopy_mbuf *zmbuf, *next;
832 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
833 zmbuf != NULL; zmbuf = next) {
834 next = TAILQ_NEXT(zmbuf, next);
836 rte_pktmbuf_free(zmbuf->mbuf);
837 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
840 rte_free(vq->zmbufs);
844 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
847 vhost_user_get_vring_base(struct virtio_net *dev,
850 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
852 /* We have to stop the queue (virtio) if it is running. */
853 if (dev->flags & VIRTIO_DEV_RUNNING) {
854 dev->flags &= ~VIRTIO_DEV_RUNNING;
855 dev->notify_ops->destroy_device(dev->vid);
858 dev->flags &= ~VIRTIO_DEV_READY;
860 /* Here we are safe to get the last used index */
861 msg->payload.state.num = vq->last_used_idx;
863 RTE_LOG(INFO, VHOST_CONFIG,
864 "vring base idx:%d file:%d\n", msg->payload.state.index,
865 msg->payload.state.num);
867 * Based on current qemu vhost-user implementation, this message is
868 * sent and only sent in vhost_vring_stop.
869 * TODO: cleanup the vring, it isn't usable since here.
874 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
876 if (dev->dequeue_zero_copy)
878 rte_free(vq->shadow_used_ring);
879 vq->shadow_used_ring = NULL;
881 rte_free(vq->batch_copy_elems);
882 vq->batch_copy_elems = NULL;
888 * when virtio queues are ready to work, qemu will send us to
889 * enable the virtio queue pair.
892 vhost_user_set_vring_enable(struct virtio_net *dev,
895 int enable = (int)msg->payload.state.num;
897 RTE_LOG(INFO, VHOST_CONFIG,
898 "set queue enable: %d to qp idx: %d\n",
899 enable, msg->payload.state.index);
901 if (dev->notify_ops->vring_state_changed)
902 dev->notify_ops->vring_state_changed(dev->vid,
903 msg->payload.state.index, enable);
905 dev->virtqueue[msg->payload.state.index]->enabled = enable;
911 vhost_user_get_protocol_features(struct virtio_net *dev,
912 struct VhostUserMsg *msg)
914 uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
916 rte_vhost_driver_get_features(dev->ifname, &features);
919 * REPLY_ACK protocol feature is only mandatory for now
920 * for IOMMU feature. If IOMMU is explicitly disabled by the
921 * application, disable also REPLY_ACK feature for older buggy
922 * Qemu versions (from v2.7.0 to v2.9.0).
924 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
925 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
927 msg->payload.u64 = protocol_features;
928 msg->size = sizeof(msg->payload.u64);
932 vhost_user_set_protocol_features(struct virtio_net *dev,
933 uint64_t protocol_features)
935 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
938 dev->protocol_features = protocol_features;
942 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
944 int fd = msg->fds[0];
949 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
953 if (msg->size != sizeof(VhostUserLog)) {
954 RTE_LOG(ERR, VHOST_CONFIG,
955 "invalid log base msg size: %"PRId32" != %d\n",
956 msg->size, (int)sizeof(VhostUserLog));
960 size = msg->payload.log.mmap_size;
961 off = msg->payload.log.mmap_offset;
962 RTE_LOG(INFO, VHOST_CONFIG,
963 "log mmap size: %"PRId64", offset: %"PRId64"\n",
967 * mmap from 0 to workaround a hugepage mmap bug: mmap will
968 * fail when offset is not page size aligned.
970 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
972 if (addr == MAP_FAILED) {
973 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
978 * Free previously mapped log memory on occasionally
979 * multiple VHOST_USER_SET_LOG_BASE.
982 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
984 dev->log_addr = (uint64_t)(uintptr_t)addr;
985 dev->log_base = dev->log_addr + off;
986 dev->log_size = size;
992 * An rarp packet is constructed and broadcasted to notify switches about
993 * the new location of the migrated VM, so that packets from outside will
994 * not be lost after migration.
996 * However, we don't actually "send" a rarp packet here, instead, we set
997 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1000 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
1002 uint8_t *mac = (uint8_t *)&msg->payload.u64;
1004 RTE_LOG(DEBUG, VHOST_CONFIG,
1005 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1006 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1007 memcpy(dev->mac.addr_bytes, mac, 6);
1010 * Set the flag to inject a RARP broadcast packet at
1011 * rte_vhost_dequeue_burst().
1013 * rte_smp_wmb() is for making sure the mac is copied
1014 * before the flag is set.
1017 rte_atomic16_set(&dev->broadcast_rarp, 1);
1023 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1025 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1026 msg->payload.u64 > VIRTIO_MAX_MTU) {
1027 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1033 dev->mtu = msg->payload.u64;
1039 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1041 int fd = msg->fds[0];
1044 RTE_LOG(ERR, VHOST_CONFIG,
1045 "Invalid file descriptor for slave channel (%d)\n",
1050 dev->slave_req_fd = fd;
1056 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1058 struct vhost_vring_addr *ra;
1059 uint64_t start, end;
1062 end = start + imsg->size;
1064 ra = &vq->ring_addrs;
1065 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1067 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1069 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1076 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1077 struct vhost_iotlb_msg *imsg)
1079 uint64_t istart, iend, vstart, vend;
1081 istart = imsg->iova;
1082 iend = istart + imsg->size - 1;
1084 vstart = (uintptr_t)vq->desc;
1085 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1086 if (vstart <= iend && istart <= vend)
1089 vstart = (uintptr_t)vq->avail;
1090 vend = vstart + sizeof(struct vring_avail);
1091 vend += sizeof(uint16_t) * vq->size - 1;
1092 if (vstart <= iend && istart <= vend)
1095 vstart = (uintptr_t)vq->used;
1096 vend = vstart + sizeof(struct vring_used);
1097 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1098 if (vstart <= iend && istart <= vend)
1105 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1107 struct virtio_net *dev = *pdev;
1108 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1112 switch (imsg->type) {
1113 case VHOST_IOTLB_UPDATE:
1115 vva = qva_to_vva(dev, imsg->uaddr, &len);
1119 for (i = 0; i < dev->nr_vring; i++) {
1120 struct vhost_virtqueue *vq = dev->virtqueue[i];
1122 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1125 if (is_vring_iotlb_update(vq, imsg))
1126 *pdev = dev = translate_ring_addresses(dev, i);
1129 case VHOST_IOTLB_INVALIDATE:
1130 for (i = 0; i < dev->nr_vring; i++) {
1131 struct vhost_virtqueue *vq = dev->virtqueue[i];
1133 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1136 if (is_vring_iotlb_invalidate(vq, imsg))
1137 vring_invalidate(dev, vq);
1141 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1149 /* return bytes# of read on success or negative val on failure. */
1151 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1155 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1156 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1160 if (msg && msg->size) {
1161 if (msg->size > sizeof(msg->payload)) {
1162 RTE_LOG(ERR, VHOST_CONFIG,
1163 "invalid msg size: %d\n", msg->size);
1166 ret = read(sockfd, &msg->payload, msg->size);
1169 if (ret != (int)msg->size) {
1170 RTE_LOG(ERR, VHOST_CONFIG,
1171 "read control message failed\n");
1180 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1185 return send_fd_message(sockfd, (char *)msg,
1186 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1190 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1195 msg->flags &= ~VHOST_USER_VERSION_MASK;
1196 msg->flags &= ~VHOST_USER_NEED_REPLY;
1197 msg->flags |= VHOST_USER_VERSION;
1198 msg->flags |= VHOST_USER_REPLY_MASK;
1200 return send_vhost_message(sockfd, msg);
1204 * Allocate a queue pair if it hasn't been allocated yet
1207 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1211 switch (msg->request.master) {
1212 case VHOST_USER_SET_VRING_KICK:
1213 case VHOST_USER_SET_VRING_CALL:
1214 case VHOST_USER_SET_VRING_ERR:
1215 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1217 case VHOST_USER_SET_VRING_NUM:
1218 case VHOST_USER_SET_VRING_BASE:
1219 case VHOST_USER_SET_VRING_ENABLE:
1220 vring_idx = msg->payload.state.index;
1222 case VHOST_USER_SET_VRING_ADDR:
1223 vring_idx = msg->payload.addr.index;
1229 if (vring_idx >= VHOST_MAX_VRING) {
1230 RTE_LOG(ERR, VHOST_CONFIG,
1231 "invalid vring index: %u\n", vring_idx);
1235 if (dev->virtqueue[vring_idx])
1238 return alloc_vring_queue(dev, vring_idx);
1242 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1245 unsigned int vq_num = 0;
1247 while (vq_num < dev->nr_vring) {
1248 struct vhost_virtqueue *vq = dev->virtqueue[i];
1251 rte_spinlock_lock(&vq->access_lock);
1259 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1262 unsigned int vq_num = 0;
1264 while (vq_num < dev->nr_vring) {
1265 struct vhost_virtqueue *vq = dev->virtqueue[i];
1268 rte_spinlock_unlock(&vq->access_lock);
1276 vhost_user_msg_handler(int vid, int fd)
1278 struct virtio_net *dev;
1279 struct VhostUserMsg msg;
1281 int unlock_required = 0;
1283 dev = get_device(vid);
1287 if (!dev->notify_ops) {
1288 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1289 if (!dev->notify_ops) {
1290 RTE_LOG(ERR, VHOST_CONFIG,
1291 "failed to get callback ops for driver %s\n",
1297 ret = read_vhost_message(fd, &msg);
1298 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1300 RTE_LOG(ERR, VHOST_CONFIG,
1301 "vhost read message failed\n");
1303 RTE_LOG(INFO, VHOST_CONFIG,
1304 "vhost peer closed\n");
1306 RTE_LOG(ERR, VHOST_CONFIG,
1307 "vhost read incorrect message\n");
1313 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1314 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1315 vhost_message_str[msg.request.master]);
1317 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1318 vhost_message_str[msg.request.master]);
1320 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1322 RTE_LOG(ERR, VHOST_CONFIG,
1323 "failed to alloc queue\n");
1328 * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE,
1329 * since it is sent when virtio stops and device is destroyed.
1330 * destroy_device waits for queues to be inactive, so it is safe.
1331 * Otherwise taking the access_lock would cause a dead lock.
1333 switch (msg.request.master) {
1334 case VHOST_USER_SET_FEATURES:
1335 case VHOST_USER_SET_PROTOCOL_FEATURES:
1336 case VHOST_USER_SET_OWNER:
1337 case VHOST_USER_RESET_OWNER:
1338 case VHOST_USER_SET_MEM_TABLE:
1339 case VHOST_USER_SET_LOG_BASE:
1340 case VHOST_USER_SET_LOG_FD:
1341 case VHOST_USER_SET_VRING_NUM:
1342 case VHOST_USER_SET_VRING_ADDR:
1343 case VHOST_USER_SET_VRING_BASE:
1344 case VHOST_USER_SET_VRING_KICK:
1345 case VHOST_USER_SET_VRING_CALL:
1346 case VHOST_USER_SET_VRING_ERR:
1347 case VHOST_USER_SET_VRING_ENABLE:
1348 case VHOST_USER_SEND_RARP:
1349 case VHOST_USER_NET_SET_MTU:
1350 case VHOST_USER_SET_SLAVE_REQ_FD:
1351 vhost_user_lock_all_queue_pairs(dev);
1352 unlock_required = 1;
1359 switch (msg.request.master) {
1360 case VHOST_USER_GET_FEATURES:
1361 msg.payload.u64 = vhost_user_get_features(dev);
1362 msg.size = sizeof(msg.payload.u64);
1363 send_vhost_reply(fd, &msg);
1365 case VHOST_USER_SET_FEATURES:
1366 vhost_user_set_features(dev, msg.payload.u64);
1369 case VHOST_USER_GET_PROTOCOL_FEATURES:
1370 vhost_user_get_protocol_features(dev, &msg);
1371 send_vhost_reply(fd, &msg);
1373 case VHOST_USER_SET_PROTOCOL_FEATURES:
1374 vhost_user_set_protocol_features(dev, msg.payload.u64);
1377 case VHOST_USER_SET_OWNER:
1378 vhost_user_set_owner();
1380 case VHOST_USER_RESET_OWNER:
1381 vhost_user_reset_owner(dev);
1384 case VHOST_USER_SET_MEM_TABLE:
1385 ret = vhost_user_set_mem_table(dev, &msg);
1388 case VHOST_USER_SET_LOG_BASE:
1389 vhost_user_set_log_base(dev, &msg);
1391 /* it needs a reply */
1392 msg.size = sizeof(msg.payload.u64);
1393 send_vhost_reply(fd, &msg);
1395 case VHOST_USER_SET_LOG_FD:
1397 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1400 case VHOST_USER_SET_VRING_NUM:
1401 vhost_user_set_vring_num(dev, &msg);
1403 case VHOST_USER_SET_VRING_ADDR:
1404 vhost_user_set_vring_addr(&dev, &msg);
1406 case VHOST_USER_SET_VRING_BASE:
1407 vhost_user_set_vring_base(dev, &msg);
1410 case VHOST_USER_GET_VRING_BASE:
1411 vhost_user_get_vring_base(dev, &msg);
1412 msg.size = sizeof(msg.payload.state);
1413 send_vhost_reply(fd, &msg);
1416 case VHOST_USER_SET_VRING_KICK:
1417 vhost_user_set_vring_kick(&dev, &msg);
1419 case VHOST_USER_SET_VRING_CALL:
1420 vhost_user_set_vring_call(dev, &msg);
1423 case VHOST_USER_SET_VRING_ERR:
1424 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1426 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1429 case VHOST_USER_GET_QUEUE_NUM:
1430 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1431 msg.size = sizeof(msg.payload.u64);
1432 send_vhost_reply(fd, &msg);
1435 case VHOST_USER_SET_VRING_ENABLE:
1436 vhost_user_set_vring_enable(dev, &msg);
1438 case VHOST_USER_SEND_RARP:
1439 vhost_user_send_rarp(dev, &msg);
1442 case VHOST_USER_NET_SET_MTU:
1443 ret = vhost_user_net_set_mtu(dev, &msg);
1446 case VHOST_USER_SET_SLAVE_REQ_FD:
1447 ret = vhost_user_set_req_fd(dev, &msg);
1450 case VHOST_USER_IOTLB_MSG:
1451 ret = vhost_user_iotlb_msg(&dev, &msg);
1460 if (unlock_required)
1461 vhost_user_unlock_all_queue_pairs(dev);
1463 if (msg.flags & VHOST_USER_NEED_REPLY) {
1464 msg.payload.u64 = !!ret;
1465 msg.size = sizeof(msg.payload.u64);
1466 send_vhost_reply(fd, &msg);
1469 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1470 dev->flags |= VIRTIO_DEV_READY;
1472 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1473 if (dev->dequeue_zero_copy) {
1474 RTE_LOG(INFO, VHOST_CONFIG,
1475 "dequeue zero copy is enabled\n");
1478 if (dev->notify_ops->new_device(dev->vid) == 0)
1479 dev->flags |= VIRTIO_DEV_RUNNING;
1487 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1490 struct VhostUserMsg msg = {
1491 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1492 .flags = VHOST_USER_VERSION,
1493 .size = sizeof(msg.payload.iotlb),
1497 .type = VHOST_IOTLB_MISS,
1501 ret = send_vhost_message(dev->slave_req_fd, &msg);
1503 RTE_LOG(ERR, VHOST_CONFIG,
1504 "Failed to send IOTLB miss message (%d)\n",