1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
11 #include <sys/types.h>
14 #ifdef RTE_LIBRTE_VHOST_NUMA
18 #include <rte_common.h>
19 #include <rte_malloc.h>
24 #include "vhost_user.h"
26 #define VIRTIO_MIN_MTU 68
27 #define VIRTIO_MAX_MTU 65535
29 static const char *vhost_message_str[VHOST_USER_MAX] = {
30 [VHOST_USER_NONE] = "VHOST_USER_NONE",
31 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
32 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
33 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
34 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
35 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
36 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
37 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
38 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
39 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
40 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
41 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
42 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
43 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
44 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
45 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
46 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
47 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
48 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
49 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
50 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
51 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
52 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
61 ret = fstat(fd, &stat);
62 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
66 free_mem_region(struct virtio_net *dev)
69 struct rte_vhost_mem_region *reg;
71 if (!dev || !dev->mem)
74 for (i = 0; i < dev->mem->nregions; i++) {
75 reg = &dev->mem->regions[i];
76 if (reg->host_user_addr) {
77 munmap(reg->mmap_addr, reg->mmap_size);
84 vhost_backend_cleanup(struct virtio_net *dev)
92 free(dev->guest_pages);
93 dev->guest_pages = NULL;
96 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
100 if (dev->slave_req_fd >= 0) {
101 close(dev->slave_req_fd);
102 dev->slave_req_fd = -1;
107 * This function just returns success at the moment unless
108 * the device hasn't been initialised.
111 vhost_user_set_owner(void)
117 vhost_user_reset_owner(struct virtio_net *dev)
119 if (dev->flags & VIRTIO_DEV_RUNNING) {
120 dev->flags &= ~VIRTIO_DEV_RUNNING;
121 dev->notify_ops->destroy_device(dev->vid);
124 cleanup_device(dev, 0);
130 * The features that we support are requested.
133 vhost_user_get_features(struct virtio_net *dev)
135 uint64_t features = 0;
137 rte_vhost_driver_get_features(dev->ifname, &features);
142 * We receive the negotiated features supported by us and the virtio device.
145 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
147 uint64_t vhost_features = 0;
149 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
150 if (features & ~vhost_features) {
151 RTE_LOG(ERR, VHOST_CONFIG,
152 "(%d) received invalid negotiated features.\n",
157 if (dev->flags & VIRTIO_DEV_RUNNING) {
158 if (dev->features == features)
162 * Error out if master tries to change features while device is
163 * in running state. The exception being VHOST_F_LOG_ALL, which
164 * is enabled when the live-migration starts.
166 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
167 RTE_LOG(ERR, VHOST_CONFIG,
168 "(%d) features changed while device is running.\n",
173 if (dev->notify_ops->features_changed)
174 dev->notify_ops->features_changed(dev->vid, features);
177 dev->features = features;
179 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
180 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
182 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
184 LOG_DEBUG(VHOST_CONFIG,
185 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
187 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
188 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
194 * The virtio device sends us the size of the descriptor ring.
197 vhost_user_set_vring_num(struct virtio_net *dev,
200 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
202 vq->size = msg->payload.state.num;
204 if (dev->dequeue_zero_copy) {
206 vq->last_zmbuf_idx = 0;
207 vq->zmbuf_size = vq->size;
208 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
209 sizeof(struct zcopy_mbuf), 0);
210 if (vq->zmbufs == NULL) {
211 RTE_LOG(WARNING, VHOST_CONFIG,
212 "failed to allocate mem for zero copy; "
213 "zero copy is force disabled\n");
214 dev->dequeue_zero_copy = 0;
218 vq->shadow_used_ring = rte_malloc(NULL,
219 vq->size * sizeof(struct vring_used_elem),
220 RTE_CACHE_LINE_SIZE);
221 if (!vq->shadow_used_ring) {
222 RTE_LOG(ERR, VHOST_CONFIG,
223 "failed to allocate memory for shadow used ring.\n");
227 vq->batch_copy_elems = rte_malloc(NULL,
228 vq->size * sizeof(struct batch_copy_elem),
229 RTE_CACHE_LINE_SIZE);
230 if (!vq->batch_copy_elems) {
231 RTE_LOG(ERR, VHOST_CONFIG,
232 "failed to allocate memory for batching copy.\n");
240 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
241 * same numa node as the memory of vring descriptor.
243 #ifdef RTE_LIBRTE_VHOST_NUMA
244 static struct virtio_net*
245 numa_realloc(struct virtio_net *dev, int index)
247 int oldnode, newnode;
248 struct virtio_net *old_dev;
249 struct vhost_virtqueue *old_vq, *vq;
253 vq = old_vq = dev->virtqueue[index];
255 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
256 MPOL_F_NODE | MPOL_F_ADDR);
258 /* check if we need to reallocate vq */
259 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
260 MPOL_F_NODE | MPOL_F_ADDR);
262 RTE_LOG(ERR, VHOST_CONFIG,
263 "Unable to get vq numa information.\n");
266 if (oldnode != newnode) {
267 RTE_LOG(INFO, VHOST_CONFIG,
268 "reallocate vq from %d to %d node\n", oldnode, newnode);
269 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
273 memcpy(vq, old_vq, sizeof(*vq));
277 /* check if we need to reallocate dev */
278 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
279 MPOL_F_NODE | MPOL_F_ADDR);
281 RTE_LOG(ERR, VHOST_CONFIG,
282 "Unable to get dev numa information.\n");
285 if (oldnode != newnode) {
286 RTE_LOG(INFO, VHOST_CONFIG,
287 "reallocate dev from %d to %d node\n",
289 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
295 memcpy(dev, old_dev, sizeof(*dev));
300 dev->virtqueue[index] = vq;
301 vhost_devices[dev->vid] = dev;
304 vhost_user_iotlb_init(dev, index);
309 static struct virtio_net*
310 numa_realloc(struct virtio_net *dev, int index __rte_unused)
316 /* Converts QEMU virtual address to Vhost virtual address. */
318 qva_to_vva(struct virtio_net *dev, uint64_t qva)
320 struct rte_vhost_mem_region *reg;
323 /* Find the region where the address lives. */
324 for (i = 0; i < dev->mem->nregions; i++) {
325 reg = &dev->mem->regions[i];
327 if (qva >= reg->guest_user_addr &&
328 qva < reg->guest_user_addr + reg->size) {
329 return qva - reg->guest_user_addr +
339 * Converts ring address to Vhost virtual address.
340 * If IOMMU is enabled, the ring address is a guest IO virtual address,
341 * else it is a QEMU virtual address.
344 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
345 uint64_t ra, uint64_t size)
347 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
350 vva = vhost_user_iotlb_cache_find(vq, ra,
351 &size, VHOST_ACCESS_RW);
353 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
358 return qva_to_vva(dev, ra);
361 static struct virtio_net *
362 translate_ring_addresses(struct virtio_net *dev, int vq_index)
364 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
365 struct vhost_vring_addr *addr = &vq->ring_addrs;
367 /* The addresses are converted from QEMU virtual to Vhost virtual. */
368 if (vq->desc && vq->avail && vq->used)
371 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
372 vq, addr->desc_user_addr, sizeof(struct vring_desc));
374 RTE_LOG(DEBUG, VHOST_CONFIG,
375 "(%d) failed to find desc ring address.\n",
380 dev = numa_realloc(dev, vq_index);
381 vq = dev->virtqueue[vq_index];
382 addr = &vq->ring_addrs;
384 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
385 vq, addr->avail_user_addr, sizeof(struct vring_avail));
386 if (vq->avail == 0) {
387 RTE_LOG(DEBUG, VHOST_CONFIG,
388 "(%d) failed to find avail ring address.\n",
393 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
394 vq, addr->used_user_addr, sizeof(struct vring_used));
396 RTE_LOG(DEBUG, VHOST_CONFIG,
397 "(%d) failed to find used ring address.\n",
402 if (vq->last_used_idx != vq->used->idx) {
403 RTE_LOG(WARNING, VHOST_CONFIG,
404 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
405 "some packets maybe resent for Tx and dropped for Rx\n",
406 vq->last_used_idx, vq->used->idx);
407 vq->last_used_idx = vq->used->idx;
408 vq->last_avail_idx = vq->used->idx;
411 vq->log_guest_addr = addr->log_guest_addr;
413 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
415 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
416 dev->vid, vq->avail);
417 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
419 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
420 dev->vid, vq->log_guest_addr);
426 * The virtio device sends us the desc, used and avail ring addresses.
427 * This function then converts these to our address space.
430 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
432 struct vhost_virtqueue *vq;
433 struct vhost_vring_addr *addr = &msg->payload.addr;
434 struct virtio_net *dev = *pdev;
436 if (dev->mem == NULL)
439 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
440 vq = dev->virtqueue[msg->payload.addr.index];
443 * Rings addresses should not be interpreted as long as the ring is not
444 * started and enabled
446 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
448 vring_invalidate(dev, vq);
450 if (vq->enabled && (dev->features &
451 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
452 dev = translate_ring_addresses(dev, msg->payload.state.index);
463 * The virtio device sends us the available ring last used index.
466 vhost_user_set_vring_base(struct virtio_net *dev,
469 dev->virtqueue[msg->payload.state.index]->last_used_idx =
470 msg->payload.state.num;
471 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
472 msg->payload.state.num;
478 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
479 uint64_t host_phys_addr, uint64_t size)
481 struct guest_page *page, *last_page;
483 if (dev->nr_guest_pages == dev->max_guest_pages) {
484 dev->max_guest_pages *= 2;
485 dev->guest_pages = realloc(dev->guest_pages,
486 dev->max_guest_pages * sizeof(*page));
489 if (dev->nr_guest_pages > 0) {
490 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
491 /* merge if the two pages are continuous */
492 if (host_phys_addr == last_page->host_phys_addr +
494 last_page->size += size;
499 page = &dev->guest_pages[dev->nr_guest_pages++];
500 page->guest_phys_addr = guest_phys_addr;
501 page->host_phys_addr = host_phys_addr;
506 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
509 uint64_t reg_size = reg->size;
510 uint64_t host_user_addr = reg->host_user_addr;
511 uint64_t guest_phys_addr = reg->guest_phys_addr;
512 uint64_t host_phys_addr;
515 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
516 size = page_size - (guest_phys_addr & (page_size - 1));
517 size = RTE_MIN(size, reg_size);
519 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
520 host_user_addr += size;
521 guest_phys_addr += size;
524 while (reg_size > 0) {
525 size = RTE_MIN(reg_size, page_size);
526 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
528 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
530 host_user_addr += size;
531 guest_phys_addr += size;
536 #ifdef RTE_LIBRTE_VHOST_DEBUG
537 /* TODO: enable it only in debug mode? */
539 dump_guest_pages(struct virtio_net *dev)
542 struct guest_page *page;
544 for (i = 0; i < dev->nr_guest_pages; i++) {
545 page = &dev->guest_pages[i];
547 RTE_LOG(INFO, VHOST_CONFIG,
548 "guest physical page region %u\n"
549 "\t guest_phys_addr: %" PRIx64 "\n"
550 "\t host_phys_addr : %" PRIx64 "\n"
551 "\t size : %" PRIx64 "\n",
553 page->guest_phys_addr,
554 page->host_phys_addr,
559 #define dump_guest_pages(dev)
563 vhost_memory_changed(struct VhostUserMemory *new,
564 struct rte_vhost_memory *old)
568 if (new->nregions != old->nregions)
571 for (i = 0; i < new->nregions; ++i) {
572 VhostUserMemoryRegion *new_r = &new->regions[i];
573 struct rte_vhost_mem_region *old_r = &old->regions[i];
575 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
577 if (new_r->memory_size != old_r->size)
579 if (new_r->userspace_addr != old_r->guest_user_addr)
587 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
589 struct VhostUserMemory memory = pmsg->payload.memory;
590 struct rte_vhost_mem_region *reg;
593 uint64_t mmap_offset;
598 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
599 RTE_LOG(INFO, VHOST_CONFIG,
600 "(%d) memory regions not changed\n", dev->vid);
602 for (i = 0; i < memory.nregions; i++)
609 free_mem_region(dev);
614 dev->nr_guest_pages = 0;
615 if (!dev->guest_pages) {
616 dev->max_guest_pages = 8;
617 dev->guest_pages = malloc(dev->max_guest_pages *
618 sizeof(struct guest_page));
619 if (dev->guest_pages == NULL) {
620 RTE_LOG(ERR, VHOST_CONFIG,
621 "(%d) failed to allocate memory "
622 "for dev->guest_pages\n",
628 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
629 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
630 if (dev->mem == NULL) {
631 RTE_LOG(ERR, VHOST_CONFIG,
632 "(%d) failed to allocate memory for dev->mem\n",
636 dev->mem->nregions = memory.nregions;
638 for (i = 0; i < memory.nregions; i++) {
640 reg = &dev->mem->regions[i];
642 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
643 reg->guest_user_addr = memory.regions[i].userspace_addr;
644 reg->size = memory.regions[i].memory_size;
647 mmap_offset = memory.regions[i].mmap_offset;
648 mmap_size = reg->size + mmap_offset;
650 /* mmap() without flag of MAP_ANONYMOUS, should be called
651 * with length argument aligned with hugepagesz at older
652 * longterm version Linux, like 2.6.32 and 3.2.72, or
653 * mmap() will fail with EINVAL.
655 * to avoid failure, make sure in caller to keep length
658 alignment = get_blk_size(fd);
659 if (alignment == (uint64_t)-1) {
660 RTE_LOG(ERR, VHOST_CONFIG,
661 "couldn't get hugepage size through fstat\n");
664 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
666 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
667 MAP_SHARED | MAP_POPULATE, fd, 0);
669 if (mmap_addr == MAP_FAILED) {
670 RTE_LOG(ERR, VHOST_CONFIG,
671 "mmap region %u failed.\n", i);
675 reg->mmap_addr = mmap_addr;
676 reg->mmap_size = mmap_size;
677 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
680 if (dev->dequeue_zero_copy)
681 add_guest_pages(dev, reg, alignment);
683 RTE_LOG(INFO, VHOST_CONFIG,
684 "guest memory region %u, size: 0x%" PRIx64 "\n"
685 "\t guest physical addr: 0x%" PRIx64 "\n"
686 "\t guest virtual addr: 0x%" PRIx64 "\n"
687 "\t host virtual addr: 0x%" PRIx64 "\n"
688 "\t mmap addr : 0x%" PRIx64 "\n"
689 "\t mmap size : 0x%" PRIx64 "\n"
690 "\t mmap align: 0x%" PRIx64 "\n"
691 "\t mmap off : 0x%" PRIx64 "\n",
693 reg->guest_phys_addr,
694 reg->guest_user_addr,
696 (uint64_t)(uintptr_t)mmap_addr,
702 dump_guest_pages(dev);
707 free_mem_region(dev);
714 vq_is_ready(struct vhost_virtqueue *vq)
716 return vq && vq->desc && vq->avail && vq->used &&
717 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
718 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
722 virtio_is_ready(struct virtio_net *dev)
724 struct vhost_virtqueue *vq;
727 if (dev->nr_vring == 0)
730 for (i = 0; i < dev->nr_vring; i++) {
731 vq = dev->virtqueue[i];
733 if (!vq_is_ready(vq))
737 RTE_LOG(INFO, VHOST_CONFIG,
738 "virtio is now ready for processing.\n");
743 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
745 struct vhost_vring_file file;
746 struct vhost_virtqueue *vq;
748 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
749 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
750 file.fd = VIRTIO_INVALID_EVENTFD;
752 file.fd = pmsg->fds[0];
753 RTE_LOG(INFO, VHOST_CONFIG,
754 "vring call idx:%d file:%d\n", file.index, file.fd);
756 vq = dev->virtqueue[file.index];
760 vq->callfd = file.fd;
764 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
766 struct vhost_vring_file file;
767 struct vhost_virtqueue *vq;
768 struct virtio_net *dev = *pdev;
770 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
771 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
772 file.fd = VIRTIO_INVALID_EVENTFD;
774 file.fd = pmsg->fds[0];
775 RTE_LOG(INFO, VHOST_CONFIG,
776 "vring kick idx:%d file:%d\n", file.index, file.fd);
778 /* Interpret ring addresses only when ring is started. */
779 dev = translate_ring_addresses(dev, file.index);
785 vq = dev->virtqueue[file.index];
788 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
789 * the ring starts already enabled. Otherwise, it is enabled via
790 * the SET_VRING_ENABLE message.
792 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
797 vq->kickfd = file.fd;
801 free_zmbufs(struct vhost_virtqueue *vq)
803 struct zcopy_mbuf *zmbuf, *next;
805 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
806 zmbuf != NULL; zmbuf = next) {
807 next = TAILQ_NEXT(zmbuf, next);
809 rte_pktmbuf_free(zmbuf->mbuf);
810 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
813 rte_free(vq->zmbufs);
817 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
820 vhost_user_get_vring_base(struct virtio_net *dev,
823 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
825 /* We have to stop the queue (virtio) if it is running. */
826 if (dev->flags & VIRTIO_DEV_RUNNING) {
827 dev->flags &= ~VIRTIO_DEV_RUNNING;
828 dev->notify_ops->destroy_device(dev->vid);
831 dev->flags &= ~VIRTIO_DEV_READY;
833 /* Here we are safe to get the last used index */
834 msg->payload.state.num = vq->last_used_idx;
836 RTE_LOG(INFO, VHOST_CONFIG,
837 "vring base idx:%d file:%d\n", msg->payload.state.index,
838 msg->payload.state.num);
840 * Based on current qemu vhost-user implementation, this message is
841 * sent and only sent in vhost_vring_stop.
842 * TODO: cleanup the vring, it isn't usable since here.
847 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
849 if (dev->dequeue_zero_copy)
851 rte_free(vq->shadow_used_ring);
852 vq->shadow_used_ring = NULL;
854 rte_free(vq->batch_copy_elems);
855 vq->batch_copy_elems = NULL;
861 * when virtio queues are ready to work, qemu will send us to
862 * enable the virtio queue pair.
865 vhost_user_set_vring_enable(struct virtio_net *dev,
868 int enable = (int)msg->payload.state.num;
870 RTE_LOG(INFO, VHOST_CONFIG,
871 "set queue enable: %d to qp idx: %d\n",
872 enable, msg->payload.state.index);
874 if (dev->notify_ops->vring_state_changed)
875 dev->notify_ops->vring_state_changed(dev->vid,
876 msg->payload.state.index, enable);
878 dev->virtqueue[msg->payload.state.index]->enabled = enable;
884 vhost_user_get_protocol_features(struct virtio_net *dev,
885 struct VhostUserMsg *msg)
887 uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
889 rte_vhost_driver_get_features(dev->ifname, &features);
892 * REPLY_ACK protocol feature is only mandatory for now
893 * for IOMMU feature. If IOMMU is explicitly disabled by the
894 * application, disable also REPLY_ACK feature for older buggy
895 * Qemu versions (from v2.7.0 to v2.9.0).
897 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
898 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
900 msg->payload.u64 = protocol_features;
901 msg->size = sizeof(msg->payload.u64);
905 vhost_user_set_protocol_features(struct virtio_net *dev,
906 uint64_t protocol_features)
908 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
911 dev->protocol_features = protocol_features;
915 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
917 int fd = msg->fds[0];
922 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
926 if (msg->size != sizeof(VhostUserLog)) {
927 RTE_LOG(ERR, VHOST_CONFIG,
928 "invalid log base msg size: %"PRId32" != %d\n",
929 msg->size, (int)sizeof(VhostUserLog));
933 size = msg->payload.log.mmap_size;
934 off = msg->payload.log.mmap_offset;
935 RTE_LOG(INFO, VHOST_CONFIG,
936 "log mmap size: %"PRId64", offset: %"PRId64"\n",
940 * mmap from 0 to workaround a hugepage mmap bug: mmap will
941 * fail when offset is not page size aligned.
943 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
945 if (addr == MAP_FAILED) {
946 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
951 * Free previously mapped log memory on occasionally
952 * multiple VHOST_USER_SET_LOG_BASE.
955 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
957 dev->log_addr = (uint64_t)(uintptr_t)addr;
958 dev->log_base = dev->log_addr + off;
959 dev->log_size = size;
965 * An rarp packet is constructed and broadcasted to notify switches about
966 * the new location of the migrated VM, so that packets from outside will
967 * not be lost after migration.
969 * However, we don't actually "send" a rarp packet here, instead, we set
970 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
973 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
975 uint8_t *mac = (uint8_t *)&msg->payload.u64;
977 RTE_LOG(DEBUG, VHOST_CONFIG,
978 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
979 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
980 memcpy(dev->mac.addr_bytes, mac, 6);
983 * Set the flag to inject a RARP broadcast packet at
984 * rte_vhost_dequeue_burst().
986 * rte_smp_wmb() is for making sure the mac is copied
987 * before the flag is set.
990 rte_atomic16_set(&dev->broadcast_rarp, 1);
996 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
998 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
999 msg->payload.u64 > VIRTIO_MAX_MTU) {
1000 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1006 dev->mtu = msg->payload.u64;
1012 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1014 int fd = msg->fds[0];
1017 RTE_LOG(ERR, VHOST_CONFIG,
1018 "Invalid file descriptor for slave channel (%d)\n",
1023 dev->slave_req_fd = fd;
1029 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1031 struct vhost_vring_addr *ra;
1032 uint64_t start, end;
1035 end = start + imsg->size;
1037 ra = &vq->ring_addrs;
1038 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1040 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1042 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1049 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1050 struct vhost_iotlb_msg *imsg)
1052 uint64_t istart, iend, vstart, vend;
1054 istart = imsg->iova;
1055 iend = istart + imsg->size - 1;
1057 vstart = (uintptr_t)vq->desc;
1058 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1059 if (vstart <= iend && istart <= vend)
1062 vstart = (uintptr_t)vq->avail;
1063 vend = vstart + sizeof(struct vring_avail);
1064 vend += sizeof(uint16_t) * vq->size - 1;
1065 if (vstart <= iend && istart <= vend)
1068 vstart = (uintptr_t)vq->used;
1069 vend = vstart + sizeof(struct vring_used);
1070 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1071 if (vstart <= iend && istart <= vend)
1078 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1080 struct virtio_net *dev = *pdev;
1081 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1085 switch (imsg->type) {
1086 case VHOST_IOTLB_UPDATE:
1087 vva = qva_to_vva(dev, imsg->uaddr);
1091 for (i = 0; i < dev->nr_vring; i++) {
1092 struct vhost_virtqueue *vq = dev->virtqueue[i];
1094 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1095 imsg->size, imsg->perm);
1097 if (is_vring_iotlb_update(vq, imsg))
1098 *pdev = dev = translate_ring_addresses(dev, i);
1101 case VHOST_IOTLB_INVALIDATE:
1102 for (i = 0; i < dev->nr_vring; i++) {
1103 struct vhost_virtqueue *vq = dev->virtqueue[i];
1105 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1108 if (is_vring_iotlb_invalidate(vq, imsg))
1109 vring_invalidate(dev, vq);
1113 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1121 /* return bytes# of read on success or negative val on failure. */
1123 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1127 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1128 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1132 if (msg && msg->size) {
1133 if (msg->size > sizeof(msg->payload)) {
1134 RTE_LOG(ERR, VHOST_CONFIG,
1135 "invalid msg size: %d\n", msg->size);
1138 ret = read(sockfd, &msg->payload, msg->size);
1141 if (ret != (int)msg->size) {
1142 RTE_LOG(ERR, VHOST_CONFIG,
1143 "read control message failed\n");
1152 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1157 return send_fd_message(sockfd, (char *)msg,
1158 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1162 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1167 msg->flags &= ~VHOST_USER_VERSION_MASK;
1168 msg->flags &= ~VHOST_USER_NEED_REPLY;
1169 msg->flags |= VHOST_USER_VERSION;
1170 msg->flags |= VHOST_USER_REPLY_MASK;
1172 return send_vhost_message(sockfd, msg);
1176 * Allocate a queue pair if it hasn't been allocated yet
1179 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1183 switch (msg->request.master) {
1184 case VHOST_USER_SET_VRING_KICK:
1185 case VHOST_USER_SET_VRING_CALL:
1186 case VHOST_USER_SET_VRING_ERR:
1187 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1189 case VHOST_USER_SET_VRING_NUM:
1190 case VHOST_USER_SET_VRING_BASE:
1191 case VHOST_USER_SET_VRING_ENABLE:
1192 vring_idx = msg->payload.state.index;
1194 case VHOST_USER_SET_VRING_ADDR:
1195 vring_idx = msg->payload.addr.index;
1201 if (vring_idx >= VHOST_MAX_VRING) {
1202 RTE_LOG(ERR, VHOST_CONFIG,
1203 "invalid vring index: %u\n", vring_idx);
1207 if (dev->virtqueue[vring_idx])
1210 return alloc_vring_queue(dev, vring_idx);
1214 vhost_user_msg_handler(int vid, int fd)
1216 struct virtio_net *dev;
1217 struct VhostUserMsg msg;
1220 dev = get_device(vid);
1224 if (!dev->notify_ops) {
1225 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1226 if (!dev->notify_ops) {
1227 RTE_LOG(ERR, VHOST_CONFIG,
1228 "failed to get callback ops for driver %s\n",
1234 ret = read_vhost_message(fd, &msg);
1235 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1237 RTE_LOG(ERR, VHOST_CONFIG,
1238 "vhost read message failed\n");
1240 RTE_LOG(INFO, VHOST_CONFIG,
1241 "vhost peer closed\n");
1243 RTE_LOG(ERR, VHOST_CONFIG,
1244 "vhost read incorrect message\n");
1250 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1251 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1252 vhost_message_str[msg.request.master]);
1254 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1255 vhost_message_str[msg.request.master]);
1257 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1259 RTE_LOG(ERR, VHOST_CONFIG,
1260 "failed to alloc queue\n");
1264 switch (msg.request.master) {
1265 case VHOST_USER_GET_FEATURES:
1266 msg.payload.u64 = vhost_user_get_features(dev);
1267 msg.size = sizeof(msg.payload.u64);
1268 send_vhost_reply(fd, &msg);
1270 case VHOST_USER_SET_FEATURES:
1271 ret = vhost_user_set_features(dev, msg.payload.u64);
1276 case VHOST_USER_GET_PROTOCOL_FEATURES:
1277 vhost_user_get_protocol_features(dev, &msg);
1278 send_vhost_reply(fd, &msg);
1280 case VHOST_USER_SET_PROTOCOL_FEATURES:
1281 vhost_user_set_protocol_features(dev, msg.payload.u64);
1284 case VHOST_USER_SET_OWNER:
1285 vhost_user_set_owner();
1287 case VHOST_USER_RESET_OWNER:
1288 vhost_user_reset_owner(dev);
1291 case VHOST_USER_SET_MEM_TABLE:
1292 ret = vhost_user_set_mem_table(dev, &msg);
1295 case VHOST_USER_SET_LOG_BASE:
1296 vhost_user_set_log_base(dev, &msg);
1298 /* it needs a reply */
1299 msg.size = sizeof(msg.payload.u64);
1300 send_vhost_reply(fd, &msg);
1302 case VHOST_USER_SET_LOG_FD:
1304 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1307 case VHOST_USER_SET_VRING_NUM:
1308 vhost_user_set_vring_num(dev, &msg);
1310 case VHOST_USER_SET_VRING_ADDR:
1311 vhost_user_set_vring_addr(&dev, &msg);
1313 case VHOST_USER_SET_VRING_BASE:
1314 vhost_user_set_vring_base(dev, &msg);
1317 case VHOST_USER_GET_VRING_BASE:
1318 vhost_user_get_vring_base(dev, &msg);
1319 msg.size = sizeof(msg.payload.state);
1320 send_vhost_reply(fd, &msg);
1323 case VHOST_USER_SET_VRING_KICK:
1324 vhost_user_set_vring_kick(&dev, &msg);
1326 case VHOST_USER_SET_VRING_CALL:
1327 vhost_user_set_vring_call(dev, &msg);
1330 case VHOST_USER_SET_VRING_ERR:
1331 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1333 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1336 case VHOST_USER_GET_QUEUE_NUM:
1337 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1338 msg.size = sizeof(msg.payload.u64);
1339 send_vhost_reply(fd, &msg);
1342 case VHOST_USER_SET_VRING_ENABLE:
1343 vhost_user_set_vring_enable(dev, &msg);
1345 case VHOST_USER_SEND_RARP:
1346 vhost_user_send_rarp(dev, &msg);
1349 case VHOST_USER_NET_SET_MTU:
1350 ret = vhost_user_net_set_mtu(dev, &msg);
1353 case VHOST_USER_SET_SLAVE_REQ_FD:
1354 ret = vhost_user_set_req_fd(dev, &msg);
1357 case VHOST_USER_IOTLB_MSG:
1358 ret = vhost_user_iotlb_msg(&dev, &msg);
1367 if (msg.flags & VHOST_USER_NEED_REPLY) {
1368 msg.payload.u64 = !!ret;
1369 msg.size = sizeof(msg.payload.u64);
1370 send_vhost_reply(fd, &msg);
1373 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1374 dev->flags |= VIRTIO_DEV_READY;
1376 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1377 if (dev->dequeue_zero_copy) {
1378 RTE_LOG(INFO, VHOST_CONFIG,
1379 "dequeue zero copy is enabled\n");
1382 if (dev->notify_ops->new_device(dev->vid) == 0)
1383 dev->flags |= VIRTIO_DEV_RUNNING;
1391 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1394 struct VhostUserMsg msg = {
1395 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1396 .flags = VHOST_USER_VERSION,
1397 .size = sizeof(msg.payload.iotlb),
1401 .type = VHOST_IOTLB_MISS,
1405 ret = send_vhost_message(dev->slave_req_fd, &msg);
1407 RTE_LOG(ERR, VHOST_CONFIG,
1408 "Failed to send IOTLB miss message (%d)\n",