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)
334 struct rte_vhost_mem_region *reg;
337 /* Find the region where the address lives. */
338 for (i = 0; i < dev->mem->nregions; i++) {
339 reg = &dev->mem->regions[i];
341 if (qva >= reg->guest_user_addr &&
342 qva < reg->guest_user_addr + reg->size) {
343 return qva - reg->guest_user_addr +
353 * Converts ring address to Vhost virtual address.
354 * If IOMMU is enabled, the ring address is a guest IO virtual address,
355 * else it is a QEMU virtual address.
358 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
359 uint64_t ra, uint64_t size)
361 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
364 vva = vhost_user_iotlb_cache_find(vq, ra,
365 &size, VHOST_ACCESS_RW);
367 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
372 return qva_to_vva(dev, ra);
376 * The virtio device sends us the desc, used and avail ring addresses.
377 * This function then converts these to our address space.
380 vhost_user_set_vring_addr(struct virtio_net *dev, VhostUserMsg *msg)
382 struct vhost_virtqueue *vq;
383 struct vhost_vring_addr *addr = &msg->payload.addr;
385 if (dev->mem == NULL)
388 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
389 vq = dev->virtqueue[msg->payload.addr.index];
392 * Rings addresses should not be interpreted as long as the ring is not
393 * started and enabled
395 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
397 vring_invalidate(dev, vq);
402 static struct virtio_net *
403 translate_ring_addresses(struct virtio_net *dev, int vq_index)
405 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
406 struct vhost_vring_addr *addr = &vq->ring_addrs;
408 /* The addresses are converted from QEMU virtual to Vhost virtual. */
409 if (vq->desc && vq->avail && vq->used)
412 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
413 vq, addr->desc_user_addr, sizeof(struct vring_desc));
415 RTE_LOG(DEBUG, VHOST_CONFIG,
416 "(%d) failed to find desc ring address.\n",
421 dev = numa_realloc(dev, vq_index);
422 vq = dev->virtqueue[vq_index];
424 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
425 vq, addr->avail_user_addr, sizeof(struct vring_avail));
426 if (vq->avail == 0) {
427 RTE_LOG(DEBUG, VHOST_CONFIG,
428 "(%d) failed to find avail ring address.\n",
433 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
434 vq, addr->used_user_addr, sizeof(struct vring_used));
436 RTE_LOG(DEBUG, VHOST_CONFIG,
437 "(%d) failed to find used ring address.\n",
442 if (vq->last_used_idx != vq->used->idx) {
443 RTE_LOG(WARNING, VHOST_CONFIG,
444 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
445 "some packets maybe resent for Tx and dropped for Rx\n",
446 vq->last_used_idx, vq->used->idx);
447 vq->last_used_idx = vq->used->idx;
448 vq->last_avail_idx = vq->used->idx;
451 vq->log_guest_addr = addr->log_guest_addr;
453 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
455 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
456 dev->vid, vq->avail);
457 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
459 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
460 dev->vid, vq->log_guest_addr);
466 * The virtio device sends us the available ring last used index.
469 vhost_user_set_vring_base(struct virtio_net *dev,
472 dev->virtqueue[msg->payload.state.index]->last_used_idx =
473 msg->payload.state.num;
474 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
475 msg->payload.state.num;
481 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
482 uint64_t host_phys_addr, uint64_t size)
484 struct guest_page *page, *last_page;
486 if (dev->nr_guest_pages == dev->max_guest_pages) {
487 dev->max_guest_pages *= 2;
488 dev->guest_pages = realloc(dev->guest_pages,
489 dev->max_guest_pages * sizeof(*page));
492 if (dev->nr_guest_pages > 0) {
493 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
494 /* merge if the two pages are continuous */
495 if (host_phys_addr == last_page->host_phys_addr +
497 last_page->size += size;
502 page = &dev->guest_pages[dev->nr_guest_pages++];
503 page->guest_phys_addr = guest_phys_addr;
504 page->host_phys_addr = host_phys_addr;
509 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
512 uint64_t reg_size = reg->size;
513 uint64_t host_user_addr = reg->host_user_addr;
514 uint64_t guest_phys_addr = reg->guest_phys_addr;
515 uint64_t host_phys_addr;
518 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)host_user_addr);
519 size = page_size - (guest_phys_addr & (page_size - 1));
520 size = RTE_MIN(size, reg_size);
522 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
523 host_user_addr += size;
524 guest_phys_addr += size;
527 while (reg_size > 0) {
528 size = RTE_MIN(reg_size, page_size);
529 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)
531 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
533 host_user_addr += size;
534 guest_phys_addr += size;
539 #ifdef RTE_LIBRTE_VHOST_DEBUG
540 /* TODO: enable it only in debug mode? */
542 dump_guest_pages(struct virtio_net *dev)
545 struct guest_page *page;
547 for (i = 0; i < dev->nr_guest_pages; i++) {
548 page = &dev->guest_pages[i];
550 RTE_LOG(INFO, VHOST_CONFIG,
551 "guest physical page region %u\n"
552 "\t guest_phys_addr: %" PRIx64 "\n"
553 "\t host_phys_addr : %" PRIx64 "\n"
554 "\t size : %" PRIx64 "\n",
556 page->guest_phys_addr,
557 page->host_phys_addr,
562 #define dump_guest_pages(dev)
566 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
568 struct VhostUserMemory memory = pmsg->payload.memory;
569 struct rte_vhost_mem_region *reg;
572 uint64_t mmap_offset;
578 free_mem_region(dev);
583 dev->nr_guest_pages = 0;
584 if (!dev->guest_pages) {
585 dev->max_guest_pages = 8;
586 dev->guest_pages = malloc(dev->max_guest_pages *
587 sizeof(struct guest_page));
588 if (dev->guest_pages == NULL) {
589 RTE_LOG(ERR, VHOST_CONFIG,
590 "(%d) failed to allocate memory "
591 "for dev->guest_pages\n",
597 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
598 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
599 if (dev->mem == NULL) {
600 RTE_LOG(ERR, VHOST_CONFIG,
601 "(%d) failed to allocate memory for dev->mem\n",
605 dev->mem->nregions = memory.nregions;
607 for (i = 0; i < memory.nregions; i++) {
609 reg = &dev->mem->regions[i];
611 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
612 reg->guest_user_addr = memory.regions[i].userspace_addr;
613 reg->size = memory.regions[i].memory_size;
616 mmap_offset = memory.regions[i].mmap_offset;
617 mmap_size = reg->size + mmap_offset;
619 /* mmap() without flag of MAP_ANONYMOUS, should be called
620 * with length argument aligned with hugepagesz at older
621 * longterm version Linux, like 2.6.32 and 3.2.72, or
622 * mmap() will fail with EINVAL.
624 * to avoid failure, make sure in caller to keep length
627 alignment = get_blk_size(fd);
628 if (alignment == (uint64_t)-1) {
629 RTE_LOG(ERR, VHOST_CONFIG,
630 "couldn't get hugepage size through fstat\n");
633 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
635 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
636 MAP_SHARED | MAP_POPULATE, fd, 0);
638 if (mmap_addr == MAP_FAILED) {
639 RTE_LOG(ERR, VHOST_CONFIG,
640 "mmap region %u failed.\n", i);
644 reg->mmap_addr = mmap_addr;
645 reg->mmap_size = mmap_size;
646 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
649 if (dev->dequeue_zero_copy)
650 add_guest_pages(dev, reg, alignment);
652 RTE_LOG(INFO, VHOST_CONFIG,
653 "guest memory region %u, size: 0x%" PRIx64 "\n"
654 "\t guest physical addr: 0x%" PRIx64 "\n"
655 "\t guest virtual addr: 0x%" PRIx64 "\n"
656 "\t host virtual addr: 0x%" PRIx64 "\n"
657 "\t mmap addr : 0x%" PRIx64 "\n"
658 "\t mmap size : 0x%" PRIx64 "\n"
659 "\t mmap align: 0x%" PRIx64 "\n"
660 "\t mmap off : 0x%" PRIx64 "\n",
662 reg->guest_phys_addr,
663 reg->guest_user_addr,
665 (uint64_t)(uintptr_t)mmap_addr,
671 dump_guest_pages(dev);
676 free_mem_region(dev);
683 vq_is_ready(struct vhost_virtqueue *vq)
685 return vq && vq->desc && vq->avail && vq->used &&
686 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
687 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
691 virtio_is_ready(struct virtio_net *dev)
693 struct vhost_virtqueue *vq;
696 if (dev->nr_vring == 0)
699 for (i = 0; i < dev->nr_vring; i++) {
700 vq = dev->virtqueue[i];
702 if (!vq_is_ready(vq))
706 RTE_LOG(INFO, VHOST_CONFIG,
707 "virtio is now ready for processing.\n");
712 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
714 struct vhost_vring_file file;
715 struct vhost_virtqueue *vq;
717 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
718 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
719 file.fd = VIRTIO_INVALID_EVENTFD;
721 file.fd = pmsg->fds[0];
722 RTE_LOG(INFO, VHOST_CONFIG,
723 "vring call idx:%d file:%d\n", file.index, file.fd);
725 vq = dev->virtqueue[file.index];
729 vq->callfd = file.fd;
733 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
735 struct vhost_vring_file file;
736 struct vhost_virtqueue *vq;
737 struct virtio_net *dev = *pdev;
739 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
740 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
741 file.fd = VIRTIO_INVALID_EVENTFD;
743 file.fd = pmsg->fds[0];
744 RTE_LOG(INFO, VHOST_CONFIG,
745 "vring kick idx:%d file:%d\n", file.index, file.fd);
748 * Interpret ring addresses only when ring is started and enabled.
749 * This is now if protocol features aren't supported.
751 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
752 *pdev = dev = translate_ring_addresses(dev, file.index);
757 vq = dev->virtqueue[file.index];
760 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
761 * the ring starts already enabled. Otherwise, it is enabled via
762 * the SET_VRING_ENABLE message.
764 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
769 vq->kickfd = file.fd;
773 free_zmbufs(struct vhost_virtqueue *vq)
775 struct zcopy_mbuf *zmbuf, *next;
777 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
778 zmbuf != NULL; zmbuf = next) {
779 next = TAILQ_NEXT(zmbuf, next);
781 rte_pktmbuf_free(zmbuf->mbuf);
782 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
785 rte_free(vq->zmbufs);
789 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
792 vhost_user_get_vring_base(struct virtio_net *dev,
795 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
797 /* We have to stop the queue (virtio) if it is running. */
798 if (dev->flags & VIRTIO_DEV_RUNNING) {
799 dev->flags &= ~VIRTIO_DEV_RUNNING;
800 dev->notify_ops->destroy_device(dev->vid);
803 dev->flags &= ~VIRTIO_DEV_READY;
805 /* Here we are safe to get the last used index */
806 msg->payload.state.num = vq->last_used_idx;
808 RTE_LOG(INFO, VHOST_CONFIG,
809 "vring base idx:%d file:%d\n", msg->payload.state.index,
810 msg->payload.state.num);
812 * Based on current qemu vhost-user implementation, this message is
813 * sent and only sent in vhost_vring_stop.
814 * TODO: cleanup the vring, it isn't usable since here.
819 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
821 if (dev->dequeue_zero_copy)
823 rte_free(vq->shadow_used_ring);
824 vq->shadow_used_ring = NULL;
826 rte_free(vq->batch_copy_elems);
827 vq->batch_copy_elems = NULL;
833 * when virtio queues are ready to work, qemu will send us to
834 * enable the virtio queue pair.
837 vhost_user_set_vring_enable(struct virtio_net **pdev,
840 struct virtio_net *dev = *pdev;
841 int enable = (int)msg->payload.state.num;
843 RTE_LOG(INFO, VHOST_CONFIG,
844 "set queue enable: %d to qp idx: %d\n",
845 enable, msg->payload.state.index);
848 * Interpret ring addresses only when ring is started and enabled.
849 * This is now if protocol features are supported.
851 if (enable && (dev->features &
852 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
853 dev = translate_ring_addresses(dev, msg->payload.state.index);
860 if (dev->notify_ops->vring_state_changed)
861 dev->notify_ops->vring_state_changed(dev->vid,
862 msg->payload.state.index, enable);
864 dev->virtqueue[msg->payload.state.index]->enabled = enable;
870 vhost_user_set_protocol_features(struct virtio_net *dev,
871 uint64_t protocol_features)
873 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
876 dev->protocol_features = protocol_features;
880 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
882 int fd = msg->fds[0];
887 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
891 if (msg->size != sizeof(VhostUserLog)) {
892 RTE_LOG(ERR, VHOST_CONFIG,
893 "invalid log base msg size: %"PRId32" != %d\n",
894 msg->size, (int)sizeof(VhostUserLog));
898 size = msg->payload.log.mmap_size;
899 off = msg->payload.log.mmap_offset;
900 RTE_LOG(INFO, VHOST_CONFIG,
901 "log mmap size: %"PRId64", offset: %"PRId64"\n",
905 * mmap from 0 to workaround a hugepage mmap bug: mmap will
906 * fail when offset is not page size aligned.
908 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
910 if (addr == MAP_FAILED) {
911 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
916 * Free previously mapped log memory on occasionally
917 * multiple VHOST_USER_SET_LOG_BASE.
920 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
922 dev->log_addr = (uint64_t)(uintptr_t)addr;
923 dev->log_base = dev->log_addr + off;
924 dev->log_size = size;
930 * An rarp packet is constructed and broadcasted to notify switches about
931 * the new location of the migrated VM, so that packets from outside will
932 * not be lost after migration.
934 * However, we don't actually "send" a rarp packet here, instead, we set
935 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
938 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
940 uint8_t *mac = (uint8_t *)&msg->payload.u64;
942 RTE_LOG(DEBUG, VHOST_CONFIG,
943 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
944 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
945 memcpy(dev->mac.addr_bytes, mac, 6);
948 * Set the flag to inject a RARP broadcast packet at
949 * rte_vhost_dequeue_burst().
951 * rte_smp_wmb() is for making sure the mac is copied
952 * before the flag is set.
955 rte_atomic16_set(&dev->broadcast_rarp, 1);
961 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
963 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
964 msg->payload.u64 > VIRTIO_MAX_MTU) {
965 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
971 dev->mtu = msg->payload.u64;
977 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
979 int fd = msg->fds[0];
982 RTE_LOG(ERR, VHOST_CONFIG,
983 "Invalid file descriptor for slave channel (%d)\n",
988 dev->slave_req_fd = fd;
994 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
996 struct vhost_vring_addr *ra;
1000 end = start + imsg->size;
1002 ra = &vq->ring_addrs;
1003 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1005 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1007 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1014 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1015 struct vhost_iotlb_msg *imsg)
1017 uint64_t istart, iend, vstart, vend;
1019 istart = imsg->iova;
1020 iend = istart + imsg->size - 1;
1022 vstart = (uintptr_t)vq->desc;
1023 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1024 if (vstart <= iend && istart <= vend)
1027 vstart = (uintptr_t)vq->avail;
1028 vend = vstart + sizeof(struct vring_avail);
1029 vend += sizeof(uint16_t) * vq->size - 1;
1030 if (vstart <= iend && istart <= vend)
1033 vstart = (uintptr_t)vq->used;
1034 vend = vstart + sizeof(struct vring_used);
1035 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1036 if (vstart <= iend && istart <= vend)
1043 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1045 struct virtio_net *dev = *pdev;
1046 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1050 switch (imsg->type) {
1051 case VHOST_IOTLB_UPDATE:
1052 vva = qva_to_vva(dev, imsg->uaddr);
1056 for (i = 0; i < dev->nr_vring; i++) {
1057 struct vhost_virtqueue *vq = dev->virtqueue[i];
1059 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1060 imsg->size, imsg->perm);
1062 if (is_vring_iotlb_update(vq, imsg))
1063 *pdev = dev = translate_ring_addresses(dev, i);
1066 case VHOST_IOTLB_INVALIDATE:
1067 for (i = 0; i < dev->nr_vring; i++) {
1068 struct vhost_virtqueue *vq = dev->virtqueue[i];
1070 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1073 if (is_vring_iotlb_invalidate(vq, imsg))
1074 vring_invalidate(dev, vq);
1078 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1086 /* return bytes# of read on success or negative val on failure. */
1088 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1092 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1093 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1097 if (msg && msg->size) {
1098 if (msg->size > sizeof(msg->payload)) {
1099 RTE_LOG(ERR, VHOST_CONFIG,
1100 "invalid msg size: %d\n", msg->size);
1103 ret = read(sockfd, &msg->payload, msg->size);
1106 if (ret != (int)msg->size) {
1107 RTE_LOG(ERR, VHOST_CONFIG,
1108 "read control message failed\n");
1117 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1122 return send_fd_message(sockfd, (char *)msg,
1123 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1127 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1132 msg->flags &= ~VHOST_USER_VERSION_MASK;
1133 msg->flags &= ~VHOST_USER_NEED_REPLY;
1134 msg->flags |= VHOST_USER_VERSION;
1135 msg->flags |= VHOST_USER_REPLY_MASK;
1137 return send_vhost_message(sockfd, msg);
1141 * Allocate a queue pair if it hasn't been allocated yet
1144 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1148 switch (msg->request.master) {
1149 case VHOST_USER_SET_VRING_KICK:
1150 case VHOST_USER_SET_VRING_CALL:
1151 case VHOST_USER_SET_VRING_ERR:
1152 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1154 case VHOST_USER_SET_VRING_NUM:
1155 case VHOST_USER_SET_VRING_BASE:
1156 case VHOST_USER_SET_VRING_ENABLE:
1157 vring_idx = msg->payload.state.index;
1159 case VHOST_USER_SET_VRING_ADDR:
1160 vring_idx = msg->payload.addr.index;
1166 if (vring_idx >= VHOST_MAX_VRING) {
1167 RTE_LOG(ERR, VHOST_CONFIG,
1168 "invalid vring index: %u\n", vring_idx);
1172 if (dev->virtqueue[vring_idx])
1175 return alloc_vring_queue(dev, vring_idx);
1179 vhost_user_msg_handler(int vid, int fd)
1181 struct virtio_net *dev;
1182 struct VhostUserMsg msg;
1185 dev = get_device(vid);
1189 if (!dev->notify_ops) {
1190 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1191 if (!dev->notify_ops) {
1192 RTE_LOG(ERR, VHOST_CONFIG,
1193 "failed to get callback ops for driver %s\n",
1199 ret = read_vhost_message(fd, &msg);
1200 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1202 RTE_LOG(ERR, VHOST_CONFIG,
1203 "vhost read message failed\n");
1205 RTE_LOG(INFO, VHOST_CONFIG,
1206 "vhost peer closed\n");
1208 RTE_LOG(ERR, VHOST_CONFIG,
1209 "vhost read incorrect message\n");
1215 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1216 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1217 vhost_message_str[msg.request.master]);
1219 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1220 vhost_message_str[msg.request.master]);
1222 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1224 RTE_LOG(ERR, VHOST_CONFIG,
1225 "failed to alloc queue\n");
1229 switch (msg.request.master) {
1230 case VHOST_USER_GET_FEATURES:
1231 msg.payload.u64 = vhost_user_get_features(dev);
1232 msg.size = sizeof(msg.payload.u64);
1233 send_vhost_reply(fd, &msg);
1235 case VHOST_USER_SET_FEATURES:
1236 vhost_user_set_features(dev, msg.payload.u64);
1239 case VHOST_USER_GET_PROTOCOL_FEATURES:
1240 msg.payload.u64 = VHOST_USER_PROTOCOL_FEATURES;
1241 msg.size = sizeof(msg.payload.u64);
1242 send_vhost_reply(fd, &msg);
1244 case VHOST_USER_SET_PROTOCOL_FEATURES:
1245 vhost_user_set_protocol_features(dev, msg.payload.u64);
1248 case VHOST_USER_SET_OWNER:
1249 vhost_user_set_owner();
1251 case VHOST_USER_RESET_OWNER:
1252 vhost_user_reset_owner(dev);
1255 case VHOST_USER_SET_MEM_TABLE:
1256 ret = vhost_user_set_mem_table(dev, &msg);
1259 case VHOST_USER_SET_LOG_BASE:
1260 vhost_user_set_log_base(dev, &msg);
1262 /* it needs a reply */
1263 msg.size = sizeof(msg.payload.u64);
1264 send_vhost_reply(fd, &msg);
1266 case VHOST_USER_SET_LOG_FD:
1268 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1271 case VHOST_USER_SET_VRING_NUM:
1272 vhost_user_set_vring_num(dev, &msg);
1274 case VHOST_USER_SET_VRING_ADDR:
1275 vhost_user_set_vring_addr(dev, &msg);
1277 case VHOST_USER_SET_VRING_BASE:
1278 vhost_user_set_vring_base(dev, &msg);
1281 case VHOST_USER_GET_VRING_BASE:
1282 vhost_user_get_vring_base(dev, &msg);
1283 msg.size = sizeof(msg.payload.state);
1284 send_vhost_reply(fd, &msg);
1287 case VHOST_USER_SET_VRING_KICK:
1288 vhost_user_set_vring_kick(&dev, &msg);
1290 case VHOST_USER_SET_VRING_CALL:
1291 vhost_user_set_vring_call(dev, &msg);
1294 case VHOST_USER_SET_VRING_ERR:
1295 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1297 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1300 case VHOST_USER_GET_QUEUE_NUM:
1301 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1302 msg.size = sizeof(msg.payload.u64);
1303 send_vhost_reply(fd, &msg);
1306 case VHOST_USER_SET_VRING_ENABLE:
1307 vhost_user_set_vring_enable(&dev, &msg);
1309 case VHOST_USER_SEND_RARP:
1310 vhost_user_send_rarp(dev, &msg);
1313 case VHOST_USER_NET_SET_MTU:
1314 ret = vhost_user_net_set_mtu(dev, &msg);
1317 case VHOST_USER_SET_SLAVE_REQ_FD:
1318 ret = vhost_user_set_req_fd(dev, &msg);
1321 case VHOST_USER_IOTLB_MSG:
1322 ret = vhost_user_iotlb_msg(&dev, &msg);
1331 if (msg.flags & VHOST_USER_NEED_REPLY) {
1332 msg.payload.u64 = !!ret;
1333 msg.size = sizeof(msg.payload.u64);
1334 send_vhost_reply(fd, &msg);
1337 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1338 dev->flags |= VIRTIO_DEV_READY;
1340 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1341 if (dev->dequeue_zero_copy) {
1342 RTE_LOG(INFO, VHOST_CONFIG,
1343 "dequeue zero copy is enabled\n");
1346 if (dev->notify_ops->new_device(dev->vid) == 0)
1347 dev->flags |= VIRTIO_DEV_RUNNING;
1355 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1358 struct VhostUserMsg msg = {
1359 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1360 .flags = VHOST_USER_VERSION,
1361 .size = sizeof(msg.payload.iotlb),
1365 .type = VHOST_IOTLB_MISS,
1369 ret = send_vhost_message(dev->slave_req_fd, &msg);
1371 RTE_LOG(ERR, VHOST_CONFIG,
1372 "Failed to send IOTLB miss message (%d)\n",